NMRoutePlanPoint Class Reference

Inherits <NSObject>, and <NSObject>.

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithCoordinates:
(instancetype)	- initWithCoordinates:course:
(instancetype)	- initWithPosition:
(nullable instancetype)	- NS_UNAVAILABLE
(nullable instancetype)	- initWithCoordinates:
(nullable instancetype)	- initWithCoordinates:course:
(nullable instancetype)	- initWithPosition:

Class Methods
(instancetype)	+ NS_UNAVAILABLE
(instancetype)	+ routePlanPointWithCoordinates:
(instancetype)	+ routePlanPointWithCoordinates:course:
(instancetype)	+ routePlanPointWithPosition:
(nullable instancetype)	+ NS_UNAVAILABLE
(nullable instancetype)	+ routePlanPointWithCoordinates:
(nullable instancetype)	+ routePlanPointWithCoordinates:course:
(nullable instancetype)	+ routePlanPointWithPosition:

Properties
BOOL	snapped
NMMapCoordinates *	coordinates
float	course

Detailed Description

Interface describing route plan point.

Method Documentation

initWithCoordinates:() [1/2]

- (nullable instancetype) initWithCoordinates:

(nonnull NMMapCoordinates *)

coordinates

Initializes route plan point with the specified coordinates. If route plan point was initialized using this method, course property returns default -1.0f value. Route plan point is not snapped, therefore snapped property returns 'NO'.

Parameters

coordinates

@nonnull Route plan point geo coordinates.

initWithCoordinates:() [2/2]

- (instancetype) initWithCoordinates:

(nonnull NMMapCoordinates *)

coordinates

Initializes route plan point with the specified coordinates. If route plan point was initialized using this method, course property returns default -1.0f value. Route plan point is not snapped, therefore snapped property returns 'NO'.

Parameters

coordinates

@nonnull Route plan point geo coordinates.

initWithCoordinates:course:() [1/2]

- (nullable instancetype) initWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
course:		(float)	course

Initializes route plan point with the specified coordinates and course. Route plan point is not snapped, therefore snapped property returns 'NO'.

Parameters

coordinates	@nonnull Route plan point geo coordinates;
course	Route plan point course from North clockwise. [0..360).

initWithCoordinates:course:() [2/2]

- (instancetype) initWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
course:		(float)	course

Initializes route plan point with the specified coordinates and course. Route plan point is not snapped, therefore snapped property returns 'NO'.

Parameters

coordinates	@nonnull Route plan point geo coordinates;
course	Route plan point course from North clockwise. [0..360).

initWithPosition:() [1/2]

- (nullable instancetype) initWithPosition:

(nonnull NMPosition *)

position

Initializes object using the specified position.

Parameters

position

@nonnull Position to initialize route plan point with.

initWithPosition:() [2/2]

- (instancetype) initWithPosition:

(nonnull NMPosition *)

position

Initializes object using the specified position.

Parameters

position

@nonnull Position to initialize route plan point with.

NS_UNAVAILABLE() [1/4]

- (nullable instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

NS_UNAVAILABLE() [2/4]

+ (nullable instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE() [3/4]

+ (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE() [4/4]

- (instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

routePlanPointWithCoordinates:() [1/2]

+ (nullable instancetype) routePlanPointWithCoordinates:

(nonnull NMMapCoordinates *)

coordinates

Creates route plan point with the specified coordinates. If route plan point was initialized using this method, course property returns default -1.0f value. Route plan point is not snapped, therefore snapped property returns 'NO'.

Parameters

coordinates

@nonnull Route plan point geo coordinates.

routePlanPointWithCoordinates:() [2/2]

+ (instancetype) routePlanPointWithCoordinates:

(nonnull NMMapCoordinates *)

coordinates

Creates route plan point with the specified coordinates. If route plan point was initialized using this method, course property returns default -1.0f value. Route plan point is not snapped, therefore snapped property returns 'NO'.

Parameters

coordinates

@nonnull Route plan point geo coordinates.

routePlanPointWithCoordinates:course:() [1/2]

+ (nullable instancetype) routePlanPointWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
course:		(float)	course

Creates route plan point with the specified coordinates and course. Route plan point is not snapped, therefore snapped property returns 'NO'.

Parameters

coordinates	@nonnull Route plan point geo coordinates;
course	Route plan point course from North clockwise. [0..360).

routePlanPointWithCoordinates:course:() [2/2]

+ (instancetype) routePlanPointWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
course:		(float)	course

Creates route plan point with the specified coordinates and course. Route plan point is not snapped, therefore snapped property returns 'NO'.

Parameters

coordinates	@nonnull Route plan point geo coordinates;
course	Route plan point course from North clockwise. [0..360).

routePlanPointWithPosition:() [1/2]

+ (nullable instancetype) routePlanPointWithPosition:

(nonnull NMPosition *)

position

Creates object using the specified position.

Parameters

position

@nonnull Position to initialize route plan point with.

routePlanPointWithPosition:() [2/2]

+ (instancetype) routePlanPointWithPosition:

(nonnull NMPosition *)

position

Creates object using the specified position.

Parameters

position

@nonnull Position to initialize route plan point with.

Property Documentation

coordinates

- (NMMapCoordinates *) coordinates

readnonatomicstrong

Route plan point geo coordinates.

course

- (float) course

readnonatomicassign

Route plan point course from North clockwise. [0..360). If course is not available -1.0f is returned.

snapped

- (BOOL) snapped

readnonatomicassign

Indicates whether route plan point considered as snapped. The only way to initialize a snapped route plan point is to construct it from a snapped position using initWithPosition: method.