SYWaypoint Class Reference

Waypoints define a route's stopovers, including its start point it's destination point and any points in between. More...

#import <SYRoutingWaypoint.h>

Inheritance diagram for SYWaypoint:

Collaboration diagram for SYWaypoint:

Instance Methods
(nonnull instancetype)	- initWithPosition:type:name:
	Initializes a SYWaypoint instance with specified geocoordinates and type. More...

Properties
SYGeoCoordinate *	originalPosition
	Position for flag/pin. The original position is required for a route calculation. By default, this is set to be the same as the geocoordinates provided during construction of this SYWaypoint. More...
SYGeoCoordinate *	navigablePosition
	Represents the suggested navigable position of the SYWaypoint - typically the coordinates on the road closest to the original position - to be used in a route calculation. Working together with the navigable position, the original position is used by the Sygic SDK for determining the side of street during arrival, and to let the calculated route approach the correct side of street, especially when there there is a physical or logical lane divider on the road. More...
SYGeoCoordinate *	selectedPosition
	Represents the selected accessible position of the SYWaypoint. This is nil before route calculation. This is only available after route calculation. More...
NSArray< SYGeoCoordinate * > *	mappedPositions
	Represents list of accessible positions of the SYWaypoint. This is nil before route calculation. This is only available after route calculation. More...
SYWaypointType	type
	Determines the waypoint type. More...
SYWaypointStatus	status
	Determines if waypoint is reached or not. More...
NSString *	name
	Waypoint's name. More...
SYDistance	distanceFromStart
	Distance from route start in meters. More...
NSUInteger	delay
	Delay in seconds. More...

Detailed Description

Waypoints define a route's stopovers, including its start point it's destination point and any points in between.

Method Documentation

initWithPosition:type:name:

- (nonnull instancetype) initWithPosition:		(nonnull SYGeoCoordinate *)	position
type:		(SYWaypointType)	type
name:		(nullable NSString *)	name

Initializes a SYWaypoint instance with specified geocoordinates and type.

Property Documentation

originalPosition

- (SYGeoCoordinate*) originalPosition

readnonatomicassign

Position for flag/pin. The original position is required for a route calculation. By default, this is set to be the same as the geocoordinates provided during construction of this SYWaypoint.

navigablePosition

- (SYGeoCoordinate*) navigablePosition

readnonatomicassign

Represents the suggested navigable position of the SYWaypoint - typically the coordinates on the road closest to the original position - to be used in a route calculation. Working together with the navigable position, the original position is used by the Sygic SDK for determining the side of street during arrival, and to let the calculated route approach the correct side of street, especially when there there is a physical or logical lane divider on the road.

selectedPosition

- (SYGeoCoordinate*) selectedPosition

readnonatomicassign

Represents the selected accessible position of the SYWaypoint. This is nil before route calculation. This is only available after route calculation.

mappedPositions

- (NSArray<SYGeoCoordinate*>*) mappedPositions

readnonatomicassign

Represents list of accessible positions of the SYWaypoint. This is nil before route calculation. This is only available after route calculation.

type

- (SYWaypointType) type

readnonatomicassign

Determines the waypoint type.

status

- (SYWaypointStatus) status

readnonatomicassign

Determines if waypoint is reached or not.

name

- (NSString*) name

readnonatomicassign

Waypoint's name.

distanceFromStart

- (SYDistance) distanceFromStart

readnonatomicassign

Distance from route start in meters.

delay

- (NSUInteger) delay

readnonatomicassign

Delay in seconds.

---

The documentation for this class was generated from the following file:

• SYRoutingWaypoint.h