ArcGISEnvelope

Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISEnvelope
Since: 1.0.0
Inheritance: ArcGISGeometry->ArcGISEnvelope

Summary

A geometry that represents a rectangular shape.

Constructors

ArcGISEnvelope(double, double, double, double)

Creates an envelope based on the x,y coordinates with a null spatial reference.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`xMin`	`double`	`No`	The minimal x-value.
`yMin`	`double`	`No`	The minimal y-value.
`xMax`	`double`	`No`	The maximum x-value.
`yMax`	`double`	`No`	The maximum y-value.

ArcGISEnvelope(double, double, double, double, double, double)

Creates an envelope based on the x,y and z values with a null spatial reference.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`xMin`	`double`	`No`	The minimal x-value.
`yMin`	`double`	`No`	The minimal y-value.
`xMax`	`double`	`No`	The maximum x-value.
`yMax`	`double`	`No`	The maximum y-value.
`zMin`	`double`	`No`	The minimal z-value.
`zMax`	`double`	`No`	The maximum z-value.

ArcGISEnvelope(double, double, double, double, double, double, const ArcGISSpatialReference&)

Creates an envelope based on x, y, and z values with the spatial reference.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`xMin`	`double`	`No`	The minimal x-value.
`yMin`	`double`	`No`	The minimal y-value.
`xMax`	`double`	`No`	The maximum x-value.
`yMax`	`double`	`No`	The maximum y-value.
`zMin`	`double`	`No`	The minimal z-value.
`zMax`	`double`	`No`	The maximum z-value.
`spatialReference`	`ArcGISSpatialReference`	`Yes`	The spatial reference for the envelope.

ArcGISEnvelope(double, double, double, double, const ArcGISSpatialReference&)

Creates an envelope based on the x,y coordinates with a spatial reference.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`xMin`	`double`	`No`	The minimal x-value.
`yMin`	`double`	`No`	The minimal y-value.
`xMax`	`double`	`No`	The maximum x-value.
`yMax`	`double`	`No`	The maximum y-value.
`spatialReference`	`ArcGISSpatialReference`	`Yes`	The spatial reference for the envelope.

ArcGISEnvelope(const ArcGISPoint&, double, double)

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

Since 1.0.0

Arguments

Name	Type	Const	Summary
`center`	`ArcGISPoint`	`Yes`	The center point for the envelope.
`width`	`double`	`No`	The width of the envelope around the center point.
`height`	`double`	`No`	The height of the envelope around the center point.

ArcGISEnvelope(const ArcGISPoint&, double, double, double)

Creates an envelope 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 for the envelope.
`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.

ArcGISEnvelope(const ArcGISPoint&, const ArcGISPoint&)

Creates an envelope from any two points.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`min`	`ArcGISPoint`	`Yes`	The minimal values for the envelope.
`max`	`ArcGISPoint`	`Yes`	The maximum values for the envelope.

Properties

Property	Type	Nullable	Readonly	Summary
`Center`	`ArcGISPoint`	`No`	`Yes`	The center point for the envelope.
`Depth`	`double`	`No`	`Yes`	The depth (ZMax - ZMin) for the envelope.
`Height`	`double`	`No`	`Yes`	The height for the envelope.
`MMax`	`double`	`No`	`Yes`	The m maximum value for the envelope.
`MMin`	`double`	`No`	`Yes`	The m minimum value for the envelope.
`Width`	`double`	`No`	`Yes`	The width for the envelope.
`XMax`	`double`	`No`	`Yes`	The x maximum value for the envelope.
`XMin`	`double`	`No`	`Yes`	The x minimum value for the envelope.
`YMax`	`double`	`No`	`Yes`	The y maximum value for the envelope.
`YMin`	`double`	`No`	`Yes`	The y minimum value for the envelope.
`ZMax`	`double`	`No`	`Yes`	The z maximum value for the envelope.
`ZMin`	`double`	`No`	`Yes`	The z minimum value for the envelope.

Center

ArcGISPoint GetCenter() const

The center point for the envelope.

Creates a new Point.

Depth

double GetDepth() const

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.