VMMSMap

@interface VMMSMap

Class that loads data from VMD file, finds waypaths, and labels waypoints. This is the top level class that encapsulates all data for the venue.

Since

1.0

Initializers

  • Designated initializer.

    Declaration

    Swift

    - (instancetype)initWithDelegate:(id<VMMSMapDelegate>)mapDelegate;

    Parameters

    mapDelegate

    An object that has implemented VMMSMapDelegate protocol and its required/optional methods.

    Return Value

    an instance of VMMSMap.

Public Methods

  • Loads vmd file.

    Since

    1.1

    Declaration

    Swift

    + (void)loadFromCollection:(VMDFileCollection *)vmdFileCollection
                  delegate:(id<VMMSMapDelegate>)delegate;

    Parameters

    vmdFileCollection

    A collection of VMD files
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.

  • Loads vmd file

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)load:(id)absolutePath delegate:(id<VMMSMapDelegate>)delegate;

    Parameters

    absolutePath

    The absolute path of the vmd file.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.

  • Loads vmd file.

    Since

    1.1

    Declaration

    Swift

    + (void)loadFromCollection:(VMDFileCollection *)vmdFileCollection
                  delegate:(id<VMMSMapDelegate>)delegate
               withOptions:(VMMSWaypointLabelOptions *)options;

    Parameters

    vmdFileCollection

    A collection of VMD files
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    options

    Options to use for labeling waypoints.

  • Loads vmd file

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)load:(id)absolutePath
       delegate:(id<VMMSMapDelegate>)delegate
    withOptions:(VMMSWaypointLabelOptions *)options;

    Parameters

    absolutePath

    The absolute path of the vmd file.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    options

    Options to use for labeling waypoints.

  • Loads vmd file

    Since

    1.1

    Declaration

    Swift

    + (void)loadFromCollection:(VMDFileCollection *)vmdFileCollection
                  delegate:(id<VMMSMapDelegate>)delegate
               withOptions:(VMMSWaypointLabelOptions *)options
         excludeWayfinding:(id)excludeWayfinding;

    Parameters

    vmdFileCollection

    A collection of VMD files
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    options

    Options to use for labeling waypoints.
    excludeWayfinding

    Option to exclude parsing wayfinding data

  • Loads vmd file

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)load:(id)absolutePath
             delegate:(id<VMMSMapDelegate>)delegate
          withOptions:(VMMSWaypointLabelOptions *)options
    excludeWayfinding:(id)excludeWayfinding;

    Parameters

    absolutePath

    The absolute path of the vmd file.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    options

    Options to use for labeling waypoints.
    excludeWayfinding

    Option to exclude parsing wayfinding data

  • Loads vmd file

    Since

    1.1

    Declaration

    Swift

    + (void)loadFromCollection:(VMDFileCollection *)vmdFileCollection
                  delegate:(id<VMMSMapDelegate>)delegate
         excludeWayfinding:(id)excludeWayfinding;

    Parameters

    vmdFileCollection

    A collection of VMD files
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    excludeWayfinding

    Option to exclude parsing wayfinding data

  • Loads vmd file

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)load:(id)absolutePath
             delegate:(id<VMMSMapDelegate>)delegate
    excludeWayfinding:(id)excludeWayfinding;

    Parameters

    absolutePath

    The absolute path of the vmd file.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    excludeWayfinding

    Option to exclude parsing wayfinding data

  • Loads vmd file from a remote URL

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)loadFromURL:(id)url delegate:(id<VMMSMapDelegate>)delegate;

    Parameters

    url

    The url of the vmd file.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.

  • Loads vmd file from a remote URL

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)loadFromURL:(id)url
        withSession:(id)session
           delegate:(id<VMMSMapDelegate>)delegate;

    Parameters

    url

    The url of the vmd file.
    session

    An NSURLSession that controls how the vmd file is retrieved.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.

  • Loads vmd file from a remote URL

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)loadFromURL:(id)url
        withSession:(id)session
           delegate:(id<VMMSMapDelegate>)delegate
        withOptions:(VMMSWaypointLabelOptions *)options;

    Parameters

    url

    The url of the vmd file.
    session

    An NSURLSession that controls how the vmd file is retrieved.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    options

    Options to use for labeling waypoints.

  • Loads vmd file from a remote URL

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)loadFromURL:(id)url
           delegate:(id<VMMSMapDelegate>)delegate
        withOptions:(VMMSWaypointLabelOptions *)options;

    Parameters

    url

    The url of the vmd file.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    options

    Options to use for labeling waypoints.

  • Loads vmd file from a remote URL

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)loadFromURL:(id)url
          withSession:(id)session
             delegate:(id<VMMSMapDelegate>)delegate
          withOptions:(VMMSWaypointLabelOptions *)options
    excludeWayfinding:(id)excludeWayfinding;

    Parameters

    url

    The url of the vmd file.
    session

    An NSURLSession that controls how the vmd file is retrieved.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    options

    Options to use for labeling waypoints.
    excludeWayfinding

    Option to exclude parsing wayfinding data

  • Loads vmd file from a remote URL

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)loadFromURL:(id)url
          withSession:(id)session
             delegate:(id<VMMSMapDelegate>)delegate
    excludeWayfinding:(id)excludeWayfinding;

    Parameters

    url

    The url of the vmd file.
    session

    An NSURLSession that controls how the vmd file is retrieved.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    excludeWayfinding

    Option to exclude parsing wayfinding data

  • Loads vmd file from a remote URL

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)loadFromURL:(id)url
             delegate:(id<VMMSMapDelegate>)delegate
    excludeWayfinding:(id)excludeWayfinding;

    Parameters

    url

    The url of the vmd file.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    excludeWayfinding

    Option to exclude parsing wayfinding data

  • Loads vmd file from a remote URL

    Since

    1.0

    Warning

    Deprecated in 1.1

    Declaration

    Swift

    + (void)loadFromURL:(id)url
             delegate:(id<VMMSMapDelegate>)delegate
          withOptions:(VMMSWaypointLabelOptions *)options
    excludeWayfinding:(id)excludeWayfinding;

    Parameters

    url

    The url of the vmd file.
    delegate

    An object that implements the VMMSMapDelegate protocol and it’s required/optional methods.
    options

    Options to use for labeling waypoints.
    excludeWayfinding

    Option to exclude parsing wayfinding data

  • Finds shortest waypath between two waypoints using the Dijkstra algorithm.

    Since

    1.1

    Declaration

    Swift

    - (void)findWaypathBetweenWaypointsStart:(VMMSWaypoint *)start
                                     end:(VMMSWaypoint *)end
                             withOptions:(VMMSWayfindingOptions *)options
                                delegate:(id<VMMSWayfindingDelegate>)
                                             wayfindingDelegate;

    Parameters

    start

    The starting waypoint.
    end

    The ending waypoint.
    options

    Options to use while determining waypath such as whether or not to use stairs or elevators.
    wayfindingDelegate

    a VMMSWayfindingDelegate object to notify with the results

  • Finds shortest waypath between two waypoints using the Dijkstra algorithm.

    Since

    1.0

    Warning

    Deprecated in 1.1. Use findWaypathBetweenWaypointsStart:end:withOptions:delegate instead.

    Declaration

    Swift

    - (void)findWaypathBetweenWaypointsStart:(VMMSWaypoint *)start
                                     end:(VMMSWaypoint *)end
                             withOptions:(VMMSWayfindingOptions *)options;

    Parameters

    start

    The starting waypoint.
    end

    The ending waypoint.
    options

    Options to use while determining waypath such as whether or not to use stairs or elevators.

  • Adds a VMMSMapBuilding instance to a dictionary.

    Declaration

    Swift

    - (void)addBuilding:(VMMSMapBuilding *)building;

    Parameters

    building

    A VMMSMapBuilding

  • Adds a VMMSMapBuilding instance to a dictionary.

    Since

    1.1

    Declaration

    Swift

    - (void)addOutdoorBuilding:(VMMSMapOutdoorBuilding *)building;

    Parameters

    building

    A VMMSMapOutdoorBuilding

  • Checks to see if a building exists for a given id and returns it if so

    Declaration

    Swift

    - (VMMSMapBuilding *)getBuildingWithId:(id)uid;

    Parameters

    uid

    The id (key) for the building

    Return Value

    Returns nil if it doesn’t exist

  • Checks to see if outdoor exists for a given id and returns it if so

    Since

    1.1

    Declaration

    Swift

    - (VMMSMapOutdoorBuilding *)getOutdoorBuildingWithId:(id)uid;

    Parameters

    uid

    The id (key) for the building

    Return Value

    Returns nil if it doesn’t exist

  • Iterates through all buildings to find a floor with the given id. All floors will have a unique id regardless of what building they are in

    Declaration

    Swift

    - (VMMSMapBuildingFloor *)findFloorWithId:(id)uid;

    Parameters

    uid

    the uid of the floor to find

    Return Value

    a VMMSMapBuildingFloor object or nil if one did not exist with that uid

  • Iterates through all buildings to find a floor with the given id. All floors will have a unique id regardless of what building they are in

    Since

    1.1

    Declaration

    Swift

    - (VMMSMapOutdoorBuildingFloor *)findOutdoorFloorWithId:(id)uid;

    Parameters

    uid

    the uid of the floor to find

    Return Value

    a VMMSMapOutdoorBuildingFloor object or nil if one did not exist with that uid

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

    Since

    1.1

    Declaration

    Swift

    - (void)createTurnByTurnDirectionsForWaypath:(VMMSWaypath *)waypath
                           withCustomMapInfo:(VMMSCustomMapInfo *)info
                                  andOptions:
                                      (VMMSTurnByTurnDirectionOptions *)options
                                    delegate:(id<VMMSWayfindingDelegate>)
                                                 wayfindingDelegate;

    Parameters

    waypath

    The waypath to create text directions for.
    info

    A VMMSCustomMapInfo object that contains custom information for directions.
    options

    Options to use when creating directions.

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

    Since

    1.0

    Warning

    Deprecated in 1.1. Use createTurnByTurnDirectionsForWaypath:withCustomMapInfo:andOptions:delegate: instead.

    Declaration

    Swift

    - (void)createTurnByTurnDirectionsForWaypath:(VMMSWaypath *)waypath
                           withCustomMapInfo:(VMMSCustomMapInfo *)info
                                  andOptions:
                                      (VMMSTurnByTurnDirectionOptions *)options;

    Parameters

    waypath

    The waypath to create text directions for.
    info

    A VMMSCustomMapInfo object that contains custom information for directions.
    options

    Options to use when creating directions.

  • Iterates through buildings and floors until it finds a waypoint with the given ID.

    Declaration

    Swift

    - (VMMSWaypoint *)findWaypointWithId:(id)uid;

    Parameters

    uid

    The UID to look for when iterating.

    Return Value

    The waypoint that is found or nil if one is not found for the given ID.

  • Iterates through buildings and floors until it finds a waypoint with the given ID.

    Since

    1.1

    Declaration

    Swift

    - (VMMSWaypoint *)findOutdoorWaypointWithId:(id)uid;

    Parameters

    uid

    The UID to look for when iterating.

    Return Value

    The waypoint that is found or nil if one is not found for the given ID.

  • Finds the connected waypoints for a given waypoint.

    Declaration

    Swift

    - (id)neighborsForWaypointWithId:(id)waypointId;

    Parameters

    waypointId

    The waypoint to find neighbors for.

    Return Value

    The array of waypoints that are connected.

  • Labels waypoints.

    Declaration

    Swift

    - (void)labelWaypoints;

  • Labels waypoints with options.

    Declaration

    Swift

    - (void)labelWaypoints:(VMMSWaypointLabelOptions *)options;

    Parameters

    options

    Options to use while labeling.

  • Classifies waypoints.

    Declaration

    Swift

    - (void)classifyWaypoints:(VMMSWaypointLabelOptions *)options;

    Parameters

    options

    Options to use while classifying waypoints.

  • Adds a waypoint as a neighbor.

    Declaration

    Swift

    - (void)addNeighborForWaypointWithId:(id)waypointId
                            neighbor:(VMMSWaypoint *)neighbor;

    Parameters

    waypointId

    ID of waypoint to be given a neighbor.
    neighbor

    The neighbor waypoint.

  • Adds a waypoint as a neighbor.

    Declaration

    Swift

    - (void)addNeighborForWaypointWithId:(id)waypointId neighborId:(id)neighborId;

    Parameters

    waypointId

    ID of waypoint to be given a neighbor.
    neighborId

    ID of neighbor waypoint.

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

    Since

    1.1

    Declaration

    Swift

    - (VMMSWaypoint *)findClosestWaypoint:(id)location onFloor:(id)floorId;

    Parameters

    location

    the target location
    floorId

    the uid of the floor to check

    Return Value

    the closest waypoint, or nil if nothing is close

  • Finds the closest waypoint outdoors nearest to the given location

    Since

    1.1

    Declaration

    Swift

    - (VMMSWaypoint *)findClosestOutdoorWaypoint:(id)location onFloor:(id)floorId;

    Parameters

    location

    the target location
    floorId

    the uid of the floor to check

    Return Value

    the closest waypoint, or nil if nothing is close

Public Properties

  • An object that implmenets the VMMSMapDelegate protocol and its required/optional methods.

    Declaration

    Swift

    @property (readwrite, nonatomic) id<VMMSMapDelegate> delegate;

  • The initial rotation of the map so that the user can adjust the map’s rotation (heading, bearing) so that text labels are upright.

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) float initialRotation;

  • The center point of the venue

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) int centerPoint;

  • The initial zoom that displays the entire venue

    Warning

    Deprecated in 1.2.1. Use initialZoomLevel instead.

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) int initialZoom;

  • The initial zoom that displays the entire venue

    Since

    1.2.1

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) float initialZoomLevel;

  • The id of the venue

    Since

    1.1

    Declaration

    Swift

    @property (nonatomic, strong) NSString *venueId

  • The mode used to process the VMD

    Since

    1.3

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) int processingMode;

  • True if the map has been geolocated, false otherwise

    Since

    1.3

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) int geolocated;