ArcGISEnvelopeBuilder
Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISEnvelopeBuilder
Since: 1.0.0
Inheritance: ArcGISGeometryBuilder->ArcGISEnvelopeBuilder
Summary
The envelope builder object is used to create an envelope.
Constructors
ArcGISEnvelopeBuilder(const ArcGISEnvelope&)
Creates a envelope builder from a envelope.
Since 1.0.0
Arguments
Name | Type | Const | Summary |
---|---|---|---|
envelope | Yes | The envelope. |
ArcGISEnvelopeBuilder(const ArcGISPoint&, double, double)
Creates a envelope builder from a center point and a width and height.
Since 1.0.0
Arguments
Name | Type | Const | Summary |
---|---|---|---|
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 a envelope builder from a center point and a width, height, and depth.
Since 1.0.0
Arguments
Name | Type | Const | Summary |
---|---|---|---|
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 a envelope builder.
Since 1.0.0
Arguments
Name | Type | Const | Summary |
---|---|---|---|
spatial | Yes | The builder's spatial reference. |
Properties
Property | Type | Nullable | Readonly | Summary |
---|---|---|---|---|
No | Yes | The center point for the envelope builder. | ||
No | Yes | The depth (ZMax - ZMin) for the envelope builder. | ||
No | Yes | The height for the envelope builder. | ||
No | No | The m maximum value for the envelope. | ||
No | No | The m minimum value for the envelope. | ||
No | Yes | The width for the envelope builder. | ||
No | No | The x maximum value for the envelope. | ||
No | No | The x minimum value for the envelope. | ||
No | No | The y maximum value for the envelope. | ||
No | No | The y minimum value for the envelope. | ||
No | No | The z maximum value for the envelope. | ||
No | No | The z minimum value for the envelope. |
Center
ArcGISPoint GetCenter() const
The center point for the envelope builder.
Creates a new Point that must be destroyed.
Depth
double GetDepth() const
The depth (ZMax - ZMin) for the envelope builder.
A 2D envelope has zero depth. Returns NAN if the envelope is empty or if an error occurs.
Height
double GetHeight() const
The height for the envelope builder.
The width for the envelope builder. Returns NAN if an error occurs.
MMax
double GetMMax() const
void SetMMax(double mMax)
The m maximum value for the envelope.
Returns NAN if an error occurs.
MMin
double GetMMin() const
void SetMMin(double mMin)
The m minimum value for the envelope.
Returns NAN if an error occurs.
XMax
double GetXMax() const
void SetXMax(double xMax)
The x maximum value for the envelope.
Returns NAN if an error occurs.
XMin
double GetXMin() const
void SetXMin(double xMin)
The x minimum value for the envelope.
Returns NAN if an error occurs.
YMax
double GetYMax() const
void SetYMax(double yMax)
The y maximum value for the envelope.
Returns NAN if an error occurs.
YMin
double GetYMin() const
void SetYMin(double yMin)
The y minimum value for the envelope.
Returns NAN if an error occurs.
ZMax
double GetZMax() const
void SetZMax(double zMax)
The z maximum value for the envelope.
Returns NAN if an error occurs.
ZMin
double GetZMin() const
void SetZMin(double zMin)
The z minimum value for the envelope.
Returns NAN if an error occurs.
Methods
Signature | Return Type | Summary |
---|---|---|
CenterAt(const ArcGISPoint&) | Centers the envelope over the given 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. | |
Offsets the envelope by the given offsets for 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 this envelope and the given envelope and updates the envelope builder with the result. | |
Union(const ArcGISPoint&) | Finds the union of this envelope and the given point and updates the envelope builder with the result. |
CenterAt
void CenterAt(const ArcGISPoint& point)
Centers the envelope over the given point.
Since 1.0.0
Arguments
Name | Type | Const | Summary |
---|---|---|---|
point | 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 | No | Values less than 1 zoom in and values greater than 1 zoom out. |
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 | Yes | The point to anchor at. | |
factor | No | Values less than 1 zoom in and values greater than 1 zoom out. |
Returns void
OffsetBy
Offsets the envelope by the given offsets for the x and y dimension.
Since 1.0.0
Arguments
Name | Type | Const | Summary |
---|---|---|---|
offset | No | The number of units to move the envelope on the x axis. | |
offset | 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 | No | The m minimum value for the envelope. | |
m | 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 | No | The x minimum value for the envelope. | |
y | No | The y minimum value for the envelope. | |
x | No | The x maximum value for the envelope. | |
y | 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 | No | The z minimum value for the envelope. | |
z | No | The z maximum value for the envelope. |
Returns void
Union
void Union(const ArcGISEnvelope& envelope)
Finds the union of this envelope and the given envelope and updates the envelope builder with the result.
Since 1.0.0
Arguments
Name | Type | Const | Summary |
---|---|---|---|
envelope | Yes | Another envelope to union with. |
Returns void
Union
void Union(const ArcGISPoint& point)
Finds the union of this envelope and the given point and updates the envelope builder with the result.
Since 1.0.0
Arguments
Name | Type | Const | Summary |
---|---|---|---|
point | Yes | A point to union with. |