Class Waypoint

Model that represents a waypoint. It includes its coordinate, building location, floor location, and more.

Since

2.0.0

Hierarchy

  • Waypoint

Constructors

  • Designated Constructor.

    Parameters

    • featureId: string

      The unique identifer of the waypoint. The uid is expected to have a format of waypointname_type_b9_f9_9.

    • location: LatLng

      The coordinate of the waypoint.

    • floor: BaseMapBuildingFloor

    Returns Waypoint

Methods

  • Compare objects for equality

    Parameters

    Returns boolean

    true if these objects are equal

  • Returns Feature<Geometry, {
        [name: string]: any;
    }>

  • Returns string

  • Returns string

  • Returns boolean

  • Returns Feature<Point, {
        [name: string]: any;
    }>

  • Returns string

    The name of the waypoint.

  • Returns string

  • For example, a hallway waypoint is NOT a destination type.

    Returns boolean

    true if this waypoint is a destination.

  • Returns boolean

    true if waypoint type is elevator

  • Parameters

    Returns boolean

  • Returns boolean

    true if waypoint type is an exit

  • Returns boolean

    true if waypoint type is stairs

  • Whether or not the waypoint is traversible (i.e. A banquet room that can be used to get from point A to point B. However, we would rather use the hallway outside instead of going through this room. Therefore, this room would not be traversible.

    Returns boolean

    true if this waypoint can be traversed

  • Returns boolean

  • Returns Map<any, any>

    a JSON object representation of this object

    Since

    2.0.0

  • Returns string

    a JSON string representation of this object

    Since

    2.0.0

  • Returns string

    A string representation of this object

Properties

building: string

The building Id the waypoint is in.

canBeAutolabeled: boolean = true

true if this waypoint can be autolabeled.

description: string = ''

The display name of the waypoint (i.e. Men’s Bathroom).

floor: string

The key for the MapFloor that the waypoint is on.

floorNumber: number

The floor number that the waypoint is on.

id: string
isDoNotDescribe: boolean = false

true if the waypoint should be described. Some waypoints don’t add value when describing the path, such as those that are in the middle of a straight line.

location: LatLng

The map floor that this waypoint is on

Since

2.0.0

namesake?: Waypoint

Waypoint this one is named after.

Since

2.0.0

publicDescription: string = ''

The display name of the waypoint (i.e. Men’s Bathroom).

sequence?: number

This is used for elevators and stairs. Elevator waypoints, which are located on different floors, will have the same sequence number so they can be connected accordingly.

NOTE: Elevators will have the same sequence number as other elevators on different floors and is used to link them together

Returns

The sequence number of a waypoint.

triaged: boolean = false

True if this waypoint was processed during the auto-labeling process

The type of waypoint (i.e. Amenity, Room, etc.).

waypointPosition: WaypointPosition = WaypointPosition.UNKNOWN

The position of the waypoint (e.g. whether or not it’s indoors or outdoors).

Generated using TypeDoc