Represents an icon object on the location view. More...

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

Inheritance diagram for NCIconMapObject:

Instance Methods
(BOOL)	- setPosition:
	Method is used to specify the center of the icon.

(BOOL)	- setPositionAnimated:duration:type:
	Method is used to move the center of the icon with the specified animation.

(BOOL)	- setBitmap:
	Method is used to specify the bitmap image for the icon.

(BOOL)	- setSize:height:
	Method is used to specify the size of the icon.

(BOOL)	- setCollisionEnabled:
	Method is used to enable or disable collision detection for the icon.

(BOOL)	- setAngle:
	Method is used to specify the rotation angle of the icon.

(BOOL)	- setAngleAnimated:duration:type:
	Method is used to rotate the icon with the specified animation.

(BOOL)	- setBuffer:height:
	Method is used to specify the buffer size around the icon for collision detection.

(BOOL)	- setOffset:height:
	Method is used to specify an offset for the circle’s position.

(BOOL)	- setPriority:
	Method is used to specify the priority of the icon.

(BOOL)	- setFlat:
	Method is used to specify whether the icon is flat or billboarded.

(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

Represents an icon object on the location view.

Referenced from LocationWindow.

Note: IconMapObject maintains orientation to the screen surface by default.

Definition at line 25 of file NCIconMapObject.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.

◆ setAngle:

- (BOOL) setAngle: (float) angle

Method is used to specify the rotation angle of the icon.

Parameters

angle Rotation angle in degrees. Default: 0.

Returns: true if the operation is successful, false otherwise.

◆ setAngleAnimated:duration:type:

- (BOOL) setAngleAnimated:	(double)	angle
duration:	(float)	duration
type:	(NCAnimationType)	type

Method is used to rotate the icon with the specified animation.

Parameters

angle	Rotation angle in degrees.
duration	Animation duration in seconds.
type	Animation type AnimationType.

Returns: true if the operation is successful, false otherwise.

◆ setBitmap:

- (BOOL) setBitmap: (nullable UIImage *) bitmap

Method is used to specify the bitmap image for the icon.

Parameters

bitmap Platform bitmap object.

Returns: true if the operation is successful, false otherwise.

◆ setBuffer:height:

- (BOOL) setBuffer:		(float)	width
height:		(float)	height

Method is used to specify the buffer size around the icon for collision detection.

Parameters

width	Width of the buffer in pixels. Default: 0.
height	Height of the buffer in pixels. Default: 0.

Returns: true if the operation is successful, false otherwise.

◆ setCollisionEnabled:

- (BOOL) setCollisionEnabled: (BOOL) enabled

Method is used to enable or disable collision detection for the icon.

Parameters

enabled Specifies whether collision detection is enabled (true) or disabled (false). Default: false.

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.

◆ setFlat:

- (BOOL) setFlat: (BOOL) flat

Method is used to specify whether the icon is flat or billboarded.

Parameters

flat	If true, the icon aligns with the location view surface; if false, it maintains orientation to the screen surface. Default: false.

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.

◆ setOffset:height:

- (BOOL) setOffset:		(float)	width
height:		(float)	height

Method is used to specify an offset for the circle’s position.

Parameters

width	Horizontal offset in pixels.
height	Vertical offset in pixels.

Returns: true if the operation is successful, false otherwise.

◆ setPosition:

- (BOOL) setPosition: (nonnull NCLocationPoint *) point

Method is used to specify the center of the icon.

Parameters

point Metrics coordinates of the center LocationPoint.

Returns: true if the operation is successful, false otherwise.

◆ setPositionAnimated:duration:type:

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

Method is used to move the center of the icon with the specified animation.

Parameters

point	Metrics coordinates of the center LocationPoint.
duration	Animation duration in seconds.
type	Animation type AnimationType.

Returns: true if the operation is successful, false otherwise.

◆ setPriority:

- (BOOL) setPriority: (float) priority

Method is used to specify the priority of the icon.

Parameters

priority The priority value for rendering or interaction. Default: max.

Returns: true if the operation is successful, false otherwise.

◆ setSize:height:

- (BOOL) setSize:		(float)	width
height:		(float)	height

Method is used to specify the size of the icon.

Parameters

width	Width of the icon in pixels.
height	Height of the icon in pixels.

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:

NCIconMapObject.h

Instance Methods

Detailed Description

Method Documentation

◆ getData

◆ getId

◆ getType

◆ setAlpha:

◆ setAngle:

◆ setAngleAnimated:duration:type:

◆ setBitmap:

◆ setBuffer:height:

◆ setCollisionEnabled:

◆ setData:

◆ setFlat:

◆ setInteractive:

◆ setOffset:height:

◆ setPosition:

◆ setPositionAnimated:duration:type:

◆ setPriority:

◆ setSize:height:

◆ setTitle:

◆ setVisible: