Namespace: GameEngine.Geometry
Class: GameEngine/Geometry/ArcGISEnvelope
Since: 1.0.0
Inheritance: ArcGISGeometry->ArcGISEnvelope
Summary
A geometry that represents a rectangular shape.
Constructors
Creates an envelope based on the x,y and z values with a null spatial reference.
Since 1.0.0
Arguments
ArcGISEnvelope(double, double, double, double, ArcGISSpatialReference)
Creates an envelope based on the x,y coordinates with a spatial reference.
Since 1.0.0
Arguments
Name | Type | Summary |
---|---|---|
x | The minimal x-value. | |
y | The minimal y-value. | |
x | The maximum x-value. | |
y | The maximum y-value. | |
spatial | The spatial reference for the envelope. |
ArcGISEnvelope(ArcGISPoint, double, double)
Creates an envelope from a center point and a width and height.
Since 1.0.0
Arguments
Name | Type | Summary |
---|---|---|
center | The center point for the envelope. | |
width | The width of the envelope around the center point. | |
height | The height of the envelope around the center point. |
ArcGISEnvelope(ArcGISPoint, double, double, double)
Creates an envelope from a center point and a width, height, and depth.
Since 1.0.0
Arguments
Name | Type | Summary |
---|---|---|
center | The center point for the envelope. | |
width | The width of the envelope around the center point. | |
height | The height of the envelope around the center point. | |
depth | The depth of the envelope around the center point. |
ArcGISEnvelope(ArcGISPoint, ArcGISPoint)
Creates an envelope from any two points.
Since 1.0.0
Arguments
Name | Type | Summary |
---|---|---|
min | The minimal values for the envelope. | |
max | The maximum values for the envelope. |
Properties
Property | Type | Nullable | Readonly | Summary |
---|---|---|---|---|
No | Yes | The center point for the envelope. | ||
No | Yes | The depth (ZMax - ZMin) for the envelope. | ||
No | Yes | The height for the envelope. | ||
No | Yes | The m maximum value for the envelope. | ||
No | Yes | The m minimum value for the envelope. | ||
No | Yes | The width for the envelope. | ||
No | Yes | The x maximum value for the envelope. | ||
No | Yes | The x minimum value for the envelope. | ||
No | Yes | The y maximum value for the envelope. | ||
No | Yes | The y minimum value for the envelope. | ||
No | Yes | The z maximum value for the envelope. | ||
No | Yes | The z minimum value for the envelope. |
Depth
double Depth
The depth (ZMax - ZMin) for the envelope.
A 2D envelope has zero depth. Returns NAN if the envelope is empty or if an error occurs.
Methods
Signature | Return Type | Summary |
---|---|---|
Creates an envelope based on the x, y and m values with a null spatial reference. | ||
CreateWithM(double, double, double, double, double, double, double, double) | Creates an envelope based on the x, y, z and m values with a null spatial reference. | |
CreateWithM(double, double, double, double, double, double, double, double, ArcGISSpatialReference) | Creates an envelope based on the x, y, z and m values with a spatial reference. | |
CreateWithM(double, double, double, double, double, double, ArcGISSpatialReference) | Creates an envelope based on the x, y and m values with a spatial reference. |
CreateWithM
static ArcGISEnvelope CreateWithM(double xMin, double yMin, double xMax, double yMax, double mMin, double mMax)
Creates an envelope based on the x, y and m values with a null spatial reference.
Since 1.0.0
Arguments
Name | Type | Summary |
---|---|---|
x | The minimal x-value. | |
y | The minimal y-value. | |
x | The maximum x-value. | |
y | The maximum y-value. | |
m | The minimal m-value. | |
m | The maximum m-value. |
Returns ArcGISEnvelope
An envelope. This is passed to geometry or envelope functions.
CreateWithM
static ArcGISEnvelope CreateWithM(double xMin, double yMin, double xMax, double yMax, double zMin, double zMax, double mMin, double mMax)
Creates an envelope based on the x, y, z and m values with a null spatial reference.
Since 1.0.0
Arguments
Name | Type | Summary |
---|---|---|
x | The minimal x-value. | |
y | The minimal y-value. | |
x | The maximum x-value. | |
y | The maximum y-value. | |
z | The minimal z-value. | |
z | The maximum z-value. | |
m | The minimal m-value. | |
m | The maximum m-value. |
Returns ArcGISEnvelope
An envelope. This is passed to geometry or envelope functions.
CreateWithM
static ArcGISEnvelope CreateWithM(double xMin, double yMin, double xMax, double yMax, double zMin, double zMax, double mMin, double mMax, ArcGISSpatialReference spatialReference)
Creates an envelope based on the x, y, z and m values with a spatial reference.
Since 1.0.0
Arguments
Name | Type | Summary |
---|---|---|
x | The minimal x-value. | |
y | The minimal y-value. | |
x | The maximum x-value. | |
y | The maximum y-value. | |
z | The minimal z-value. | |
z | The maximum z-value. | |
m | The minimal m-value. | |
m | The maximum m-value. | |
spatial | The spatial reference for the envelope. |
Returns ArcGISEnvelope
An envelope. This is passed to geometry or envelope functions.
CreateWithM
static ArcGISEnvelope CreateWithM(double xMin, double yMin, double xMax, double yMax, double mMin, double mMax, ArcGISSpatialReference spatialReference)
Creates an envelope based on the x, y and m values with a spatial reference.
Since 1.0.0
Arguments
Name | Type | Summary |
---|---|---|
x | The minimal x-value. | |
y | The minimal y-value. | |
x | The maximum x-value. | |
y | The maximum y-value. | |
m | The minimal m-value. | |
m | The maximum m-value. | |
spatial | The spatial reference for the envelope. |
Returns ArcGISEnvelope
An envelope. This is passed to geometry or envelope functions.