VMWayfindingBaseFloor
Objective-C
@interface VMWayfindingBaseFloor : VMMSBaseFloor
Swift
class VMWayfindingBaseFloor
Floor with wayfinding data enabled
Since
1.4-
Adds a waypoint to the floor.
Declaration
Objective-C
- (void)addWaypoint:(nonnull VMMSWaypoint *)waypoint;
Swift
func addWaypoint(_ waypoint: VMMSWaypoint)
Parameters
waypoint
Waypoint to add.
-
Adds an edge that connects two waypoints.
Declaration
Objective-C
- (void)addEdgeWithPointOneId:(nonnull NSString *)pointOneId andPointTwoId:(nonnull NSString *)pointTwoId;
Swift
func addEdge(withPointOneId pointOneId: String, andPointTwoId pointTwoId: String)
Parameters
pointOneId
ID of first waypoint.
pointTwoId
ID of second waypoint.
-
Finds a waypoint with a given ID.
Declaration
Objective-C
- (nullable VMMSWaypoint *)getWaypointWithId:(nonnull NSString *)waypointId;
Swift
func getWaypointWithId(_ waypointId: String) -> VMMSWaypoint?
Parameters
waypointId
ID of waypoint to find.
Return Value
Waypoint that is found or nil if not found.
-
Find the closest waypoint to a location
Declaration
Objective-C
- (nullable VMMSWaypoint *)findClosestWaypoint:(CLLocationCoordinate2D)location;
Swift
func findClosestWaypoint(_ location: Any!) -> VMMSWaypoint?
Parameters
location
the location to check
Return Value
the closest waypoint, or nil if nothing is close
-
Recalculates or adds Waypath Weights from updatted waypoint locations.
Since
2.0Declaration
Objective-C
- (void)recalculateWaypathWeights;
Swift
func recalculateWaypathWeights()
-
Contains waypoints that are on this floor.
Declaration
Objective-C
@property (nonatomic, strong) NSMutableArray<VMMSWaypoint *> *_Nonnull waypoints;
Swift
var waypoints: NSMutableArray { get set }
-
Map of waypoints on this floor where the keys are the waypoint’s uid
Declaration
Objective-C
@property (nonatomic, strong) NSMutableDictionary<NSString *, VMMSWaypoint *> *_Nonnull waypointsMap;
Swift
var waypointsMap: NSMutableDictionary { get set }
-
Contains waypoints that are elevators for this floor.
Declaration
Objective-C
@property (nonatomic, strong) NSMutableArray<VMMSWaypoint *> *_Nonnull elevators;
Swift
var elevators: NSMutableArray { get set }
-
Contains waypoints that are exits for this floor.
Declaration
Objective-C
@property (nonatomic, strong) NSMutableArray<VMMSWaypoint *> *_Nonnull exitPoints;
Swift
var exitPoints: NSMutableArray { get set }
-
Contains waypoints that are stairs for this floor.
Declaration
Objective-C
@property (nonatomic, strong) NSMutableArray<VMMSWaypoint *> *_Nonnull stairs;
Swift
var stairs: NSMutableArray { get set }
-
Contains the connected paths for this floor.
Declaration
Objective-C
@property (nonatomic, strong) NSMutableDictionary<NSString *, NSMutableDictionary<NSString *, NSNumber *> *> *_Nonnull floorGraph;
Swift
var floorGraph: NSMutableDictionary { get set }