VMSDK Core Classes Reference


                    
                    
                    Constants

Collection of VMSDK Constants

Since

1.1

Declaration

Swift

public struct Constants


                    
                    
                    MapErrorDomain

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

Since

1.0

Declaration

Objective-C

static NSString *const _Nonnull MapErrorDomain = @"com.Aegir.Map.ErrorDomain"


                    
                    
                    VMAnnotationCalloutView

Declaration

Swift

@objc
public protocol VMAnnotationCalloutView : MGLCalloutView


                    
                    
                    VMBrandConstants

Expose various VM brand constants to objc

Since

Since 1.2

Declaration

Swift

@objcMembers
public class VMBrandConstants : NSObject


                    
                    
                    VMCoordinateBounds

Declaration

Swift

@objcMembers
open class VMCoordinateBounds : NSObject


                    
                    
                    VMDFile

File type supported by VM SDK

Since

1.1

Declaration

Objective-C

@protocol VMDFile <NSObject>

Swift

protocol VMDFile : NSObjectProtocol


                    
                    
                    VMDFileCollection

A collection of venue map data files

Since

1.1

Declaration

Objective-C

@interface VMDFileCollection : NSObject

Swift

class VMDFileCollection : NSObject


                    
                    
                    VMDFileErrorDomain

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

Since

1.1

Declaration

Objective-C

static NSString *const _Nonnull VMDFileErrorDomain =
    @"com.Aegir.VMD.ErrorDomain"

Swift

let VMDFileErrorDomain: String


                    
                    
                    VMDLocalFile

Represents a local file that needs to be loaded for map data

xml file
geojson file
json file

Since

1.1

Declaration

Objective-C

@interface VMDLocalFile : NSObject <VMDFile>

Swift

class VMDLocalFile : NSObject, VMDFile


                    
                    
                    VMDLocalZipFile

Represents a zipped collection of map files on the local file system

Since

1.1

Declaration

Objective-C

@interface VMDLocalZipFile : VMDLocalFile

Swift

class VMDLocalZipFile : VMDLocalFile


                    
                    
                    VMDParser

Parser for processing VMD files

Since

1.4

Declaration

Swift

@objc
open class VMDParser : NSObject


                    
                    
                    VMDParserDelegate

Delegate for vmd parsing callbacks

Since

1.4

Declaration

Swift

@objc
public protocol VMDParserDelegate


                    
                    
                    VMDParserOptions

Class for various parser options to optimize loading and parsing VMD data for various specific use cases.

Since

1.2

Declaration

Objective-C

@interface VMDParserOptions : NSObject

Swift

class VMDParserOptions : NSObject


                    
                    
                    VMDParserService

Service for helper methods used for parsing vmds

Since

2.0

Declaration

Swift

open class VMDParserService


                    
                    
                    VMDRemoteFile

Represents a remote file that needs to be loaded for map data

xml file
geojson file
json file

Since

1.1

Declaration

Objective-C

@interface VMDRemoteFile : NSObject <VMDFile>

Swift

class VMDRemoteFile : NSObject, VMDFile


                    
                    
                    VMDRemoteZipFile

Represents a zipped collection of map files at a remote url

Since

1.1

Declaration

Objective-C

@interface VMDRemoteZipFile : VMDRemoteFile

Swift

class VMDRemoteZipFile : VMDRemoteFile


                    
                    
                    VMDebugPolyline

Debug map polyline for drawing lines in wayfinding node graph

Since

1.1

Declaration

Objective-C

@interface VMDebugPolyline : VMPolyline

Swift

class VMDebugPolyline


                    
                    
                    VMFloorAnnotation

Since

1.1

Declaration

Objective-C

@interface VMFloorAnnotation : VMMapAnnotation


                    
                    
                    VMMapProviderType

Supported map provider types

Since

2.0

Declaration

Swift

@objc
public enum VMMapProviderType : Int


                    
                    
                    VMMSCoordinateBounds

Declaration

Swift

@objcMembers
open class VMMSCoordinateBounds : VMCoordinateBounds


                    
                    
                    VMMSLogLevel

Used to control amount of log output

Since

1.0

Declaration

Objective-C

enum VMMSLogLevel : NSUInteger {}

Swift

enum VMMSLogLevel : UInt, @unchecked Sendable


                    
                    
                    VMMSLogger

Singleton logging object

Since

1.0

Declaration

Objective-C

@interface VMMSLogger : NSObject

Swift

class VMMSLogger : NSObject


                    
                    
                    VMMapUtil

Declaration

Swift

@objcMembers
public class VMMapUtil : NSObject


                    
                    
                    VMMapAnnotation

Base class for all venue map annotations

Since

1.1

Declaration

Objective-C

@interface VMMapAnnotation

Swift

class VMMapAnnotation


                    
                    
                    VMMapView

VMMapView is an abstract class used to display a Venue Map Data file (VMD)

Warning

DO NOT instantiate directly, instead use one of the concrete subclasses VMVectorMapView or VMRasterMapView.

Since

1.1

Declaration

Swift

@objcMembers
open class VMMapView : UIView

extension VMMapView: MGLMapViewDelegate


                    
                    
                    VMMapViewDelegate

Protocol for receiving VMMapView callbacks

Since

1.1

Declaration

Swift

@objc
public protocol VMMapViewDelegate : NSObjectProtocol


                    
                    
                    VMPointAnnotation

Generic map annotation

Since

1.1

Declaration

Objective-C

@interface VMPointAnnotation : VMFloorAnnotation


                    
                    
                    VMPolyline

Generic polyline

Since

1.1

Declaration

Objective-C

@interface VMPolyline

Swift

class VMPolyline


                    
                    
                    VMProcessingMode

Different type of processing mode when parsing a VMD

Since

1.3

Declaration

Objective-C

enum VMProcessingMode : NSUInteger {}


                    
                    
                    VMRasterMapView

Concrete implementation of VMMapView that uses purely raster map tiles

Since

1.1

Declaration

Swift

@objcMembers
public class VMRasterMapView : VMMapView


                    
                    
                    VMVectorMapView

Concrete implementation of VMMapView that uses vector map tiles

Since

1.1

Declaration

Swift

@objcMembers
open class VMVectorMapView : VMMapView


                    
                    
                    VMVenueLayerStyle

This class represents all of the stylistics properties that can be configured for display of a map’s style

Since

1.1

Declaration

Swift

@objcMembers
public class VMVenueLayerStyle : NSObject


                    
                    
                    VMVenueStyle

Class for styling a venue map

Since

1.1

Declaration

Swift

@objcMembers
open class VMVenueStyle : NSObject


                    
                    
                    VMVenueStyleConstants

Expose various default map style constants to objc

Since

1.2

Declaration

Swift

@objcMembers
public class VMVenueStyleConstants : NSObject


                    
                    
                    VMVenueWayfindingStyle

Wayfinding drawing style definition

Since

1.1

Declaration

Swift

@objcMembers
public class VMVenueWayfindingStyle : VMVenueStyle


                    
                    
                    vmSdkVersion

Represents the current version of the VMSDK

Since

1.0

Declaration

Objective-C

extern NSString *vmSdkVersion

Swift

let vmSdkVersion: String