NCCircleMapObject Class Reference

represents circle on location view. More...

#include <com/navigine/idl/objc/NCCircleMapObject.h>

Inheritance diagram for NCCircleMapObject:

Instance Methods
(BOOL)	- setPosition:
	Method is used to specify center of object.
(BOOL)	- setPositionAnimated:duration:type:
(BOOL)	- setColor:green:blue:alpha:
	Method is used to specify color of object.
(BOOL)	- setRadius:
	Method is used to specify size of object.
(int32_t)	- getId
	Unique identifier of map object.
(NCMapObjectType)	- getType
	Map object type MapObjectType. Map object could be casted to the specified type.
(nonnull NSData *)	- getData
	Any kind of user's data.
(BOOL)	- setVisible:
	Method is used to change visibility of map object.
(BOOL)	- setInteractive:
	Method is used to interactive property If True - map object could be handled in pickMapObjectAt method.
(BOOL)	- setStyle:
	Method is used to apply custom styling to map object.
(void)	- setData:
	Method is used to set any kind of user's data.
(BOOL)	- setTitle:
	Method is used to set object title. Title will shown on location view.

Detailed Description

represents circle on location view.

Referenced from LocationWindow.

Definition at line 22 of file NCCircleMapObject.h.

Method Documentation

getData

- (nonnull NSData *) getData

Any kind of user's data.

Returns

Data stored in map object MapObjectType.

getId

- (int32_t) getId

Unique identifier of map object.

Returns

Unique identifier of current map objcet MapObjectType

getType

- (NCMapObjectType) getType

Map object type MapObjectType. Map object could be casted to the specified type.

Returns

Type of current map objcet MapObjectType.

setColor:green:blue:alpha:

- (BOOL) setColor:		(float)	red
green:		(float)	green
blue:		(float)	blue
alpha:		(float)	alpha

Method is used to specify color of object.

Parameters

red	red RGBA component.
green	green RGBA component.
blue	blue RGBA component.
alpha	Opacity multiplicator. Values below 0 will be set to 0. Default: 1.

Returns

true if success, false otherwise.

setData:

- (void) setData:

(nonnull NSData *)

data

Method is used to set any kind of user's data.

Parameters

data	Data to store in map object

setInteractive:

- (BOOL) setInteractive:

(BOOL)

interactive

Method is used to interactive property If True - map object could be handled in pickMapObjectAt method.

Parameters

interactive

control interactivity of the object.

Returns

true if success, false otherwise.

setPosition:

- (BOOL) setPosition:

(nonnull NCLocationPoint *)

point

Method is used to specify center of object.

Parameters

point

metrics coordinate of center LocationPoint.

Returns

true if success, false otherwise.

setPositionAnimated:duration:type:

- (BOOL) setPositionAnimated:		(nonnull NCLocationPoint *)	point
duration:		(float)	duration
type:		(NCAnimationType)	type

Method is used to move center of object with specified animation LocationPoint.

Parameters

point	metrics coordinate of center LocationPoint.
duration	animation duration in seconds.
type	AnimationType.

Returns

true if success, false otherwise.

setRadius:

- (BOOL) setRadius:

(float)

radius

Method is used to specify size of object.

Parameters

radius

metrics radius of circle.

Returns

true if success, false otherwise.

setStyle:

- (BOOL) setStyle:

(nonnull NSString *)

style

Method is used to apply custom styling to map object.

Parameters

style

styling string (Style parameters).

Returns

true if success, false otherwise.

setTitle:

- (BOOL) setTitle:

(nonnull NSString *)

title

Method is used to set object title. Title will shown on location view.

Parameters

title

of map object.

Returns

true if success, false otherwise.

setVisible:

- (BOOL) setVisible:

(BOOL)

visible

Method is used to change visibility of map object.

Parameters

visible

control visibility of the object.

Returns

true if success, false otherwise.

---

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

• NCCircleMapObject.h