Class PathMetadata

This class represents the different additional data about individual path sections in a Waypath.

Since

2.0.0

Hierarchy

  • PathMetadata

Constructors

  • Designated constructor

    Parameters

    • waypointOne: Waypoint

      the first waypoint

    • waypointTwo: Waypoint

      the last waypoint

    • description: string = ''

      General description for the path.

    • descriptionOne: string = ''

      Directional description when going from point one to point two.

    • descriptionTwo: string = ''

      Directional description when going from point two to point one.

    Returns PathMetadata

Methods

  • Returns string

    the general description of this path, regardless of direction

  • Returns string

    the description of this path from the first waypoint to the last waypoint

  • Returns string

    the description of this path from the last waypoint to the first waypoint

  • Returns string

    the general description of this path, regardless of direction

  • Returns number

    the heading of this path (in DEGREES)

  • Returns number

    the distance of this path (in METERS)

  • Returns string

    the path id

  • Returns Waypoint

    a single point of focus for this path, such a nearby landmark

  • Returns boolean

    true if the path can be autolabeled by the algorithm, false otherwise

  • Parameters

    • canBeAutolabeled: boolean

      true if the path can be autolabeled by the algorithm, false otherwise

    Returns void

  • Parameters

    • description: string

      the general description of this path, regardless of direction

    Returns void

  • Parameters

    • descriptionOne: string

      the description of this path from the first waypoint to the last waypoint

    Returns void

  • Parameters

    • descriptionTwo: string

      the description of this path from the last waypoint to the first waypoint

    Returns void

  • Parameters

    • directionalDescription: string

      the general description of this path, regardless of direction

    Returns void

  • Parameters

    • labeledBy: IPathLabeler

      the labeler that created the path's descritpion, if any

    Returns void

  • Parameters

    • pathId: string

      the path id

    Returns void

  • Parameters

    • pointOfFocus: Waypoint

      a single point of focus for this path, such a nearby landmark

    Returns void

  • Returns string

    a String representation of this object

Properties

calculatedHeading: number = 0
calculatedPathDistance?: number
canBeAutolabeled: boolean = false
description: string
descriptionOne: string
descriptionTwo: string
directionalDescription: string
hasCalculatedHeading: boolean = false
hasCalculatedPathDistance: boolean = false
labeledBy?: IPathLabeler
pathId: string
pointOfFocus?: Waypoint

Generated using TypeDoc