Skip to main content

Interface: MutableGeoProjection

Defined in: src/sdk/geo/GeoProjection.ts:80

A mutable geographic projection.

Extends​

Methods​

copyParametersFrom()​

copyParametersFrom(other): this

Defined in: src/sdk/geo/GeoProjection.ts:144

Copies all projection parameters from another projection. The parameters copied are: center, pre-projection rotation angles, scale factor, post-projection translation, post-projection rotation angle, and reflectY.

Parameters​

ParameterTypeDescription
otherGeoProjectionThe projection from which to copy parameters.

Returns​

this

This projection, after it has been changed.


getCenter()​

getCenter(): GeoPointReadOnly

Defined in: src/sdk/geo/GeoProjection.ts:16

Gets the geographic center of this projection.

Returns​

GeoPointReadOnly

The geographic center of this projection.

Inherited from​

GeoProjection.getCenter


getPostRotation()​

getPostRotation(): number

Defined in: src/sdk/geo/GeoProjection.ts:51

Gets the post-projection (planar) rotation angle of this projection in radians.

Returns​

number

The post-projection rotation angle of this projection.

Inherited from​

GeoProjection.getPostRotation


getPreRotation()​

getPreRotation(): ReadonlyFloat64Array

Defined in: src/sdk/geo/GeoProjection.ts:39

Gets the pre-projection (spherical) rotation of this projection as a vector [lambda, phi, gamma]. The rotation angles are expressed in radians. The full rotation is an intrinsic rotation with angles applied in the order lambda, phi, gamma. The rotation uses the standard geographic cartesian coordinate system, a right-handed coordinate system with the origin at the center of the earth, the positive x axis passing through 0 degrees N, 0 degrees E, and the positive z axis passing through the North Pole.

  • lambda: Intrinsic rotation angle about the z axis. Positive rotation is in the counterclockwise direction when looking down from above the axis.
  • phi: Intrinsic rotation angle about the y axis. Positive rotation is in the clockwise direction when looking down from above the axis.
  • gamma: Intrinsic rotation angle about the x axis. Positive rotation is in the counterclockwise direction when looking down from above the axis.

Returns​

ReadonlyFloat64Array

The pre-projection rotation of this projection.

Inherited from​

GeoProjection.getPreRotation


getReflectY()​

getReflectY(): boolean

Defined in: src/sdk/geo/GeoProjection.ts:57

Checks whether this projection reflects the projected coordinate system across the x-axis.

Returns​

boolean

Whether this projection reflects the projected coordinate system across the x-axis.

Inherited from​

GeoProjection.getReflectY


getScaleFactor()​

getScaleFactor(): number

Defined in: src/sdk/geo/GeoProjection.ts:23

Gets the nominal scale factor of this projection. At a scale factor of 1, a distance of one great-arc radian will be projected to a distance of one pixel.

Returns​

number

The nominal scale factor of this projection.

Inherited from​

GeoProjection.getScaleFactor


getTranslation()​

getTranslation(): ReadonlyFloat64Array

Defined in: src/sdk/geo/GeoProjection.ts:45

Gets the post-projection (planar) translation of this projection, in pixels.

Returns​

ReadonlyFloat64Array

The post-projection translation of this projection.

Inherited from​

GeoProjection.getTranslation


invert()​

invert<T>(vec, out): T

Defined in: src/sdk/geo/GeoProjection.ts:74

Inverts a set of projected coordinates. This method will determine the geographic point whose projected location is the equal to that described by a 2D position vector.

Type Parameters​

Type Parameter
T extends Float64Array<ArrayBufferLike> | GeoPoint

Parameters​

ParameterTypeDescription
vecReadonlyFloat64ArrayThe 2D position vector describing the location of the projected coordinates.
outTThe point to which to write the result.

Returns​

T

the inverted point.

Inherited from​

GeoProjection.invert


project()​

project(point, out): Float64Array

Defined in: src/sdk/geo/GeoProjection.ts:65

Projects a set of lat/lon coordinates.

Parameters​

ParameterTypeDescription
pointReadonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | Readonly<LatLonInterface>The point to project, as either a LatLonInterface or a [lon, lat] array.
outFloat64ArrayThe vector to which to write the result.

Returns​

Float64Array

The projected point, as a vector.

Inherited from​

GeoProjection.project


setCenter()​

setCenter(point): this

Defined in: src/sdk/geo/GeoProjection.ts:87

Sets the geographic center of this projection. The center point of the projection is projected to the origin, before any post-projection transformations are applied.

Parameters​

ParameterTypeDescription
pointReadonly<LatLonInterface>The new center point.

Returns​

this

This projection, after it has been changed.


setPostRotation()​

setPostRotation(rotation): this

Defined in: src/sdk/geo/GeoProjection.ts:127

Sets the post-projection (planar) rotation of this projection.

Parameters​

ParameterTypeDescription
rotationnumberThe new post-projection rotation angle, in radians.

Returns​

this

This projection, after it has been changed.


setPreRotation()​

setPreRotation(vec): this

Defined in: src/sdk/geo/GeoProjection.ts:113

Sets the pre-projection (spherical) rotation of this projection as a vector [lambda, phi, gamma]. The full rotation is an intrinsic rotation with angles applied in the order lambda, phi, gamma. The rotation uses the standard geographic cartesian coordinate system, a right-handed coordinate system with the origin at the center of the earth, the positive x axis passing through 0 degrees N, 0 degrees E, and the z axis passing through the North Pole.

  • lambda: Intrinsic rotation angle about the z axis. Positive rotation is in the counterclockwise direction when looking down from above the axis.
  • phi: Intrinsic rotation angle about the y axis. Positive rotation is in the clockwise direction when looking down from above the axis.
  • gamma: Intrinsic rotation angle about the x axis. Positive rotation is in the counterclockwise direction when looking down from above the axis.

Parameters​

ParameterTypeDescription
vecReadonlyFloat64ArrayThe pre-projection rotation, as a vector [lambda, phi, gamma]. The rotation angles should be expressed in radians.

Returns​

this

This projection, after it has been changed.


setReflectY()​

setReflectY(val): this

Defined in: src/sdk/geo/GeoProjection.ts:136

Sets whether this reflection should reflect the projected coordinate system across the x-axis. Setting this value to true is useful in the situation where the projected coordinate system should use a positive-y-axis-down convention.

Parameters​

ParameterTypeDescription
valbooleanTrue if reflection is desired, false otherwise.

Returns​

this

This projection, after it has been changed.


setScaleFactor()​

setScaleFactor(factor): this

Defined in: src/sdk/geo/GeoProjection.ts:95

Sets the nominal scale factor of this projection. At a scale factor of 1, a distance of one great-arc radian will be projected to a distance of one pixel.

Parameters​

ParameterTypeDescription
factornumberThe new nominal scale factor.

Returns​

this

This projection, after it has been changed.


setTranslation()​

setTranslation(vec): this

Defined in: src/sdk/geo/GeoProjection.ts:120

Sets the post-projection (planar) translation of this projection.

Parameters​

ParameterTypeDescription
vecReadonlyFloat64ArrayThe new post-projection translation, in pixels.

Returns​

this

This projection, after it has been changed.