NCMapObject Class Reference

Base interface for handling objects on the location view. More...

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

Inheritance diagram for NCMapObject:

Instance Methods
(int32_t)	- getId
	Gets the unique identifier of the map object.
(NCMapObjectType)	- getType
	Gets the type of the map object.
(nonnull NSData *)	- getData
	Gets the user-defined data associated with the map object.
(BOOL)	- setVisible:
	Method is used to specify the visibility of the map object.
(BOOL)	- setInteractive:
	Method is used to specify whether the map object can be interacted with.
(void)	- setData:
	Method is used to set user-defined data for the map object.
(BOOL)	- setTitle:
	Method is used to set the title of the map object.
(BOOL)	- setAlpha:
	Method is used to set the opacity of the map object.

Detailed Description

Base interface for handling objects on the location view.

Used to manage objects in LocationWindow. Can be handled in the pickMapObjectAt method LocationWindow.

Referenced from CircleMapObject, IconMapObject, PolylineMapObject, PolygonMapObject, DottedPolylineMapObject.

Definition at line 21 of file NCMapObject.h.

Method Documentation

getData

- (nonnull NSData *) getData

Gets the user-defined data associated with the map object.

Returns

The data stored in the map object.

getId

- (int32_t) getId

Gets the unique identifier of the map object.

Returns

The unique identifier of the map object.

getType

- (NCMapObjectType) getType

Gets the type of the map object.

Returns

The type of the map object map_object_type.

setAlpha:

- (BOOL) setAlpha:

(float)

alpha

Method is used to set the opacity of the map object.

Parameters

alpha

Opacity multiplier. Values below 0 will be set to 0. Values above 1 will be set to 1. Default: 1.

Returns

true if the operation is successful, false otherwise.

setData:

- (void) setData:

(nonnull NSData *)

data

Method is used to set user-defined data for the map object.

Parameters

data	Data to store in the map object.

Returns

true if the operation is successful, false otherwise.

setInteractive:

- (BOOL) setInteractive:

(BOOL)

interactive

Method is used to specify whether the map object can be interacted with.

Parameters

interactive

Specifies whether the object can be picked in the pickMapObjectAt method (true) or not (false). Default: false.

Returns

true if the operation is successful, false otherwise.

setTitle:

- (BOOL) setTitle:

(nonnull NSString *)

title

Method is used to set the title of the map object.

Parameters

title

The title to display on the location view.

Returns

true if the operation is successful, false otherwise.

setVisible:

- (BOOL) setVisible:

(BOOL)

visible

Method is used to specify the visibility of the map object.

Parameters

visible

Specifies whether the object is visible (true) or hidden (false). Default: true.

Returns

true if the operation is successful, false otherwise.

---

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

• NCMapObject.h