ArcGISEnvelopeBuilder

Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISEnvelopeBuilder
Since: 1.0.0
Inheritance: ArcGISGeometryBuilder->ArcGISEnvelopeBuilder

Summary

The envelope builder allows you to create and modify envelope geometries incrementally.

Constructors

ArcGISEnvelopeBuilder(const ArcGISEnvelope&)

Creates an envelope builder from the specified ArcGISEnvelope.

Since 1.0.0

Arguments
NameTypeConstSummary
envelope
Yes

The envelope.

ArcGISEnvelopeBuilder(const ArcGISPoint&, double, double)

Creates an envelope builder from a center point and a width and height.

Since 1.0.0

Arguments
NameTypeConstSummary
center
Yes

The center point for the envelope.

width
No

The width of the envelope around the center point.

height
No

The height of the envelope around the center point.

ArcGISEnvelopeBuilder(const ArcGISPoint&, double, double, double)

Creates an envelope builder from a center point and a width, height, and depth.

Since 1.0.0

Arguments
NameTypeConstSummary
center
Yes

The center point for the envelope.

width
No

The width of the envelope around the center point.

height
No

The height of the envelope around the center point.

depth
No

The depth of the envelope around the center point.

ArcGISEnvelopeBuilder(const ArcGISSpatialReference&)

Creates an envelope builder.

Since 1.0.0

Arguments
NameTypeConstSummary
spatialReference
Yes

The builder's spatial reference.

Properties

PropertyTypeNullableReadonlySummary
No
Yes

The center point of the ArcGISEnvelope being constructed.

No
Yes

The depth of the ArcGISEnvelope being constructed.

No
Yes

The height of the ArcGISEnvelope being constructed.

No
No

The m maximum value of the ArcGISEnvelope being constructed.

No
No

The m minimum value of the ArcGISEnvelope being constructed.

No
Yes

The width of the ArcGISEnvelope being constructed.

No
No

The x maximum value of the ArcGISEnvelope being constructed.

No
No

The x minimum value of the ArcGISEnvelope being constructed.

No
No

The y maximum value of the ArcGISEnvelope being constructed.

No
No

The y minimum value of the ArcGISEnvelope being constructed.

No
No

The z maximum value of the ArcGISEnvelope being constructed.

No
No

The z minimum value of the ArcGISEnvelope being constructed.

Center

ArcGISPoint GetCenter() const

The center point of the ArcGISEnvelope being constructed.

Depth

double GetDepth() const

The depth of the ArcGISEnvelope being constructed.

This is the difference between the minimum and maximum z values. A 2D envelope has zero depth.

Height

double GetHeight() const

The height of the ArcGISEnvelope being constructed.

This is the difference between the minimum and maximum y coordinates.

MMax

double GetMMax() const

void SetMMax(double mMax)

The m maximum value of the ArcGISEnvelope being constructed.

Returns NAN if an error occurs.

MMin

double GetMMin() const

void SetMMin(double mMin)

The m minimum value of the ArcGISEnvelope being constructed.

Returns NAN if an error occurs.

Width

double GetWidth() const

The width of the ArcGISEnvelope being constructed.

This is the difference between the minimum and maximum x coordinates.

XMax

double GetXMax() const

void SetXMax(double xMax)

The x maximum value of the ArcGISEnvelope being constructed.

Returns NAN if an error occurs.

XMin

double GetXMin() const

void SetXMin(double xMin)

The x minimum value of the ArcGISEnvelope being constructed.

Returns NAN if an error occurs.

YMax

double GetYMax() const

void SetYMax(double yMax)

The y maximum value of the ArcGISEnvelope being constructed.

Returns NAN if an error occurs.

YMin

double GetYMin() const

void SetYMin(double yMin)

The y minimum value of the ArcGISEnvelope being constructed.

Returns NAN if an error occurs.

ZMax

double GetZMax() const

void SetZMax(double zMax)

The z maximum value of the ArcGISEnvelope being constructed.

Returns NAN if an error occurs.

ZMin

double GetZMin() const

void SetZMin(double zMin)

The z minimum value of the ArcGISEnvelope being constructed.

Returns NAN if an error occurs.

Methods

SignatureReturn TypeSummary

CenterAt(const ArcGISPoint&)

void

Centers the envelope at the specified point.

ChangeAspectRatio(double, double)

void

Adjust the envelope's aspect ratio to match the ratio of the given width and height.

Expand(double)

void

Expands the envelope by the given scale factor.

Expand(const ArcGISPoint&, double)

void

Expands the envelope at the anchor point by the given factor.

OffsetBy(double, double)

void

Moves the builder's envelope geometry by the given offsets in the x and y dimension.

SetM(double, double)

void

Set the m-values for the envelope.

SetXY(double, double, double, double)

void

Set the x,y coordinates for the envelope.

SetZ(double, double)

void

Set the z-values for the envelope.

Union(const ArcGISEnvelope&)

void

Finds the union of the builder's envelope and the specified envelope and updates the envelope builder with the result.

Union(const ArcGISPoint&)

void

Finds the union of the builder's envelope and the specified point and updates the envelope builder with the result.

CenterAt

void CenterAt(const ArcGISPoint& point)

Centers the envelope at the specified point.

Since 1.0.0

Arguments
NameTypeConstSummary
point
Yes

The point to center on.

Returns void

ChangeAspectRatio

void ChangeAspectRatio(double width, double height)

Adjust the envelope's aspect ratio to match the ratio of the given width and height.

Since 1.0.0

Arguments
NameTypeConstSummary
width
No

A width.

height
No

A height.

Returns void

Expand

void Expand(double factor)

Expands the envelope by the given scale factor.

Since 1.0.0

Arguments
NameTypeConstSummary
factor
No

The factor to scale the envelope by.

Returns void

Expand

void Expand(const ArcGISPoint& anchor, double factor)

Expands the envelope at the anchor point by the given factor.

Since 1.0.0

Arguments
NameTypeConstSummary
anchor
Yes

The point to anchor at.

factor
No

The factor to scale the envelope by.

Returns void

OffsetBy

void OffsetBy(double offsetX, double offsetY)

Moves the builder's envelope geometry by the given offsets in the x and y dimension.

Since 1.0.0

Arguments
NameTypeConstSummary
offsetX
No

The number of units to move the envelope on the x axis.

offsetY
No

The number of units to move the envelope on the y axis.

Returns void

SetM

void SetM(double mMin, double mMax)

Set the m-values for the envelope.

Since 1.0.0

Arguments
NameTypeConstSummary
mMin
No

The m minimum value for the envelope.

mMax
No

The m maximum value for the envelope.

Returns void

SetXY

void SetXY(double xMin, double yMin, double xMax, double yMax)

Set the x,y coordinates for the envelope.

Since 1.0.0

Arguments
NameTypeConstSummary
xMin
No

The x minimum value for the envelope.

yMin
No

The y minimum value for the envelope.

xMax
No

The x maximum value for the envelope.

yMax
No

The y maximum value for the envelope.

Returns void

SetZ

void SetZ(double zMin, double zMax)

Set the z-values for the envelope.

Since 1.0.0

Arguments
NameTypeConstSummary
zMin
No

The z minimum value for the envelope.

zMax
No

The z maximum value for the envelope.

Returns void

Union

void Union(const ArcGISEnvelope& envelope)

Finds the union of the builder's envelope and the specified envelope and updates the envelope builder with the result.

Since 1.0.0

Arguments
NameTypeConstSummary
envelope
Yes

Another envelope to union with.

Returns void

Union

void Union(const ArcGISPoint& point)

Finds the union of the builder's envelope and the specified point and updates the envelope builder with the result.

Since 1.0.0

Arguments
NameTypeConstSummary
point
Yes

A point to union with.

Returns void

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.