VMSDK Core Classes

  • Collection of VMSDK Constants

    Since

    1.1
    See more

    Declaration

    Swift

    public struct Constants

  • 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"

  • Declaration

    Swift

    @objc
public protocol VMAnnotationCalloutView : MGLCalloutView

  • Expose various VM brand constants to objc

    Since

    Since 1.2
    See more

    Declaration

    Swift

    @objcMembers
public class VMBrandConstants : NSObject
  • See more

    Declaration

    Swift

    @objcMembers
open class VMCoordinateBounds : NSObject

  • File type supported by VM SDK

    Since

    1.1
    See more

    Declaration

    Objective-C

    @protocol VMDFile <NSObject>

    Swift

    protocol VMDFile : NSObjectProtocol

  • A collection of venue map data files

    Since

    1.1
    See more

    Declaration

    Objective-C

    @interface VMDFileCollection : NSObject

    Swift

    class VMDFileCollection : NSObject

  • 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

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

    • xml file
    • geojson file
    • json file

    Since

    1.1
    See more

    Declaration

    Objective-C

    @interface VMDLocalFile : NSObject <VMDFile>

    Swift

    class VMDLocalFile : NSObject, VMDFile

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

    Since

    1.1
    See more

    Declaration

    Objective-C

    @interface VMDLocalZipFile : VMDLocalFile

    Swift

    class VMDLocalZipFile : VMDLocalFile

  • Parser for processing VMD files

    Since

    1.4
    See more

    Declaration

    Swift

    @objc
open class VMDParser : NSObject

  • Delegate for vmd parsing callbacks

    Since

    1.4
    See more

    Declaration

    Swift

    @objc
public protocol VMDParserDelegate

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

    Since

    1.2
    See more

    Declaration

    Objective-C

    @interface VMDParserOptions : NSObject

    Swift

    class VMDParserOptions : NSObject

  • Service for helper methods used for parsing vmds

    Since

    2.0
    See more

    Declaration

    Swift

    open class VMDParserService

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

    • xml file
    • geojson file
    • json file

    Since

    1.1
    See more

    Declaration

    Objective-C

    @interface VMDRemoteFile : NSObject <VMDFile>

    Swift

    class VMDRemoteFile : NSObject, VMDFile

  • Represents a zipped collection of map files at a remote url

    Since

    1.1
    See more

    Declaration

    Objective-C

    @interface VMDRemoteZipFile : VMDRemoteFile

    Swift

    class VMDRemoteZipFile : VMDRemoteFile

  • Debug map polyline for drawing lines in wayfinding node graph

    Since

    1.1

    Declaration

    Objective-C

    @interface VMDebugPolyline : VMPolyline

    Swift

    class VMDebugPolyline

  • Since

    1.1
    See more

    Declaration

    Objective-C

    @interface VMFloorAnnotation : VMMapAnnotation

  • Supported map provider types

    Since

    2.0
    See more

    Declaration

    Swift

    @objc
public enum VMMapProviderType : Int

  • Declaration

    Swift

    @objcMembers
open class VMMSCoordinateBounds : VMCoordinateBounds

  • Used to control amount of log output

    Since

    1.0
    See more

    Declaration

    Objective-C

    enum VMMSLogLevel : NSUInteger {}

    Swift

    enum VMMSLogLevel : UInt, @unchecked Sendable

  • Singleton logging object

    Since

    1.0
    See more

    Declaration

    Objective-C

    @interface VMMSLogger : NSObject

    Swift

    class VMMSLogger : NSObject
  • See more

    Declaration

    Swift

    @objcMembers
public class VMMapUtil : NSObject

  • Base class for all venue map annotations

    Since

    1.1

    Declaration

    Objective-C

    @interface VMMapAnnotation

    Swift

    class VMMapAnnotation

  • 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
    See more

    Declaration

    Swift

    @objcMembers
open class VMMapView : UIView
    extension VMMapView: MGLMapViewDelegate

  • Protocol for receiving VMMapView callbacks

    Since

    1.1
    See more

    Declaration

    Swift

    @objc
public protocol VMMapViewDelegate : NSObjectProtocol

  • Generic map annotation

    Since

    1.1

    Declaration

    Objective-C

    @interface VMPointAnnotation : VMFloorAnnotation

  • Generic polyline

    Since

    1.1
    See more

    Declaration

    Objective-C

    @interface VMPolyline

    Swift

    class VMPolyline

  • Different type of processing mode when parsing a VMD

    Since

    1.3
    See more

    Declaration

    Objective-C

    enum VMProcessingMode : NSUInteger {}

  • Concrete implementation of VMMapView that uses purely raster map tiles

    Since

    1.1
    See more

    Declaration

    Swift

    @objcMembers
public class VMRasterMapView : VMMapView

  • Concrete implementation of VMMapView that uses vector map tiles

    Since

    1.1
    See more

    Declaration

    Swift

    @objcMembers
open class VMVectorMapView : VMMapView

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

    Since

    1.1
    See more

    Declaration

    Swift

    @objcMembers
public class VMVenueLayerStyle : NSObject

  • Class for styling a venue map

    Since

    1.1
    See more

    Declaration

    Swift

    @objcMembers
open class VMVenueStyle : NSObject

  • Expose various default map style constants to objc

    Since

    1.2
    See more

    Declaration

    Swift

    @objcMembers
public class VMVenueStyleConstants : NSObject

  • Wayfinding drawing style definition

    Since

    1.1
    See more

    Declaration

    Swift

    @objcMembers
public class VMVenueWayfindingStyle : VMVenueStyle

  • Represents the current version of the VMSDK

    Since

    1.0

    Declaration

    Objective-C

    extern NSString *vmSdkVersion

    Swift

    let vmSdkVersion: String