Represents a polyline object with points placed along it on the location view. More...

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

Inheritance diagram for NCDottedPolylineMapObject:

Instance Methods
(BOOL)	- setPolyLine:
	Method is used to specify the source polyline for the points.

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

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

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

(BOOL)	- setPlacement:
	Method is used to specify the placement mode for points along the polyline.

(BOOL)	- setPlacementMinRatio:
	Method is used to specify the minimum ratio of the polyline length for point placement.

(BOOL)	- setPlacementSpacing:
	Method is used to specify the spacing between points for spaced placement.

(BOOL)	- setRepeatDistance:
	Method is used to specify the distance interval for repeating points along the polyline.

(BOOL)	- setRepeatGroup:
	Method is used to specify the group identifier for repeating points.

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

(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 polyline object with points placed along it on the location view.

Referenced from LocationWindow.

Definition at line 20 of file NCDottedPolylineMapObject.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.

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

◆ setColor:green:blue:alpha:

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

Method is used to specify the color of the object.

Parameters

red	Red RGBA component.
green	Green RGBA component.
blue	Blue RGBA component.
alpha	Opacity multiplier. 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 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.

◆ setPlacement:

- (BOOL) setPlacement: (NCPlacement) placement

Method is used to specify the placement mode for points along the polyline.

Parameters

placement The placement mode placement. Default: VERTEX.

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

◆ setPlacementMinRatio:

- (BOOL) setPlacementMinRatio: (float) ratio

Method is used to specify the minimum ratio of the polyline length for point placement.

Parameters

ratio The minimum ratio of the polyline length (typically between 0 and 1). Default: 1.0.

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

◆ setPlacementSpacing:

- (BOOL) setPlacementSpacing: (float) spacing

Method is used to specify the spacing between points for spaced placement.

Parameters

spacing The spacing distance in pixels. Default: 80.

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

◆ setPolyLine:

- (BOOL) setPolyLine: (nonnull NCLocationPolyline *) polyline

Method is used to specify the source polyline for the points.

Parameters

polyline Metrics coordinates of the polyline LocationPolyline.

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.

◆ setRepeatDistance:

- (BOOL) setRepeatDistance: (float) distance

Method is used to specify the distance interval for repeating points along the polyline.

Parameters

distance The repeat distance in pixels. Default: 0.

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

◆ setRepeatGroup:

- (BOOL) setRepeatGroup: (int32_t) group

Method is used to specify the group identifier for repeating points.

Parameters

group The group identifier for point repetition. Default: 0.

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

Parameters

width	Width of the points in pixels.
height	Height of the points 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:

NCDottedPolylineMapObject.h

Instance Methods

Detailed Description

Method Documentation

◆ getData

◆ getId

◆ getType

◆ setAlpha:

◆ setCollisionEnabled:

◆ setColor:green:blue:alpha:

◆ setData:

◆ setInteractive:

◆ setPlacement:

◆ setPlacementMinRatio:

◆ setPlacementSpacing:

◆ setPolyLine:

◆ setPriority:

◆ setRepeatDistance:

◆ setRepeatGroup:

◆ setSize:height:

◆ setTitle:

◆ setVisible: