VMVenue

@objcMembers
open class VMVenue : NSObject

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.5

Public Properties

  • A dictionary that contains all VMMSBaseBuilding for a venue.

    Declaration

    Swift

    public var buildings: [String : VMMSBaseBuilding]

  • A dictionary that contains all VMMSMapOutdoorBuildings.

    Since

    1.1

    Declaration

    Swift

    public var outdoorBuildings: [String : VMMSBaseBuilding]

  • The version of the VMD

    Since

    1.5

    Declaration

    Swift

    public var version: Double

  • The base URL that contains map provider path

    Since

    2.0

    Declaration

    Swift

    public var mapProviderPath: String?

  • The label GeoJSON URL

    Since

    1.5

    Declaration

    Swift

    public var labelsGeojsonSourceUrl: URL?

  • The amenities GeoJSON URL

    Since

    1.5

    Declaration

    Swift

    public var amenitiesGeojsonSourceUrl: URL?

  • The center point of the venue

    Declaration

    Swift

    public var centerPoint: CLLocationCoordinate2D

  • The initial zoom that displays the entire venue

    Since

    1.2.1

    Declaration

    Swift

    public var initialZoomLevel: Float

  • The id of the venue

    Since

    1.1

    Declaration

    Swift

    public var venueId: String?

  • The place id of the venue

    Since

    2.0

    Declaration

    Swift

    public var placeId: String?

  • The mode used to process the VMD

    Since

    1.3

    Declaration

    Swift

    public var processingMode: VMProcessingMode

  • True if the map has been geolocated, false otherwise

    Since

    1.3

    Declaration

    Swift

    public var geolocated: Bool

  • The coordinates that make up the perimeter

    Since

    1.1

    Declaration

    Swift

    public var coordinates: [[NSValue]]

Initializers

  • Designated initializer.

    Declaration

    Swift

    public override init()

    Return Value

    an instance of VMMSMap.

  • 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

    public var initialRotation: Float { get set }

Public Methods

  • Gets all the indoor and outdoor buildings.

    Since

    1.4

    Declaration

    Swift

    public func allBuildings() -> [VMMSBaseBuilding]

  • Adds a VMMSBaseBuilding instance to a dictionary. @param building A VMMSBaseBuilding

    Declaration

    Swift

    open func addBuilding(_ building: VMMSBaseBuilding)

  • Adds a VMMSBaseBuilding instance to a dictionary.

    @param building A VMMSMapOutdoorBuilding

    Since

    1.1

    Declaration

    Swift

    open func addOutdoorBuilding(_ building: VMMSBaseBuilding)

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

    Declaration

    Swift

    public func getBuilding(id uid: String) -> VMMSBaseBuilding?

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

    Since

    1.1

    Declaration

    Swift

    public func getOutdoorBuilding(id uid: String) -> VMMSBaseBuilding?

  • 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

    public func findFloor(id uid: String) -> VMMSBaseFloor?

  • 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

    public func findOutdoorFloor(id uid: String) -> VMMSBaseFloor?