HorizontalVerticalTransformationStep

Represents a step in the process of transforming between horizontal and/or vertical datums. Each HorizontalVerticalTransformationStep can be constructed from a well-known ID (WKID) that represents a horizontal (geographic) or a vertical transformation. This API supports thousands of predefined transformations, and all the supported WKIDs are documented in the 'Coordinate systems and transformations' topic in the developers guide.

One or more HorizontalVerticalTransformationStep objects are combined into a HorizontalVerticalTransformation object, and can then be used to control how coordinates are transformed in a GeometryEngine.projectOrNull method call.

A HorizontalVerticalTransformationStep object is immutable.

Since

200.1.0

See also

Constructors

Link copied to clipboard
constructor(wkid: Int)

Creates a new HorizontalVerticalTransformationStep instance from a well-known ID. Occasionally, WKIDs may change, and older codes may be deprecated in favor of a new code. Both old (deprecated) and new (latest) WKIDs continue to work for instantiation, as long as they are supported by the Projection Engine. The HorizontalVerticalTransformationStep.wkid property returns the new (latest) WKID code.

constructor(wkText: String)

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

Properties

Link copied to clipboard

True if this transformation step instance is an inverted transformation. Transformations have a specific direction that is indicated by the HorizontalVerticalTransformationStep.wkText value. An inverted transformation is used to transform geometries in the opposite direction to that indicated by the well-known text. HorizontalVerticalTransformationStep has DatumTransformation.inputSpatialReference and DatumTransformation.outputSpatialReference properties that respect the inverse value of the contained transformation(s).

Link copied to clipboard

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

Link copied to clipboard

A list of the Projection Engine files required to support this transformation step. Datum transformations can be mathematically defined (equation-based transformations), or may rely on external supporting files (grid-based transformations). For a grid-based transformation step, this returns a list of the files required to use this transformation, prefixed by an expected subpath of the file(s) underneath TransformationCatalog.projectionEngineDirectory. For an equation-based transformation, this returns an empty list.

Link copied to clipboard
val wkid: Int

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.

Link copied to clipboard

The well-known text of this transformation step instance.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard

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

Link copied to clipboard
open override fun hashCode(): Int