ArcGISGeographicTransformationStep

Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISGeographicTransformationStep
Since: 1.0.0

Summary

Represents a step in the process of transforming between datums.

Constructors

ArcGISGeographicTransformationStep(int32_t)

Creates a new ArcGISGeographicTransformationStep instance from a well-known ID.

Since 1.0.0

Arguments
NameTypeConstSummary
WKID
No

The well-known ID of the geographic transformation step to create.

ArcGISGeographicTransformationStep(const FString&)

Creates a new ArcGISGeographicTransformationStep instance from a well-known text string.

Since 1.0.0

Arguments
NameTypeConstSummary
WKText
Yes

The well-known text of the geographic transformation step to create.

Properties

PropertyTypeNullableReadonlySummary
No
No

True if this geographic transformation step instance is an inverted transformation.

No
Yes

True if any files needed by the Projection Engine for this geographic transformation step are missing from the local file system.

ArcGISImmutableArray<FString>
No
Yes

A list of the Projection Engine files required to support this geographic transformation step.

No
No

The well-known ID, or 0 if the transformation in this step does not have a well-known ID.

No
No

The well-known text of this geographic transformation step instance.

IsInverse

bool GetIsInverse() const

True if this geographic transformation step instance is an inverted transformation.

Transformations have a specific direction that is indicated by the ArcGISGeographicTransformationStep::WKText value. An inverted transformation is used to transform geometries in the opposite direction to that indicated by the well-known text. ArcGISGeographicTransformation has ArcGISDatumTransformation::InputSpatialReference and ArcGISDatumTransformation::OutputSpatialReference properties that respect the inverse value of the contained transformation(s).

This API supports a large number of transformation WKIDs, including transformations from every supported datum to the World Geodetic System 1984 (WGS84) datum. To transform coordinates between two non-WGS84 datums, typically one forward and one inverse ArcGISGeographicTransformationStep are added to a ArcGISGeographicTransformation, to get the required inputs and outputs.

IsMissingProjectionEngineFiles

bool GetIsMissingProjectionEngineFiles() const

True if any files needed by the Projection Engine for this geographic transformation step are missing from the local file system.

ProjectionEngineFilenames

ArcGISImmutableArray<FString> GetProjectionEngineFilenames() const

A list of the Projection Engine files required to support this geographic transformation step.

Each name in the list includes the full path. Projection Engine datasets are used in grid-based transforms.

WKID

int32_t GetWKID() const

The well-known ID, or 0 if the transformation in this step does not have a well-known ID.

Occasionally, WKIDs may change, and an older code may be deprecated in favor of a new code. This property returns the new (latest) WKID code.

WKText

FString GetWKText() const

The well-known text of this geographic transformation step instance.

This value does not respect the ArcGISGeographicTransformationStep::IsInverse property.

Methods

SignatureReturn TypeSummary

Equals(const ArcGISGeographicTransformationStep&)

bool

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

GetInverse()

ArcGISGeographicTransformationStep

Returns the inverse of this geographic transformation step or null if the transformation is not invertible.

Equals

bool Equals(const ArcGISGeographicTransformationStep& rightGeographicTransformationStep) const

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

Since 1.0.0

Arguments
NameTypeConstSummary
rightGeographicTransformationStep
Yes

Another geographic transformation step.

Returns bool

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

GetInverse

Returns the inverse of this geographic transformation step or null if the transformation is not invertible.

Since 1.0.0

Returns ArcGISGeographicTransformationStep

A ArcGISGeographicTransformationStep representing the inverse or null if an inverse does not exist.

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