ArcGISEnvelopeBuilder

Namespace: GameEngine.Geometry
Class: GameEngine/Geometry/ArcGISEnvelopeBuilder
Since: 1.0.0
Inheritance: ArcGISGeometryBuilder->ArcGISEnvelopeBuilder

Summary

The envelope builder object is used to create an envelope.

Constructors

ArcGISEnvelopeBuilder(ArcGISEnvelope)

Creates an envelope builder from an envelope.

Since 1.0.0

Arguments
NameTypeSummary
envelope

The envelope.

ArcGISEnvelopeBuilder(ArcGISPoint, double, double)

Creates an envelope builder 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.

ArcGISEnvelopeBuilder(ArcGISPoint, double, double, double)

Creates an envelope builder 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.

ArcGISEnvelopeBuilder(ArcGISSpatialReference)

Creates an envelope builder.

Since 1.0.0

Arguments
NameTypeSummary
spatialReference

The builder's spatial reference.

Properties

PropertyTypeNullableReadonlySummary
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

The center point for the envelope builder.

Creates a new Point that must be destroyed.

Depth

double Depth

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 Height

The height for the envelope builder.

The width for the envelope builder. 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 builder.

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

CenterAt(ArcGISPoint)

void

Centers the envelope over the given point.

ChangeAspectRatio(double, double)

void

Adjust the envelope's aspect ratio to match the ratio of the given width and height.

Expand(double)

void

Expands the envelope by the given scale factor.

Expand(ArcGISPoint, double)

void

Expands the envelope at the anchor point by the given factor.

OffsetBy(double, double)

void

Offsets the envelope by the given offsets for the x and y dimension.

SetM(double, double)

void

Set the m-values for the envelope.

SetXY(double, double, double, double)

void

Set the x,y coordinates for the envelope.

SetZ(double, double)

void

Set the z-values for the envelope.

Union(ArcGISEnvelope)

void

Finds the union of this envelope and the given envelope and updates the envelope builder with the result.

Union(ArcGISPoint)

void

Finds the union of this envelope and the given point and updates the envelope builder with the result.

CenterAt

void CenterAt(ArcGISPoint point)

Centers the envelope over the given point.

Since 1.0.0

Arguments
NameTypeSummary
point

The point to center on.

Returns void

ChangeAspectRatio

void ChangeAspectRatio(double width, double height)

Adjust the envelope's aspect ratio to match the ratio of the given width and height.

Since 1.0.0

Arguments
NameTypeSummary
width

A width.

height

A height.

Returns void

Expand

void Expand(double factor)

Expands the envelope by the given scale factor.

Since 1.0.0

Arguments
NameTypeSummary
factor

Values less than 1 zoom in and values greater than 1 zoom out.

Returns void

Expand

void Expand(ArcGISPoint anchor, double factor)

Expands the envelope at the anchor point by the given factor.

Since 1.0.0

Arguments
NameTypeSummary
anchor

The point to anchor at.

factor

Values less than 1 zoom in and values greater than 1 zoom out.

Returns void

OffsetBy

void OffsetBy(double offsetX, double offsetY)

Offsets the envelope by the given offsets for the x and y dimension.

Since 1.0.0

Arguments
NameTypeSummary
offsetX

The number of units to move the envelope on the x axis.

offsetY

The number of units to move the envelope on the y axis.

Returns void

SetM

void SetM(double mMin, double mMax)

Set the m-values for the envelope.

Since 1.0.0

Arguments
NameTypeSummary
mMin

The m minimum value for the envelope.

mMax

The m maximum value for the envelope.

Returns void

SetXY

void SetXY(double xMin, double yMin, double xMax, double yMax)

Set the x,y coordinates for the envelope.

Since 1.0.0

Arguments
NameTypeSummary
xMin

The x minimum value for the envelope.

yMin

The y minimum value for the envelope.

xMax

The x maximum value for the envelope.

yMax

The y maximum value for the envelope.

Returns void

SetZ

void SetZ(double zMin, double zMax)

Set the z-values for the envelope.

Since 1.0.0

Arguments
NameTypeSummary
zMin

The z minimum value for the envelope.

zMax

The z maximum value for the envelope.

Returns void

Union

void Union(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
NameTypeSummary
envelope

Another envelope to union with.

Returns void

Union

void Union(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
NameTypeSummary
point

A point to union with.

Returns void

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