ArcGIS Maps SDK for Unreal EngineAPI reference

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`	`ArcGISEnvelope`	`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`	`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.

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

ArcGISEnvelopeBuilder(const ArcGISSpatialReference&)

Creates a envelope builder.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`spatialReference`	`ArcGISSpatialReference`	`Yes`	The builder's spatial reference.

Properties

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

Width

double GetWidth() const

The width for the envelope builder.

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&)	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(const 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(const ArcGISEnvelope&)	void	Finds the union of this envelope and the given envelope and updates the envelope builder with the result.
Union(const ArcGISPoint&)	void	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`	`ArcGISPoint`	`Yes`	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

Name	Type	Const	Summary
`width`	`double`	`No`	A width.
`height`	`double`	`No`	A height.

Returns `void`

Expand

void Expand(double factor)

Expands the envelope by the given scale factor.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`factor`	`double`	`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`	`ArcGISPoint`	`Yes`	The point to anchor at.
`factor`	`double`	`No`	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

Name	Type	Const	Summary
`offsetX`	`double`	`No`	The number of units to move the envelope on the x axis.
`offsetY`	`double`	`No`	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

Name	Type	Const	Summary
`mMin`	`double`	`No`	The m minimum value for the envelope.
`mMax`	`double`	`No`	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

Name	Type	Const	Summary
`xMin`	`double`	`No`	The x minimum value for the envelope.
`yMin`	`double`	`No`	The y minimum value for the envelope.
`xMax`	`double`	`No`	The x maximum value for the envelope.
`yMax`	`double`	`No`	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

Name	Type	Const	Summary
`zMin`	`double`	`No`	The z minimum value for the envelope.
`zMax`	`double`	`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`	`ArcGISEnvelope`	`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`	`ArcGISPoint`	`Yes`	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.