Interface: GeoPointInterface
A representation of a point on Earth's surface.
Implemented by
Properties
lat
• lat: number
The latitude of the point.
Defined in
src/sdk/geo/GeoPoint.ts:9
lon
• lon: number
The longitude of the point.
Defined in
src/sdk/geo/GeoPoint.ts:12
Methods
antipode
▸ antipode(out?): GeoPoint
Gets the antipode of this point.
Parameters
| Name | Type | Description |
|---|---|---|
out? | GeoPoint | The GeoPoint to which to write the result. |
Returns
The antipode of this point.
Defined in
src/sdk/geo/GeoPoint.ts:111
bearingFrom
▸ bearingFrom(other): number
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
| Name | Type | Description |
|---|---|---|
other | LatLonInterface | The other point. |
Returns
number
The final true bearing from the other point, in degrees.
Defined in
src/sdk/geo/GeoPoint.ts:64
▸ bearingFrom(lat, lon): number
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
| Name | 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.
Defined in
src/sdk/geo/GeoPoint.ts:72
bearingRhumb
▸ bearingRhumb(other): number
Calculates the constant true bearing from this point to another point along the rhumb line connecting the two.
Parameters
| Name | Type | Description |
|---|---|---|
other | LatLonInterface | The other point. |
Returns
number
The constant true bearing to the other point, in degrees.
Defined in
src/sdk/geo/GeoPoint.ts:79
▸ bearingRhumb(lat, lon): number
Calculates the constant true bearing from this point to another point along the rhumb line connecting the two.
Parameters
| Name | 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.
Defined in
src/sdk/geo/GeoPoint.ts:86
bearingTo
▸ bearingTo(other): number
Calculates the initial true bearing (forward azimuth) from this point to another point along the great circle connecting the two.
Parameters
| Name | Type | Description |
|---|---|---|
other | LatLonInterface | The other point. |
Returns
number
The initial true bearing to the other point, in degrees.
Defined in
src/sdk/geo/GeoPoint.ts:48
▸ bearingTo(lat, lon): number
Calculates the initial true bearing (forward azimuth) from this point to another point along the great circle connecting the two.
Parameters
| Name | 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.
Defined in
src/sdk/geo/GeoPoint.ts:56
copy
▸ copy(to?): GeoPoint
Copies this point.
Parameters
| Name | 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
A copy of this point.
Defined in
src/sdk/geo/GeoPoint.ts:150
distance
▸ distance(other): number
Calculates the great-circle distance between this point and another point.
Parameters
| Name | 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.
Defined in
src/sdk/geo/GeoPoint.ts:19
▸ distance(lat, lon): number
Calculates the great-circle distance between this point and another point.
Parameters
| Name | 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.
Defined in
src/sdk/geo/GeoPoint.ts:26
distanceRhumb
▸ distanceRhumb(other): number
Calculates the distance along the rhumb line connecting this point with another point.
Parameters
| Name | Type | Description |
|---|---|---|
other | LatLonInterface | The other point. |
Returns
number
The rhumb-line distance to the other point, in great-arc radians.
Defined in
src/sdk/geo/GeoPoint.ts:33
▸ distanceRhumb(lat, lon): number
Calculates the distance along the rhumb line connecting this point with another point.
Parameters
| Name | 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.
Defined in
src/sdk/geo/GeoPoint.ts:40
equals
▸ equals(other, tolerance?): boolean
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
| Name | 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.
Defined in
src/sdk/geo/GeoPoint.ts:131
▸ equals(lat, lon, tolerance?): boolean
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
| Name | 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.
Defined in
src/sdk/geo/GeoPoint.ts:142
offset
▸ offset(bearing, distance, out?): GeoPoint
Offsets this point by an initial bearing and distance along a great circle.
Parameters
| Name | 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. |
Returns
The offset point.
Defined in
src/sdk/geo/GeoPoint.ts:95
offsetRhumb
▸ offsetRhumb(bearing, distance, out?): GeoPoint
Offsets this point by a constant bearing and distance along a rhumb line.
Parameters
| Name | 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. |
Returns
The offset point.
Defined in
src/sdk/geo/GeoPoint.ts:104
toCartesian
▸ toCartesian(out): Float64Array
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
| Name | Type | Description |
|---|---|---|
out | Float64Array | The vector array to which to write the result. |
Returns
Float64Array
The cartesian representation of this point.
Defined in
src/sdk/geo/GeoPoint.ts:120