Class GeographicalPosition
Hierarchy-Diagram
Legend
class
Hierarchy
- Absolute3DPosition
- GeographicalPosition
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Geographical Position(lat?: number, lng?: number, amsl?: number): GeographicalPosition -
Parameters
-
Optionallat: number -
Optionallng: number -
Optionalamsl: number
Returns GeographicalPosition
-
Properties
orientation
Orientation at recorded position
reference
Position reference space UID
timestamp
Position recording timestamp
unit
Position unit
Protected vector
velocity
Velocity at recorded position
Accessors
accuracy
- get accuracy(): Accuracy<LengthUnit, any>
-
Position accuracy
Returns
Position accuracy
Returns Accuracy<LengthUnit, any>
- set accuracy(value: Accuracy<LengthUnit, any>): void
-
Position accuracy
Parameters
-
value: Accuracy<LengthUnit, any>
Returns void
-
altitude
- get altitude(): number
-
Altitude above mean sea level
Returns
Altitude
Returns number
- set altitude(amsl: number): void
-
Parameters
-
amsl: number
Returns void
-
angular
- get angularVelocity(): AngularVelocity
-
Get the angular velocity
Returns
Angular velocity
Returns AngularVelocity
- set angularVelocity(value: AngularVelocity): void
-
Set the angular velocity
Parameters
-
value: AngularVelocity
Returns void
-
latitude
- get latitude(): number
-
Geographical Latitude
Returns
Latitude
Returns number
- set latitude(lat: number): void
-
Parameters
-
lat: number
Returns void
-
linear
- get linearVelocity(): LinearVelocity
-
Get the linear velocity
Returns
Linear velocity
Returns LinearVelocity
- set linearVelocity(value: LinearVelocity): void
-
Set the linear velocity
Parameters
-
value: LinearVelocity
Returns void
-
longitude
- get longitude(): number
-
Geographical Longitude
Returns
Longitude
Returns number
- set longitude(lng: number): void
-
Parameters
-
lng: number
Returns void
-
probability
- get probability(): number
-
Get the position probability
Returns
Probability between 0 and 1
Returns number
- set probability(value: number): void
-
Position probability
Parameters
-
value: number
Returns void
-
x
- get x(): number
-
Returns number
- set x(value: number): void
-
Parameters
-
value: number
Returns void
-
y
- get y(): number
-
Returns number
- set y(value: number): void
-
Parameters
-
value: number
Returns void
-
z
- get z(): number
-
Returns number
- set z(value: number): void
-
Parameters
-
value: number
Returns void
-
Methods
angle
- angle
To(destination: GeographicalPosition): number -
Get the bearing in radians from this location to a destination
Returns
Bearing in radians from this position to destination
Parameters
-
destination: GeographicalPosition
Destination location
Returns number
-
bearing
- bearing(destination: GeographicalPosition): number
-
Get the bearing in degrees from this location to a destination
Returns
Bearing in degrees from this position to destination
Parameters
-
destination: GeographicalPosition
Destination location
Returns number
-
clone
- clone(): GeographicalPosition
-
Clone the position
Returns
Cloned geographical position
Returns GeographicalPosition
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
-
distance
- distance
To(destination: GeographicalPosition): number -
Get the distance from this location to a destination
Returns
Distance between this point and destination
Parameters
-
destination: GeographicalPosition
Destination location
Returns number
-
equals
- equals(position: GeographicalPosition): boolean
-
Check if this position equals another position
Parameters
-
position: GeographicalPosition
Other position
Returns boolean
-
from
- from
Vector(vector: Vector3, unit?: LengthUnit): GeographicalPosition -
Parameters
-
vector: Vector3
-
Optionalunit: LengthUnit
Returns GeographicalPosition
-
- from
Vector(vector: Vector3, unit?: GCS): GeographicalPosition -
Returns GeographicalPosition
set
- set
Accuracy(accuracy: number | Accuracy<LengthUnit, any>, unit?: Unit): GeographicalPosition -
Set the accuracy of the absolute position
Returns
instance
Parameters
-
accuracy: number | Accuracy<LengthUnit, any>
Accuracy object or number
-
Optionalunit: UnitOptional unit
Returns GeographicalPosition
-
to
- to
Vector3(unit?: LengthUnit): Vector3 -
Convert the geographical position to a vector with geographical coordinate system ECEF.
Returns
Vector of the position
Parameters
-
Optionalunit: LengthUnitMetric length unit
Returns Vector3
-
- to
Vector3(unit?: GCS): Vector3 -
Convert the geographical position to a vector
Returns
Vector of the position
Parameters
-
Optionalunit: GCScoordinate system
Returns Vector3
-
Geographical WGS 84 position stored as an 3D vector in ISO 6709.