MPPoint is a representation of latitude and longitude coordinates packaged with a Z-axis representation in floorIndex.

Export

Hierarchy

Constructors

  • Creates an instance of MPPoint.

    Parameters

    • latitude: number

      The position of the point on the latitudal axis (N/S).

    • longitude: number

      The position of the point on the longitudal axis (E/W).

    • Optional floorIndex: number = 0

      The floor index of the point, Will default to 0 if not provided.

    Returns MPPoint

Properties

floorIndex?: number

Optional index that defines what floor this point is placed on.

If 0 it is placed on the ground floor, or outside.

latitude: number

Latitude coordinate.

longitude: number

Longitude coordinate.

multiPolygon: string = "MultiPolygon"

Typename for MPMultiPolygon.

Static

point: string = "Point"

Typename for MPPoint.

Static

polygon: string = "Polygon"

Typename for MPPolygon.

Static

Accessors

  • get type(): string
  • Get the type of the point. see MPGeometry#point.

    Returns string

Methods

  • Calculates the angle between this point and another [MPPoint] in degrees from north.

    Parameters

    Returns Promise<number>

    Async

  • Calculates the shortest distance to another point from this point.

    Parameters

    Returns Promise<number>

    Async

Generated using TypeDoc