Class GeographicalPosition

Geographical WGS 84 position stored as an 3D vector in ISO 6709.

Hierarchy (View Summary)

Absolute3DPosition
- GeographicalPosition

Index

Constructors

constructor

new GeographicalPosition(
    lat?: number,
    lng?: number,
    amsl?: number,
    gcs?: GCS,
): GeographicalPosition
Parameters
- Optionallat: number
- Optionallng: number
- Optionalamsl: number
- gcs: GCS = GCS.WGS84
Returns GeographicalPosition
Overrides Absolute3DPosition.constructor
- Defined in src/data/position/GeographicalPosition.ts:13

Properties

orientation

orientation: Orientation

Orientation at recorded position

referenceSpaceUID

referenceSpaceUID: string

Position reference space UID

timestamp

timestamp: number = ...

Position recording timestamp

unit

unit: LengthUnit = LengthUnit.METER

Position unit

`Protected`vector

vector: Vector3 = ...

velocity

velocity: Velocity = ...

Velocity at recorded position

Accessors

accuracy

get accuracy(): Accuracy<LengthUnit, any>
Position accuracy

Returns Accuracy<LengthUnit, any>
Position accuracy
Inherited from Absolute3DPosition.accuracy
- Defined in src/data/position/AbsolutePosition.ts:82
set accuracy(value: Accuracy<LengthUnit, any>): void
Position accuracy
Parameters
- value: Accuracy<LengthUnit, any>
Returns void
Inherited from Absolute3DPosition.accuracy
- Defined in src/data/position/AbsolutePosition.ts:89

altitude

get altitude(): number
Altitude above mean sea level

Returns number
Altitude
- Defined in src/data/position/GeographicalPosition.ts:46
set altitude(amsl: number): void
Parameters
- amsl: number
Returns void
- Defined in src/data/position/GeographicalPosition.ts:50

angularVelocity

get angularVelocity(): AngularVelocity
Get the angular velocity

Returns AngularVelocity
Angular velocity
Inherited from Absolute3DPosition.angularVelocity
- Defined in src/data/position/AbsolutePosition.ts:121
set angularVelocity(value: AngularVelocity): void
Set the angular velocity
Parameters
- value: AngularVelocity
Returns void
Inherited from Absolute3DPosition.angularVelocity
- Defined in src/data/position/AbsolutePosition.ts:131

latitude

get latitude(): number
Geographical Latitude

Returns number
Latitude
- Defined in src/data/position/GeographicalPosition.ts:22
set latitude(lat: number): void
Parameters
- lat: number
Returns void
- Defined in src/data/position/GeographicalPosition.ts:26

linearVelocity

get linearVelocity(): LinearVelocity
Get the linear velocity

Returns LinearVelocity
Linear velocity
Inherited from Absolute3DPosition.linearVelocity
- Defined in src/data/position/AbsolutePosition.ts:100
set linearVelocity(value: LinearVelocity): void
Set the linear velocity
Parameters
- value: LinearVelocity
Returns void
Inherited from Absolute3DPosition.linearVelocity
- Defined in src/data/position/AbsolutePosition.ts:110

longitude

get longitude(): number
Geographical Longitude

Returns number
Longitude
- Defined in src/data/position/GeographicalPosition.ts:34
set longitude(lng: number): void
Parameters
- lng: number
Returns void
- Defined in src/data/position/GeographicalPosition.ts:38

probability

get probability(): number
Get the position probability

Returns number
Probability between 0 and 1
Inherited from Absolute3DPosition.probability
- Defined in src/data/position/AbsolutePosition.ts:64
set probability(value: number): void
Position probability
Parameters
- value: number
Returns void
Inherited from Absolute3DPosition.probability
- Defined in src/data/position/AbsolutePosition.ts:71

x

get x(): number
Returns number
Inherited from Absolute3DPosition.x
- Defined in src/data/position/Absolute2DPosition.ts:25
set x(value: number): void
Parameters
- value: number
Returns void
Inherited from Absolute3DPosition.x
- Defined in src/data/position/Absolute2DPosition.ts:32

y

get y(): number
Returns number
Inherited from Absolute3DPosition.y
- Defined in src/data/position/Absolute2DPosition.ts:42
set y(value: number): void
Parameters
- value: number
Returns void
Inherited from Absolute3DPosition.y
- Defined in src/data/position/Absolute2DPosition.ts:49

z

get z(): number
Returns number
Inherited from Absolute3DPosition.z
- Defined in src/data/position/Absolute3DPosition.ts:20
set z(value: number): void
Parameters
- value: number
Returns void
Inherited from Absolute3DPosition.z
- Defined in src/data/position/Absolute3DPosition.ts:27

Methods

angleTo

angleTo(destination: GeographicalPosition): number
Get the bearing in radians from this location to a destination
Parameters
- destination: GeographicalPosition
  Destination location
Returns number
Bearing in radians from this position to destination
Overrides Absolute3DPosition.angleTo
- Defined in src/data/position/GeographicalPosition.ts:77

bearing

bearing(destination: GeographicalPosition): number
Get the bearing in degrees from this location to a destination
Parameters
- destination: GeographicalPosition
  Destination location
Returns number
Bearing in degrees from this position to destination
- Defined in src/data/position/GeographicalPosition.ts:68

clone

clone(): this
Clone the position

Returns this
Cloned geographical position
Overrides Absolute3DPosition.clone
- Defined in src/data/position/GeographicalPosition.ts:171

destination

destination(
    bearing: number,
    distance: number,
    bearingUnit?: AngleUnit,
    distanceUnit?: LengthUnit,
): GeographicalPosition
Parameters
- bearing: number
- distance: number
- bearingUnit: AngleUnit = AngleUnit.DEGREE
- distanceUnit: LengthUnit = LengthUnit.METER
Returns GeographicalPosition
- Defined in src/data/position/GeographicalPosition.ts:88

distanceTo

distanceTo(destination: GeographicalPosition): number
Get the distance from this location to a destination
Parameters
- destination: GeographicalPosition
  Destination location
Returns number
Distance between this point and destination
Overrides Absolute3DPosition.distanceTo
- Defined in src/data/position/GeographicalPosition.ts:59

equals

equals(position: this): boolean
Check if this position equals another position
Parameters
- position: this
  Other position
Returns boolean
Inherited from Absolute3DPosition.equals
- Defined in src/data/position/AbsolutePosition.ts:184

fromVector

fromVector(vector: Vector3, unit?: LengthUnit): this
Parameters
- vector: Vector3
- Optionalunit: LengthUnit
Returns this
Overrides Absolute3DPosition.fromVector
- Defined in src/data/position/GeographicalPosition.ts:117
fromVector(vector: Vector3, unit?: GCS): this
Parameters
- vector: Vector3
- Optionalunit: GCS
Returns this
Overrides Absolute3DPosition.fromVector
- Defined in src/data/position/GeographicalPosition.ts:118

setAccuracy

setAccuracy(accuracy: number | Accuracy<LengthUnit, any>, unit?: Unit): this
Set the accuracy of the absolute position
Parameters
- accuracy: number | Accuracy<LengthUnit, any>
  Accuracy object or number
- Optionalunit: Unit
  Optional unit
Returns this
instance
Inherited from Absolute3DPosition.setAccuracy
- Defined in src/data/position/AbsolutePosition.ts:154

setOrientation

setOrientation(orientation: Orientation): this
Set the orientation of the position
Parameters
- orientation: Orientation
  orientation
Returns this
instance
Inherited from Absolute3DPosition.setOrientation
- Defined in src/data/position/AbsolutePosition.ts:143

toVector3

toVector3(unit?: LengthUnit): Vector3
Convert the geographical position to a vector with geographical coordinate system ECEF.
Parameters
- Optionalunit: LengthUnit
  Metric length unit
Returns Vector3
Vector of the position
Overrides Absolute3DPosition.toVector3
- Defined in src/data/position/GeographicalPosition.ts:145
toVector3(unit?: GCS): Vector3
Convert the geographical position to a vector
Parameters
- Optionalunit: GCS
  coordinate system
Returns Vector3
Vector of the position
Overrides Absolute3DPosition.toVector3
- Defined in src/data/position/GeographicalPosition.ts:151

Class GeographicalPosition

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GeographicalPosition

Properties

orientation

referenceSpaceUID

timestamp

unit

Protectedvector

velocity

Accessors

accuracy

Returns Accuracy<LengthUnit, any>

Parameters

Returns void

altitude

Returns number

Parameters

Returns void

angularVelocity

Returns AngularVelocity

Parameters

Returns void

latitude

Returns number

Parameters

Returns void

linearVelocity

Returns LinearVelocity

Parameters

Returns void

longitude

Returns number

Parameters

Returns void

probability

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

z

Returns number

Parameters

Returns void

Methods

angleTo

Parameters

Returns number

bearing

Parameters

Returns number

clone

Returns this

destination

Parameters

Returns GeographicalPosition

distanceTo

Parameters

Returns number

equals

Parameters

Returns boolean

fromVector

Parameters

Returns this

`Protected`vector