VMSDK Wayfinding Classes Reference


                    
                    
                    VMDWayfindingParserDelegate

Since

1.4

Declaration

Swift

@objc
public protocol VMDWayfindingParserDelegate : NSObjectProtocol, VMDParserDelegate


                    
                    
                    VMFloorChangePointAnnotation

Map annotation representing the control used to indicate the place where a waypath can navigate between floors

Since

1.1

Declaration

Objective-C

@interface VMFloorChangePointAnnotation : VMPointAnnotation

Swift

class VMFloorChangePointAnnotation


                    
                    
                    VMLandmarkAnnotation

Represents a landmark used in wayfinding

Since

1.1

Declaration

Objective-C

@interface VMLandmarkAnnotation : VMWaypointAnnotation


                    
                    
                    VMMSCustomMapInfo

Class that contains custom info that can be used when creating turn by turn directions and auto-labeling waypoints.

Since

1.0

Declaration

Objective-C

@interface VMMSCustomMapInfo : NSObject

Swift

class VMMSCustomMapInfo : NSObject


                    
                    
                    VMMSDirectionIndicator

Used to determine the appropriate terminology when describing the direction that a person must take between two connected segments of a waypath

Since

1.1

Declaration

Objective-C

@interface VMMSDirectionIndicator : NSObject

Swift

class VMMSDirectionIndicator : NSObject


                    
                    
                    VMMSMapDirectionStep

Model that represents a particular leg or step in a waypath.

Since

1.0

Declaration

Objective-C

@interface VMMSMapDirectionStep : NSObject

Swift

class VMMSMapDirectionStep : NSObject


                    
                    
                    VMMSPathMetadata

Since

1.2

Declaration

Objective-C

@interface VMMSPathMetadata : NSObject

Swift

class VMMSPathMetadata : NSObject


                    
                    
                    VMMSTurnByTurnDirectionOptions

Allows customization of text generated for turn by turn directions

Since

1.0

Declaration

Objective-C

@interface VMMSTurnByTurnDirectionOptions : NSObject

Swift

class VMMSTurnByTurnDirectionOptions : NSObject


                    
                    
                    VMMSWayfindingDelegate

The VMMSMapDelegate protocol defines the required and optional methods for an object to implement.

Since

1.1

Declaration

Objective-C

@protocol VMMSWayfindingDelegate <NSObject>

Swift

protocol VMMSWayfindingDelegate : NSObjectProtocol


                    
                    
                    VMMSWayfindingOptions

Model representing the various options to use when creating waypath.

Since

1.0

Declaration

Objective-C

@interface VMMSWayfindingOptions : NSObject

Swift

class VMMSWayfindingOptions : NSObject


                    
                    
                    VMMSWaypath

Model to represent a waypath and any other data that may need to be associated with a waypath.

Since

1.0

Declaration

Objective-C

@interface VMMSWaypath : NSObject

Swift

class VMMSWaypath : NSObject


                    
                    
                    VMMSWaypathBuildingTransitionSegment

Segment of a waypath that represents transitioning from the inside of a building to the outside

Since

1.0

Declaration

Objective-C

@interface VMMSWaypathBuildingTransitionSegment : VMMSWaypathSegment

Swift

class VMMSWaypathBuildingTransitionSegment : VMMSWaypathSegment


                    
                    
                    VMMSWaypathFloorChangeSegment

Indicates a section of a waypath that is for a floor change

Since

1.1

Declaration

Objective-C

@interface VMMSWaypathFloorChangeSegment : VMMSWaypathSegment

Swift

class VMMSWaypathFloorChangeSegment : VMMSWaypathSegment


                    
                    
                    VMMSWaypathSegment

Indicates a section of the overall waypath that the user will take along their way from the start to the end of the journey

Since

1.0

Declaration

Objective-C

@interface VMMSWaypathSegment : NSObject

Swift

class VMMSWaypathSegment : NSObject


                    
                    
                    VMMSWaypoint

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

Since

1.0

Declaration

Objective-C

@interface VMMSWaypoint : NSObject

Swift

class VMMSWaypoint : NSObject


                    
                    
                    VMMSWaypointLabelOptions

Allows customization of auto-generated waypoint descriptions

Since

1.0

Declaration

Objective-C

@interface VMMSWaypointLabelOptions : NSObject

Swift

class VMMSWaypointLabelOptions : NSObject


                    
                    
                    VMVectorWalkingPathOverlay

Concrete class for enabling wayfinding visualization w/ vector maps

Since

1.1

Declaration

Objective-C

@interface VMVectorWalkingPathOverlay : VMWalkingPathOverlay

Swift

class VMVectorWalkingPathOverlay : VMWalkingPathOverlay


                    
                    
                    VMVectorWalkingPathOverlayUtil

Declaration

Swift

@objcMembers
open class VMVectorWalkingPathOverlayUtil : NSObject


                    
                    
                    VMVenueStyleWayfindingConstants

Collection of Wayfinding-specific constants and default values to expose to objc

Since

1.4

Declaration

Swift

@objcMembers
public class VMVenueStyleWayfindingConstants : NSObject


                    
                    
                    VMVenueWayfindingConstants

Expose various default map wayfinding constants to objc

Since

1.2

Declaration

Swift

@objcMembers
public class VMVenueWayfindingConstants : NSObject


                    
                    
                    VMWalkingPathOverlay

Base abstract class that provides some functionality for enabling Wayfinding visualization

Since

1.1

Warning

Do not create instances of this class directly.

Declaration

Objective-C

@interface VMWalkingPathOverlay : NSObject

Swift

class VMWalkingPathOverlay : NSObject


                    
                    
                    VMWalkingPathOverlayDelegate

Protocol for receiving VMWalkingPathOverlay callbacks

Since

1.1

Declaration

Objective-C

@protocol VMWalkingPathOverlayDelegate <NSObject>

Swift

protocol VMWalkingPathOverlayDelegate : NSObjectProtocol


                    
                    
                    VMWalkingPathOverlayUtil

Declaration

Swift

@objcMembers
open class VMWalkingPathOverlayUtil : NSObject


                    
                    
                    VMWayfindingBaseBuilding

Building with wayfinding data enabled

Since

1.4

Declaration

Objective-C

@interface VMWayfindingBaseBuilding : VMMSBaseBuilding

Swift

class VMWayfindingBaseBuilding


                    
                    
                    VMWayfindingBaseFloor

Floor with wayfinding data enabled

Since

1.4

Declaration

Objective-C

@interface VMWayfindingBaseFloor : VMMSBaseFloor

Swift

class VMWayfindingBaseFloor


                    
                    
                    VMWayfindingConstants

Collection of Wayfinding-specific constants and default values

Since

1.4

Declaration

Swift

public class VMWayfindingConstants


                    
                    
                    VMWayfindingMap

Declaration

Swift

@objcMembers
public class VMWayfindingMap : VMMSMap


                    
                    
                    VMWayfindingMapUnit

Map unit with wayfinding data added

Since

1.4

Declaration

Swift

@objcMembers
open class VMWayfindingMapUnit : VMMSMapUnit


                    
                    
                    VMWayfindingMapView

Mapview with wayfinding support

Since

1.4

Declaration

Swift

public class VMWayfindingMapView : VMVectorMapView


                    
                    
                    VMWayfindingMapViewDelegate

Delegate for wayfinding-enabled map view

Since

1.4

Declaration

Swift

@objc
public protocol VMWayfindingMapViewDelegate : VMMapViewDelegate


                    
                    
                    VMWayfindingUtil

Handle various common uttility functions for manipulating wayfinding data

Since

1.4

Declaration

Swift

@objc
open class VMWayfindingUtil : NSObject


                    
                    
                    VMWayfindingVMDParser

Parser for handling VMD parsing with wayfinding enabled

Since

1.4

Declaration

Swift

@objc
open class VMWayfindingVMDParser : VMDParser


                    
                    
                    VMWayfindingVMDParserService

Service for helper methods used for parsing vmds for wayfinding

Since

2.0

Declaration

Swift

open class VMWayfindingVMDParserService : VMDParserService


                    
                    
                    VMWaypointAnnotation

Map annotation representing a waypoint

Since

1.1

Declaration

Objective-C

@interface VMWaypointAnnotation : VMFloorAnnotation

Swift

class VMWaypointAnnotation


                    
                    
                    WayfindingErrorDomain

General error domain used to report NSErrors in the VM-SDK

Since

1.1

Declaration

Objective-C

static NSString *const _Nonnull WayfindingErrorDomain =
    @"com.Aegir.Wayfinding.ErrorDomain"

Swift

let WayfindingErrorDomain: String


                    
                    
                    MJDikstraWrapper

Undocumented

Declaration

Objective-C

@interface MJDikstraWrapper : NSObject
+(nullable NSArray<NSString*>*)shortestPath:(NSDictionary*) G start:(NSString*) start end:(NSString*) end error:(NSError**)error;
@end

Swift

class MJDikstraWrapper : NSObject


                    
                    
                    VMMSWayfindingAlgorithm

This class creates turn by turn directions from a given waypath.

Declaration

Objective-C

@interface VMMSWayfindingAlgorithm : NSObject

Swift

class VMMSWayfindingAlgorithm : NSObject