ArcGISSpatialReference

Namespace: GameEngine.Geometry
Class: GameEngine/Geometry/ArcGISSpatialReference
Since: 1.0.0

Summary

The spatial reference specifies how geometry coordinates relate to real-world space.

Constructors

ArcGISSpatialReference(int)

Creates a spatial reference based on WKID.

Since 1.0.0

Arguments
NameTypeSummary
WKID

The well-known ID of the horizontal coordinate system. Must be a positive value.

ArcGISSpatialReference(int, int)

Creates a spatial reference based on WKID for the horizontal coordinate system and vertical coordinate system.

Since 1.0.0

Arguments
NameTypeSummary
WKID

The well-known ID of the horizontal coordinate system. Must be a positive value.

verticalWKID

The well-known ID of the vertical coordinate system. Must be a non negative value.

ArcGISSpatialReference(string)

Creates a spatial reference based on well-known text.

Since 1.0.0

Arguments
NameTypeSummary
wkText

The well-known text of the spatial reference to create.

Properties

PropertyTypeNullableReadonlySummary
Yes
Yes

If the given spatial reference is a projected coordinate system, then this returns the geographic coordinate system of that system.

No
Yes

The full world extent for the spatial reference.

No
Yes

True if spatial reference has a vertical coordinate system set; false otherwise.

No
Yes

True if spatial reference is a Geographic Coordinate System.

No
Yes

True if coordinate system is horizontally pannable.

No
Yes

True if spatial reference is a Projected Coordinate System.

No
Yes

The spheroid data for the spatial reference.

No
Yes

The unit of measure for the horizontal coordinate system of this spatial reference.

Yes
Yes

The unit of measure for the vertical coordinate system of this spatial reference.

No
Yes

The well-known ID for the vertical coordinate system (VCS), or 0 if the spatial reference has no VCS or has a custom VCS.

No
Yes

The well-known ID for the horizontal coordinate system, or 0 if the spatial reference has a custom horizontal coordinate system.

No
Yes

The well-known text for the horizontal and vertical coordinate system.

BaseGeographic

ArcGISSpatialReference BaseGeographic

If the given spatial reference is a projected coordinate system, then this returns the geographic coordinate system of that system.

If the spatial reference is a projected coordinate system, then a spatial reference object representing the underlying geographic coordinate system is returned. Every projected coordinate system has an underlying geographic coordinate system. If the spatial reference is a geographic coordinate system, then a reference to itself is returned. If the spatial reference is a local spatial reference, a null is returned with an error.

FullWorldExtent

ArcGISEnvelope FullWorldExtent

The full world extent for the spatial reference.

The envelope defines the valid range of coordinates for the spatial reference.

HasVertical

bool HasVertical

True if spatial reference has a vertical coordinate system set; false otherwise.

A spatial reference can optionally include a definition for a vertical coordinate system (VCS), which can be used to interpret the z-values of a geometry. A VCS defines linear units of measure, the origin of z-values, and whether z-values are "positive up" (representing heights above a surface) or "positive down" (indicating that values are depths below a surface).

An ArcGISSpatialReference may have a VCS set, for example by calling the ArcGISSpatialReference.ArcGISSpatialReference constructor. ArcGISSpatialReference.VerticalWKID, ArcGISSpatialReference.WKText, and ArcGISSpatialReference.VerticalUnit provide more information about the specific VCS set on this instance.

VCSs are used when projecting geometries using an ArcGISHorizontalVerticalTransformation.

IsGeographic

bool IsGeographic

True if spatial reference is a Geographic Coordinate System.

IsPannable

bool IsPannable

True if coordinate system is horizontally pannable.

IsProjected

bool IsProjected

True if spatial reference is a Projected Coordinate System.

SpheroidData

ArcGISSpheroidData SpheroidData

The spheroid data for the spatial reference.

The spheroid data for the spatial reference.

Unit

The unit of measure for the horizontal coordinate system of this spatial reference.

VerticalUnit

ArcGISLinearUnit VerticalUnit

The unit of measure for the vertical coordinate system of this spatial reference.

Is null if ArcGISSpatialReference.HasVertical is false.

VerticalWKID

int VerticalWKID

The well-known ID for the vertical coordinate system (VCS), or 0 if the spatial reference has no VCS or has a custom VCS.

WKID

int WKID

The well-known ID for the horizontal coordinate system, or 0 if the spatial reference has a custom horizontal coordinate system.

WKText

string WKText

The well-known text for the horizontal and vertical coordinate system.

Methods

SignatureReturn TypeSummary

Equals(ArcGISSpatialReference)

bool

Tests if this object is equal to a second ArcGISSpatialReference object.

GetConvergenceAngle(ArcGISPoint)

double

Calculate the grid convergence for a spatial reference at a given point.

WebMercator()

ArcGISSpatialReference

Creates a spatial reference based on web Mercator.

WGS84()

ArcGISSpatialReference

Creates a spatial reference based on WGS84.

Equals

Tests if this object is equal to a second ArcGISSpatialReference object.

Since 1.0.0

Arguments
NameTypeSummary
right

The 2nd spatial reference to check to see if equal to the 1st.

Returns bool

True if the comparison succeeds and the objects are equal, false otherwise.

GetConvergenceAngle

double GetConvergenceAngle(ArcGISPoint point)

Calculate the grid convergence for a spatial reference at a given point.

Since 1.0.0

Arguments
NameTypeSummary
point

The point.

Returns double

The grid convergence in degrees.

WebMercator

static ArcGISSpatialReference WebMercator()

Creates a spatial reference based on web Mercator.

Since 1.0.0

Returns ArcGISSpatialReference

A spatial reference. This is passed to spatial reference functions. null if an error occurs.

WGS84

static ArcGISSpatialReference WGS84()

Creates a spatial reference based on WGS84.

Since 1.0.0

Returns ArcGISSpatialReference

A spatial reference. This is passed to spatial reference functions. null if an error occurs.

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