VMMSWaypoint
Objective-C
@interface VMMSWaypoint : NSObject
Swift
class VMMSWaypoint : NSObject
Model that represents a waypoint. It includes its coordinate, building location, floor location, and more.
Since
1.0-
Designated Initializer.
Declaration
Objective-C
- (nonnull instancetype)initWithId:(nonnull NSString *)uid position:(CLLocationCoordinate2D)location;
Swift
init(id uid: String, position location: CLLocationCoordinate2D)
Parameters
uid
The unique identifer of the waypoint. The uid is expected to have a format of waypointname_type_b9_f9_9.
location
The coordinate of the waypoint.
Return Value
A VMMSWaypoint instance.
-
Get root waypoint this one is named after
Since
1.2Declaration
Objective-C
- (nonnull VMMSWaypoint *)getFirstNamesake;
Swift
func getFirstNamesake() -> VMMSWaypoint
-
The unique identifier of the waypoint.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nonnull uid;
Swift
var uid: String { get set }
-
The id of this waypoint’s parent unit
Since
2.0Declaration
Objective-C
@property (nonatomic, strong, nullable) NSString *unitId;
Swift
var unitId: String? { get set }
-
The name of the waypoint.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nonnull name;
Swift
var name: String { get set }
-
The display name of the waypoint (i.e. Men’s Bathroom).
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *publicDescription;
Swift
var publicDescription: String { get set }
-
Reference to the map floor that this waypoint belongs to
Since
1.1Declaration
Objective-C
@property (nonatomic, weak) VMWayfindingBaseFloor *_Nullable mapFloor;
Swift
weak var mapFloor: VMWayfindingBaseFloor? { get set }
-
The type of waypoint (i.e. Amenity, Room, etc.)
Declaration
Objective-C
@property (nonatomic) int type;
Swift
var type: Int32 { get set }
-
The position of the waypoint (e.g. whether or not it’s indoors or outdoors).
Declaration
Objective-C
@property (nonatomic) int waypointPosition;
Swift
var waypointPosition: Int32 { get set }
-
The coordinate of the waypoint.
Declaration
Objective-C
@property (nonatomic) CLLocationCoordinate2D location;
Swift
var location: CLLocationCoordinate2D { get set }
-
The sequence number of a waypoint. This is used for elevators and stairs. Elevator waypoints, which are located on different floors, will have the same sequence number so they can be connected accordingly.
Declaration
Objective-C
@property (nonatomic) NSInteger sequence;
Swift
var sequence: Int { get set }
-
Whether or not to describe a waypoint. Some waypoints don’t add value when describing the path, such as those that are in the middle of a straight line.
Declaration
Objective-C
@property (nonatomic) BOOL doNotDescribe;
Swift
var doNotDescribe: Bool { get set }
-
Whether or not this waypoint can be autolabeled.
Declaration
Objective-C
@property (nonatomic) BOOL canBeAutolabeled;
Swift
var canBeAutolabeled: Bool { get set }
-
Used to indicate that this waypoint was processed during the auto-labeling process
Declaration
Objective-C
@property (nonatomic) BOOL triaged;
Swift
var triaged: Bool { get set }
-
Whether or not this waypoint is a destination.
Declaration
Objective-C
@property (nonatomic, readonly) BOOL isDestinationType;
Swift
var isDestinationType: Bool { get }
-
Whether or not the waypoint is traversible (i.e. A banquet room that can be used to get from point A to point B. However, we would rather use the hallway outside instead of going through this room. Therefore, this room would not be traversible.
Declaration
Objective-C
@property (nonatomic, readonly) BOOL isTraversable;
Swift
var isTraversable: Bool { get }
-
Waypoint this one is named after
Since
1.2Declaration
Objective-C
@property (nonatomic, weak) VMMSWaypoint *_Nullable namesake;
Swift
weak var namesake: VMMSWaypoint? { get set }