VMMSPathMetadata

Objective-C

@interface VMMSPathMetadata : NSObject

Swift

class VMMSPathMetadata : NSObject

Since

1.2

Initializers

  • Initializer to use if path has no description.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithWaypoint1:(nonnull VMMSWaypoint *)p1
                                waypoint2:(nonnull VMMSWaypoint *)p2;

    Swift

    init(waypoint1 p1: VMMSWaypoint, waypoint2 p2: VMMSWaypoint)

    Parameters

    p1

    The first waypoint of the path.
    p2

    The second waypoint of the path.

    Return Value

    A VMMSPathMetadata instance.

  • Designated initializer.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithWaypoint1:(nonnull VMMSWaypoint *)p1
                                waypoint2:(nonnull VMMSWaypoint *)p2
                          pathDescription:(nonnull NSString *)pathDescription
                             description1:(nonnull NSString *)description1
                             description2:(nonnull NSString *)description2;

    Swift

    init(waypoint1 p1: VMMSWaypoint, waypoint2 p2: VMMSWaypoint, pathDescription: String, description1: String, description2: String)

    Parameters

    p1

    The first waypoint of the path.
    p2

    The second waypoint of the path.
    pathDescription

    A general description of the path that can be used in both directions.
    description1

    A description of the path when going from point 1 to point 2.
    description2

    A description of the path when going from point 2 to point 1.

    Return Value

    A VMMSPathMetadata instance.

Public Properties

  • The rotation of the waypoint.

    Declaration

    Objective-C

    @property (nonatomic, readonly) double heading;

    Swift

    var heading: Double { get }

  • The distance between the two points in meters.

    Declaration

    Objective-C

    @property (nonatomic, readonly) double pathDistance;

    Swift

    var pathDistance: Double { get }
  • uid

    The unique identifier of the waypoint.

    Declaration

    Objective-C

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

    Swift

    var uid: String { get set }

  • The description when going from point 1 to point 2.

    Declaration

    Objective-C

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

    Swift

    var description1: String { get set }

  • The description when going from point 2 to point 1.

    Declaration

    Objective-C

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

    Swift

    var description2: String { get set }

  • A general description regardless of direction.

    Declaration

    Objective-C

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

    Swift

    var pathDescription: String { get set }

  • The directional description to use.

    Declaration

    Objective-C

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

    Swift

    var directionalDescription: String { get set }
  • p1

    The first waypoint.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) VMMSWaypoint *_Nonnull p1;

    Swift

    var p1: VMMSWaypoint { get }
  • p2

    The second waypoint.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) VMMSWaypoint *_Nonnull p2;

    Swift

    var p2: VMMSWaypoint { get }

  • A waypoint that this path is heading towards, passing, etc.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) VMMSWaypoint *pointOfFocus;

    Swift

    var pointOfFocus: VMMSWaypoint? { get set }

  • Whether or not it can be autolabeled.

    Declaration

    Objective-C

    @property (nonatomic) BOOL canBeAutolabeled;

    Swift

    var canBeAutolabeled: Bool { get set }

  • Which specific class it was labeled by (i.e. VMMSWaypathLabelerPastLabeledNode, VMMSWaypathLabelerThroughNavigableNodes, etc.)

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSObject<VMMSPathLabelerProtcol> *labeledBy;