ArcGISEnvelope

Namespace: GameEngine.Geometry
Class: 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
NameTypeSummary
xMin

The minimal x-value.

yMin

The minimal y-value.

xMax

The maximum x-value.

yMax

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
NameTypeSummary
xMin

The minimal x-value.

yMin

The minimal y-value.

xMax

The maximum x-value.

yMax

The maximum y-value.

zMin

The minimal z-value.

zMax

The maximum z-value.

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

Since 1.0.0

Arguments
NameTypeSummary
xMin

The minimal x-value.

yMin

The minimal y-value.

xMax

The maximum x-value.

yMax

The maximum y-value.

zMin

The minimal z-value.

zMax

The maximum z-value.

spatialReference

The spatial reference for the envelope.

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

Since 1.0.0

Arguments
NameTypeSummary
xMin

The minimal x-value.

yMin

The minimal y-value.

xMax

The maximum x-value.

yMax

The maximum y-value.

spatialReference

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
NameTypeSummary
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
NameTypeSummary
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
NameTypeSummary
min

The minimal values for the envelope.

max

The maximum values for the envelope.

Properties

PropertyTypeNullableReadonlySummary
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.

Center

The center point for the envelope.

Creates a new Point.

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.

Height

double Height

The height for the envelope.

Returns NAN if an error occurs.

MMax

double MMax

The m maximum value for the envelope.

Returns NAN if an error occurs.

MMin

double MMin

The m minimum value for the envelope.

Returns NAN if an error occurs.

Width

double Width

The width for the envelope.

Returns NAN if an error occurs.

XMax

double XMax

The x maximum value for the envelope.

Returns NAN if an error occurs.

XMin

double XMin

The x minimum value for the envelope.

Returns NAN if an error occurs.

YMax

double YMax

The y maximum value for the envelope.

Returns NAN if an error occurs.

YMin

double YMin

The y minimum value for the envelope.

Returns NAN if an error occurs.

ZMax

double ZMax

The z maximum value for the envelope.

Returns NAN if an error occurs.

ZMin

double ZMin

The z minimum value for the envelope.

Returns NAN if an error occurs.

Methods

SignatureReturn TypeSummary

CreateWithM(double, double, double, double, double, double)

ArcGISEnvelope

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)

ArcGISEnvelope

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)

ArcGISEnvelope

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

CreateWithM(double, double, double, double, double, double, ArcGISSpatialReference)

ArcGISEnvelope

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
NameTypeSummary
xMin

The minimal x-value.

yMin

The minimal y-value.

xMax

The maximum x-value.

yMax

The maximum y-value.

mMin

The minimal m-value.

mMax

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
NameTypeSummary
xMin

The minimal x-value.

yMin

The minimal y-value.

xMax

The maximum x-value.

yMax

The maximum y-value.

zMin

The minimal z-value.

zMax

The maximum z-value.

mMin

The minimal m-value.

mMax

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
NameTypeSummary
xMin

The minimal x-value.

yMin

The minimal y-value.

xMax

The maximum x-value.

yMax

The maximum y-value.

zMin

The minimal z-value.

zMax

The maximum z-value.

mMin

The minimal m-value.

mMax

The maximum m-value.

spatialReference

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
NameTypeSummary
xMin

The minimal x-value.

yMin

The minimal y-value.

xMax

The maximum x-value.

yMax

The maximum y-value.

mMin

The minimal m-value.

mMax

The maximum m-value.

spatialReference

The spatial reference for the envelope.

Returns ArcGISEnvelope

An envelope. This is passed to geometry or envelope functions.

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