VMMSPathMetadata

@interface VMMSPathMetadata : NSObject

Since

1.2

Initializers

  • Initializer to use if path has no description.

    Declaration

    Swift

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

    Parameters

    p1

    The first waypoint of the path.
    p2

    The second waypoint of the path.

    Return Value

    A VMMSPathMetadata instance.

  • Designated initializer.

    Declaration

    Swift

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

    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

    Swift

    @property (readonly, nonatomic) double heading;

  • The distance between the two points in meters.

    Declaration

    Swift

    @property (readonly, nonatomic) double pathDistance;
  • uid

    The unique identifier of the waypoint.

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

  • A general description regardless of direction.

    Declaration

    Swift

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

  • The directional description to use.

    Declaration

    Swift

    @property (readwrite, strong, nonatomic) NSString *directionalDescription;
  • p1

    The first waypoint.

    Declaration

    Swift

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

    The second waypoint.

    Declaration

    Swift

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

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

    Declaration

    Swift

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

  • Whether or not it can be autolabeled.

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) BOOL canBeAutolabeled;

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

    Declaration

    Swift

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