Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISHorizontalVerticalTransformationStep
Since: 1.0.0
Summary
Represents a step in the process of transforming between horizontal and/or vertical datums.
Constructors
ArcGISHorizontalVerticalTransformationStep(int32_t)
Creates a new ArcGISHorizontalVerticalTransformationStep instance from a well-known ID.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
WKID | No | The well-known ID of the transformation step to create. |
ArcGISHorizontalVerticalTransformationStep(const FString&)
Creates a new ArcGISHorizontalVerticalTransformationStep instance from a well-known text string.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
WK | Yes | The well-known text of the transformation step to create. |
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
No | No | True if this transformation step instance is an inverted transformation. | ||
No | Yes | True if any files needed by the Projection Engine for this transformation step are missing from the local file system. | ||
ArcGISImmutableArray<FString> | No | Yes | A list of the Projection Engine files required to support this 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 transformation step instance. |
IsInverse
bool GetIsInverse() const
True if this transformation step instance is an inverted transformation.
Transformations have a specific direction that is indicated by the ArcGISHorizontalVerticalTransformationStep::WKText value. An inverted transformation is used to transform geometries in the opposite direction to that indicated by the well-known text. ArcGISHorizontalVerticalTransformationStep has ArcGISDatumTransformation::InputSpatialReference and ArcGISDatumTransformation::OutputSpatialReference properties that respect the inverse value of the contained transformation(s).
IsMissingProjectionEngineFiles
bool GetIsMissingProjectionEngineFiles() const
True if any files needed by the Projection Engine for this 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 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.
Methods
| Signature | Return Type | Summary |
|---|---|---|
Tests if this object is equal to a second ArcGISHorizontalVerticalTransformationStep object. | ||
Returns the inverse of this transformation step or null if the transformation is not invertible. |
Equals
bool Equals(const ArcGISHorizontalVerticalTransformationStep& rightHorizontalVerticalTransformationStep) const
Tests if this object is equal to a second ArcGISHorizontalVerticalTransformationStep object.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
right | Yes |
Returns bool
True if the comparison succeeds and the objects are equal, false otherwise.
GetInverse
ArcGISHorizontalVerticalTransformationStep GetInverse() const
Returns the inverse of this transformation step or null if the transformation is not invertible.
Since 1.0.0
Returns ArcGISHorizontalVerticalTransformationStep
A ArcGISHorizontalVerticalTransformationStep representing the inverse or null if an inverse does not exist.