VMWayfindingMap

@objcMembers
public class VMWayfindingMap : VMMSMap

Intializers

  • Declaration

    Swift

    public override init()

Method Overrides

Public Methods

  • Finds shortest waypath between two waypoints using the Dijkstra algorithm. @param start The starting waypoint. @param end The ending waypoint. @param options Options to use while determining waypath such as whether or not to use stairs or elevators. @param wayfindingDelegate a VMMSWayfindingDelegate object to notify with the results

    Declaration

    Swift

    public func findWaypathBetweenWaypointsStart(_ start: VMMSWaypoint?,
                                             end: VMMSWaypoint?,
                                             with options: VMMSWayfindingOptions,
                                             delegate wayfindingDelegate: VMMSWayfindingDelegate?)

  • Creates turn by turn text directions for a given waypath.

    @param waypath The waypath to create text directions for. @param info A VMMSCustomMapInfo object that contains custom information for directions. @param options Options to use when creating directions.

    Declaration

    Swift

    public func createTurnByTurnDirections(for waypath: VMMSWaypath,
                                       with info: VMMSCustomMapInfo?,
                                       andOptions options: VMMSTurnByTurnDirectionOptions,
                                       delegate wayfindingDelegate: VMMSWayfindingDelegate?)

  • Iterates through buildings and floors until it finds a waypoint with the given ID. @param uid The UID to look for when iterating. @return The waypoint that is found or nil if one is not found for the given ID.

    Declaration

    Swift

    public func findWaypoint(id uid: String) -> VMMSWaypoint?

  • Iterates through buildings and floors until it finds a waypoint with the given ID. @param uid The UID to look for when iterating. @return The waypoint that is found or nil if one is not found for the given ID.

    Declaration

    Swift

    public func findOutdoorWaypoint(id uid: String) -> VMMSWaypoint?

  • Declaration

    Swift

    public func findClosestWaypoint(_ location: CLLocationCoordinate2D, onFloor floorId: String,
                                fromBuildingList buildings: [VMWayfindingBaseBuilding]) -> VMMSWaypoint?

  • Finds the closest waypoint on the given indoor floor nearest to the given location

    @param location the target location @param floorId the uid of the floor to check @return the closest waypoint, or nil if nothing is close

    Since

    1.1

    Declaration

    Swift

    public func findClosestWaypoint(_ location: CLLocationCoordinate2D, onFloor floorId: String) -> VMMSWaypoint?

  • Finds the closest waypoint outdoors nearest to the given location

    @param location the target location @param floorId the uid of the floor to check @return the closest waypoint, or nil if nothing is close

    Since

    1.1

    Declaration

    Swift

    public func findClosestOutdoorWaypoint(_ location: CLLocationCoordinate2D, onFloor floorId: String) -> VMMSWaypoint?

  • : nodoc: Updates floor graph for a Outdoor Building. @param building an outdoor building

    Declaration

    Swift

    public func updateGraph(forOutdoorBuilding building: VMWayfindingBaseBuilding)

  • Connects the floors for all buildings in the dijkstra graph. @param connectElevators BOOL to connect elevators. @param connectStairs BOOL to connect stairs.

    Declaration

    Swift

    public func connectFloorsInAllBuildingsForElevators(connectElevators: Bool, andStairs connectStairs: Bool)

  • Connects the floors for a particular building @param waypoints All waypoints located in a building.

    Declaration

    Swift

    public func connectFloorsInBuilding(waypoints: [VMMSWaypoint])

  • Connects the floors for outdoor and Indoor buildings @param waypoints All waypoints located in a building.

    Declaration

    Swift

    public func connectFloorsInBetweenBuildings(waypoints: [VMMSWaypoint])

  • Gets the keys for elevators and stairs.

    Declaration

    Swift

    public func getKeysForElevatorsAndStairs()

  • Gets exit waypoints in all buildings. @return The array of waypoints that are exits.

    Declaration

    Swift

    public func getExitsForAllBuildings() -> [VMMSWaypoint]