VMMSBaseFloor

Objective-C

@interface VMMSBaseFloor : NSObject

Swift

class VMMSBaseFloor : NSObject

class that contains information for a floor within a building. Encapsulates waypoints (VMMSWaypoint) that are on this floor.

Since

1.1

Initializers

  • Initializer used if there is not a name for the floor.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFloorId:(nonnull NSString *)uid;

    Swift

    init(floorId uid: String)

    Parameters

    uid

    ID of the floor.

    Return Value

    A instance of VMMSBaseFloor.

  • Initializer used if there is a name for the floor.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFloorId:(nonnull NSString *)uid
                           andFloorName:(nonnull NSString *)name;

    Swift

    init(floorId uid: String, andFloorName name: String)

    Parameters

    uid

    ID of the floor.
    name

    Name of the floor.

    Return Value

    A instance of VMMSBaseFloor.

  • Initializer used if there is a name for the floor.

    Since

    1.3

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFloorId:(nonnull NSString *)uid
                           andFloorName:(nonnull NSString *)name
                        andFloorOrindal:(nonnull NSString *)ordinal;

    Swift

    init(floorId uid: String, andFloorName name: String, andFloorOrindal ordinal: String)

    Parameters

    uid

    ID of the floor.
    name

    Name of the floor.
    ordinal

    the floor ordinal.

    Return Value

    A instance of VMMSBaseFloor.

Public Methods

  • Adds a map unit to the floor.

    Since

    1.1

    Declaration

    Objective-C

    - (void)addMapUnit:(nonnull VMMSMapUnit *)mapUnit;

    Swift

    func addMapUnit(_ mapUnit: VMMSMapUnit)

    Parameters

    mapUnit

    The map unit to associate with this floor

  • Find a map unit on this floor

    Since

    1.1

    Declaration

    Objective-C

    - (nullable VMMSMapUnit *)getMapUnit:(nonnull NSString *)mapUnitId;

    Swift

    func getMapUnit(_ mapUnitId: String) -> VMMSMapUnit?

    Parameters

    mapUnitId

    the unit’s uid

    Return Value

    a reference to a VMMSMapUnit or nil if the unit does not exist on this floor

  • Detect if a location is inside a polygon on the map

    Since

    1.1

    Declaration

    Objective-C

    - (BOOL)point:(CLLocationCoordinate2D)point
    isInPolygon:(nonnull NSArray<NSValue *> *)vertices;

    Swift

    func point(_ point: CLLocationCoordinate2D, isInPolygon vertices: [NSValue]) -> Bool

    Parameters

    point

    the location to check
    vertices

    the vertices of the polygon

    Return Value

    true if the point is inside, false otherwise

Public Properties

  • uid

    Unique identifer for floor.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull uid;

    Swift

    var uid: String { get set }

  • Display name for floor.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull name;

    Swift

    var name: String { get set }

  • UUID for floor.

    Since

    2.0

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull placeId;

    Swift

    var placeId: String { get set }

  • Deprecated

    Deprecated since 1.3. Use ordinal instead.

    Identifies what number the floor is within the building.

    Warning

    DEPRECATED since 1.3. Use ordinal instead.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger floorNumber;

    Swift

    var floorNumber: Int { get set }

  • Identifies the floor’s ordinal value. An ordinal value of 0 is ground level. Negative values are below ground and positive numbers are above ground.

    Since

    1.3

    Declaration

    Objective-C

    @property (nonatomic) NSInteger ordinal;

    Swift

    var ordinal: Int { get set }

  • Contains the map units for the floor which are used to create map icons/labels.

    Since

    1.1

    Declaration

    Objective-C

    @property (nonatomic, strong) NSMutableDictionary<NSString *, VMMSMapUnit *> *_Nonnull mapUnits;

    Swift

    var mapUnits: NSMutableDictionary { get set }

  • The coordinates that make up the perimeter

    Since

    1.1

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSArray<NSValue *> *> *_Nonnull coordinates;

    Swift

    var coordinates: [[NSValue]] { get set }

  • The geojson coordinates for this geojson feature representing this floor

    Since

    1.3.1

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray *_Nonnull geojsonCoordinates;

    Swift

    var geojsonCoordinates: [Any] { get set }

  • The geojson geometry type

    Since

    1.3.1

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull geometryType;

    Swift

    var geometryType: String { get set }

  • The building that contains this floor

    Since

    1.1

    Declaration

    Objective-C

    @property (nonatomic, weak) VMMSBaseBuilding *_Nullable mapBuilding;

    Swift

    weak var mapBuilding: VMMSBaseBuilding? { get set }