Represents a circle on the location view. More...

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

Inheritance diagram for NCCircleMapObject:

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

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

(BOOL)	- setColor:green:blue:alpha:
	Method is used to specify the fill color of the circle.

(BOOL)	- setRadius:
	Method is used to specify the size of the circle.

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

(BOOL)	- setBuffer:height:
	Method is used to specify the buffer size around the circle 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 circle.

(BOOL)	- setOutlineColor:green:blue:alpha:
	Method is used to specify the color of the circle’s outline.

(BOOL)	- setOutlineRadius:
	Method is used to specify the thickness of the circle’s outline.

(BOOL)	- setOutlineAlpha:
	Method is used to specify the opacity of the circle’s outline.

(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 a circle on the location view.

Referenced from LocationWindow.

Definition at line 22 of file NCCircleMapObject.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.

◆ setBuffer:height:

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

Method is used to specify the buffer size around the circle 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 circle.

Parameters

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

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

◆ setColor:green:blue:alpha:

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

Method is used to specify the fill color of the circle.

Parameters

red	Red RGBA component (0 to 1).
green	Green RGBA component (0 to 1).
blue	Blue RGBA component (0 to 1).
alpha	Opacity multiplier (0 to 1). Values below 0 are set to 0. 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.

◆ 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.

◆ setOutlineAlpha:

- (BOOL) setOutlineAlpha: (float) alpha

Method is used to specify the opacity of the circle’s outline.

Parameters

alpha Opacity multiplier (0 to 1). Values below 0 are set to 0. Default: 1.

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

◆ setOutlineColor:green:blue:alpha:

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

Method is used to specify the color of the circle’s outline.

Parameters

red	Red RGBA component (0 to 1).
green	Green RGBA component (0 to 1).
blue	Blue RGBA component (0 to 1).
alpha	Opacity multiplier (0 to 1). Values below 0 are set to 0. Default: 1.

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

◆ setOutlineRadius:

- (BOOL) setOutlineRadius: (float) radius

Method is used to specify the thickness of the circle’s outline.

Parameters

radius Thickness of the outline 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 circle.

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 circle with the specified animation.

Parameters

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

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

◆ setPriority:

- (BOOL) setPriority: (float) priority

Method is used to specify the priority of the circle.

Parameters

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

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

◆ setRadius:

- (BOOL) setRadius: (float) radius

Method is used to specify the size of the circle.

Parameters

radius Radius of the circle in meters.

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:

NCCircleMapObject.h

Instance Methods

Detailed Description

Method Documentation

◆ getData

◆ getId

◆ getType

◆ setAlpha:

◆ setBuffer:height:

◆ setCollisionEnabled:

◆ setColor:green:blue:alpha:

◆ setData:

◆ setInteractive:

◆ setOffset:height:

◆ setOutlineAlpha:

◆ setOutlineColor:green:blue:alpha:

◆ setOutlineRadius:

◆ setPosition:

◆ setPositionAnimated:duration:type:

◆ setPriority:

◆ setRadius:

◆ setTitle:

◆ setVisible: