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
| Name | Type | Const | Summary |
|---|---|---|---|
envelope | ArcGISEnvelope | 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
| Name | Type | Const | Summary |
|---|---|---|---|
center | ArcGISPoint | Yes | The center point of the ArcGISEnvelope being constructed. |
width | double | No | The width of the envelope around the center point. |
height | double | 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
| Name | Type | Const | Summary |
|---|---|---|---|
center | ArcGISPoint | Yes | The center point of the ArcGISEnvelope being constructed. |
width | double | No | The width of the envelope around the center point. |
height | double | No | The height of the envelope around the center point. |
depth | double | No | The depth of the envelope around the center point. |
ArcGISEnvelopeBuilder(const ArcGISSpatialReference&)
Creates an envelope builder.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
spatial | ArcGISSpatialReference | Yes | The builder's spatial reference. |
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
Center | ArcGISPoint | No | Yes | The center point of the ArcGISEnvelope being constructed. |
Depth | double | No | Yes | The depth of the ArcGISEnvelope being constructed. |
Height | double | No | Yes | The height of the ArcGISEnvelope being constructed. |
MMax | double | No | No | The m maximum value of the ArcGISEnvelope being constructed. |
MMin | double | No | No | The m minimum value of the ArcGISEnvelope being constructed. |
Width | double | No | Yes | The width of the ArcGISEnvelope being constructed. |
XMax | double | No | No | The x maximum value of the ArcGISEnvelope being constructed. |
XMin | double | No | No | The x minimum value of the ArcGISEnvelope being constructed. |
YMax | double | No | No | The y maximum value of the ArcGISEnvelope being constructed. |
YMin | double | No | No | The y minimum value of the ArcGISEnvelope being constructed. |
ZMax | double | No | No | The z maximum value of the ArcGISEnvelope being constructed. |
ZMin | double | No | No | The z minimum value 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
| Signature | Return Type | Summary |
|---|---|---|
CenterAt(const ArcGISPoint&) | Centers the envelope at the specified point. | |
Adjust the envelope's aspect ratio to match the ratio of the given width and height. | ||
Expands the envelope by the given scale factor. | ||
Expand(const ArcGISPoint&, double) | Expands the envelope at the anchor point by the given factor. | |
Moves the builder's envelope geometry by the given offsets in the x and y dimension. | ||
Set the m-values for the envelope. | ||
Set the x,y coordinates for the envelope. | ||
Set the z-values for the envelope. | ||
Union(const ArcGISEnvelope&) | Finds the union of the builder's envelope and the specified envelope and updates the envelope builder with the result. | |
Union(const ArcGISPoint&) | 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
| Name | Type | Const | Summary |
|---|---|---|---|
point | ArcGISPoint | Yes | The point to center on. |
Returns void
ChangeAspectRatio
Adjust the envelope's aspect ratio to match the ratio of the given width and height.
Since 1.0.0
Arguments
Returns void
Expand
Expands the envelope by the given scale factor.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
factor | double | 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
| Name | Type | Const | Summary |
|---|---|---|---|
anchor | ArcGISPoint | Yes | The point to anchor at. |
factor | double | No | The factor to scale the envelope by. |
Returns void
OffsetBy
Moves the builder's envelope geometry by the given offsets in the x and y dimension.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
offset | double | No | The number of units to move the envelope on the x axis. |
offset | double | No | The number of units to move the envelope on the y axis. |
Returns void
SetM
Set the m-values for the envelope.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
m | double | No | The m minimum value for the envelope. |
m | double | No | The m maximum value for the envelope. |
Returns void
SetXY
Set the x,y coordinates for the envelope.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
x | double | No | The x minimum value for the envelope. |
y | double | No | The y minimum value for the envelope. |
x | double | No | The x maximum value for the envelope. |
y | double | No | The y maximum value for the envelope. |
Returns void
SetZ
Set the z-values for the envelope.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
z | double | No | The z minimum value for the envelope. |
z | double | 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
| Name | Type | Const | Summary |
|---|---|---|---|
envelope | ArcGISEnvelope | 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
| Name | Type | Const | Summary |
|---|---|---|---|
point | ArcGISPoint | Yes | A point to union with. |