Class: GeoPointReadOnly

Defined in: src/sdk/geo/GeoPoint.ts:156

A read-only wrapper for a GeoPoint.

Implements

• GeoPointInterface
• LatLonInterface

Constructors

Constructor

new GeoPointReadOnly(source): GeoPointReadOnly

Defined in: src/sdk/geo/GeoPoint.ts:161

Constructor.

Parameters

Parameter	Type	Description
source	GeoPoint	the source of the new read-only point.

Returns

GeoPointReadOnly

Accessors

lat

Get Signature

get lat(): number

Defined in: src/sdk/geo/GeoPoint.ts:168

The latitude of this point, in degrees.

Returns

number

the latitude of this point.

The latitude of the point.

Implementation of

LatLonInterface.lat

---

lon

Get Signature

get lon(): number

Defined in: src/sdk/geo/GeoPoint.ts:176

The longitude of this point, in degrees.

Returns

number

the longitude of this point.

The longitude of the point.

Implementation of

LatLonInterface.lon

Methods

antipode()

antipode(out?): GeoPoint

Defined in: src/sdk/geo/GeoPoint.ts:281

Gets the antipode of this point.

Parameters

Parameter	Type	Description
out?	GeoPoint	The GeoPoint ot which to write the result.

Returns

GeoPoint

The antipode of this point.

Throws

Error if argument out is undefined.

Implementation of

GeoPointInterface.antipode

---

bearingFrom()

Call Signature

bearingFrom(other): number

Defined in: src/sdk/geo/GeoPoint.ts:220

Calculates the final true bearing from another point to this point (i.e. the back azimuth from this point to the other point) along the great circle connecting the two.

Parameters

Parameter	Type	Description
other	LatLonInterface	The other point.

Returns

number

The final true bearing from the other point, in degrees.

Implementation of

GeoPointInterface.bearingFrom

Call Signature

bearingFrom(lat, lon): number

Defined in: src/sdk/geo/GeoPoint.ts:222

Calculates the final true bearing from another point to this point (i.e. the back azimuth from this point to the other point) along the great circle connecting the two.

Parameters

Parameter	Type	Description
lat	number	The latitude of the other point, in degrees.
lon	number	The longitude of the other point, in degrees.

Returns

number

The final true bearing from the other point, in degrees.

Implementation of

GeoPointInterface.bearingFrom

---

bearingRhumb()

Call Signature

bearingRhumb(other): number

Defined in: src/sdk/geo/GeoPoint.ts:233

Calculates the constant true bearing from this point to another point along the rhumb line connecting the two.

Parameters

Parameter	Type	Description
other	LatLonInterface	The other point.

Returns

number

The constant true bearing to the other point, in degrees.

Implementation of

GeoPointInterface.bearingRhumb

Call Signature

bearingRhumb(lat, lon): number

Defined in: src/sdk/geo/GeoPoint.ts:235

Calculates the constant true bearing from this point to another point along the rhumb line connecting the two.

Parameters

Parameter	Type	Description
lat	number	The latitude of the other point, in degrees.
lon	number	The longitude of the other point, in degrees.

Returns

number

The constant true bearing to the other point, in degrees.

Implementation of

GeoPointInterface.bearingRhumb

---

bearingTo()

Call Signature

bearingTo(other): number

Defined in: src/sdk/geo/GeoPoint.ts:207

Calculates the initial true bearing (forward azimuth) from this point to another point along the great circle connecting the two.

Parameters

Parameter	Type	Description
other	LatLonInterface	The other point.

Returns

number

The initial true bearing to the other point, in degrees.

Implementation of

GeoPointInterface.bearingTo

Call Signature

bearingTo(lat, lon): number

Defined in: src/sdk/geo/GeoPoint.ts:209

Calculates the initial true bearing (forward azimuth) from this point to another point along the great circle connecting the two.

Parameters

Parameter	Type	Description
lat	number	The latitude of the other point, in degrees.
lon	number	The longitude of the other point, in degrees.

Returns

number

The initial true bearing to the other point, in degrees.

Implementation of

GeoPointInterface.bearingTo

---

copy()

copy(to?): GeoPoint

Defined in: src/sdk/geo/GeoPoint.ts:313

Copies this point.

Parameters

Parameter	Type	Description
to?	GeoPoint	An optional point to which to copy this point. If this argument is not supplied, a new GeoPoint object will be created.

Returns

GeoPoint

A copy of this point.

Implementation of

GeoPointInterface.copy

---

distance()

Call Signature

distance(other): number

Defined in: src/sdk/geo/GeoPoint.ts:181

Calculates the great-circle distance between this point and another point.

Parameters

Parameter	Type	Description
other	LatLonInterface	The point to which to calculate the distance.

Returns

number

The great-circle distance to the other point, in great-arc radians.

Implementation of

GeoPointInterface.distance

Call Signature

distance(lat, lon): number

Defined in: src/sdk/geo/GeoPoint.ts:183

Calculates the great-circle distance between this point and another point.

Parameters

Parameter	Type	Description
lat	number	The latitude of the point to which to calculate the distance.
lon	number	The longitude of the point to which to calculate the distance.

Returns

number

The great-circle distance to the other point, in great-arc radians.

Implementation of

GeoPointInterface.distance

---

distanceRhumb()

Call Signature

distanceRhumb(other): number

Defined in: src/sdk/geo/GeoPoint.ts:194

Calculates the distance along the rhumb line connecting this point with another point.

Parameters

Parameter	Type	Description
other	LatLonInterface	The other point.

Returns

number

The rhumb-line distance to the other point, in great-arc radians.

Implementation of

GeoPointInterface.distanceRhumb

Call Signature

distanceRhumb(lat, lon): number

Defined in: src/sdk/geo/GeoPoint.ts:196

Calculates the distance along the rhumb line connecting this point with another point.

Parameters

Parameter	Type	Description
lat	number	The latitude of the other point, in degrees.
lon	number	The longitude of the other point, in degrees.

Returns

number

The rhumb-line distance to the other point, in great-arc radians.

Implementation of

GeoPointInterface.distanceRhumb

---

equals()

Call Signature

equals(other, tolerance?): boolean

Defined in: src/sdk/geo/GeoPoint.ts:300

Checks whether this point is equal to another point. Two points are considered equal if and only if the great- circle distance between them is less than or equal to a specified tolerance or if the latitude and longitude components of both points are equal to NaN.

Parameters

Parameter	Type	Description
other	LatLonInterface	The other point.
tolerance?	number	The tolerance of the equality check, defined as the maximum allowed distance between two equal points in great-arc radians.

Returns

boolean

Whether this point is equal to the other point.

Implementation of

GeoPointInterface.equals

Call Signature

equals(lat, lon, tolerance?): boolean

Defined in: src/sdk/geo/GeoPoint.ts:302

Checks whether this point is equal to another point. Two points are considered equal if and only if the great- circle distance between them is less than or equal to a specified tolerance or if the latitude and longitude components of both points are equal to NaN.

Parameters

Parameter	Type	Description
lat	number	The latitude of the other point, in degrees.
lon	number	The longitude of the other point, in degrees.
tolerance?	number	The tolerance of the equality check, defined as the maximum allowed distance between two equal points in great-arc radians.

Returns

boolean

Whether this point is equal to the other point.

Implementation of

GeoPointInterface.equals

---

offset()

offset(bearing, distance, out?): GeoPoint

Defined in: src/sdk/geo/GeoPoint.ts:253

Offsets this point by an initial bearing and distance along a great circle.

Parameters

Parameter	Type	Description
bearing	number	The initial true bearing (forward azimuth), in degrees, by which to offset.
distance	number	The distance, in great-arc radians, by which to offset.
out?	GeoPoint	The GeoPoint to which to write the result. If not supplied, a new GeoPoint object is created.

Returns

GeoPoint

The offset point.

Throws

Error if argument out is undefined.

Implementation of

GeoPointInterface.offset

---

offsetRhumb()

offsetRhumb(bearing, distance, out?): GeoPoint

Defined in: src/sdk/geo/GeoPoint.ts:268

Offsets this point by a constant bearing and distance along a rhumb line.

Parameters

Parameter	Type	Description
bearing	number	The true bearing, in degrees, by which to offset.
distance	number	The distance, in great-arc radians, by which to offset.
out?	GeoPoint	The GeoPoint to which to write the result. If not supplied, a new GeoPoint object is created.

Returns

GeoPoint

The offset point.

Throws

Error if argument out is undefined.

Implementation of

GeoPointInterface.offsetRhumb

---

toCartesian()

toCartesian(out): Float64Array

Defined in: src/sdk/geo/GeoPoint.ts:295

Calculates the cartesian (x, y, z) representation of this point, in units of great-arc radians. By convention, in the cartesian coordinate system the origin is at the center of the Earth, the positive x-axis passes through 0 degrees N, 0 degrees E, and the positive z-axis passes through the north pole.

Parameters

Parameter	Type	Description
out	Float64Array	The vector array to which to write the result.

Returns

Float64Array

The cartesian representation of this point.

Implementation of

GeoPointInterface.toCartesian