Represents a polyline object on the location view. More...

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

Inheritance diagram for NCPolylineMapObject:

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

(BOOL)	- setWidth:
	Method is used to specify the width of the polyline.

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

(BOOL)	- setOrder:
	Method is used to specify the rendering order of the polyline.

(BOOL)	- setCapType:
	Method is used to specify the cap style for the polyline ends.

(BOOL)	- setJoinType:
	Method is used to specify the join style for polyline segments.

(BOOL)	- setMiterLimit:
	Method is used to specify the miter limit for miter joins.

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

(BOOL)	- setOutlineWidth:
	Method is used to specify the width of the polyline’s outline.

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

(BOOL)	- setOutlineCapType:
	Method is used to specify the cap style for the polyline’s outline ends.

(BOOL)	- setOutlineJoinType:
	Method is used to specify the join style for the polyline’s outline segments.

(BOOL)	- setOutlineMiterLimit:
	Method is used to specify the miter limit for the polyline’s outline miter joins.

(BOOL)	- setOutlineOrder:
	Method is used to specify the rendering order of the polyline’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 polyline object on the location view.

Referenced from LocationWindow.

Definition at line 21 of file NCPolylineMapObject.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.

◆ setCapType:

- (BOOL) setCapType: (NCCapType) cap

Method is used to specify the cap style for the polyline ends.

Parameters

cap	The cap type cap_type. Default: BUTT.

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

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.

◆ setJoinType:

- (BOOL) setJoinType: (NCJoinType) join

Method is used to specify the join style for polyline segments.

Parameters

join	The join type join_type. Default: MITER.

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

◆ setMiterLimit:

- (BOOL) setMiterLimit: (float) miterLimit

Method is used to specify the miter limit for miter joins.

Parameters

miterLimit The miter limit value for miter joins. Default: 3.

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

◆ setOrder:

- (BOOL) setOrder: (int32_t) order

Method is used to specify the rendering order of the polyline.

Parameters

order The rendering order value. Default: 0.

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

◆ setOutlineAlpha:

- (BOOL) setOutlineAlpha: (float) alpha

Method is used to specify the opacity of the polyline’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.

◆ setOutlineCapType:

- (BOOL) setOutlineCapType: (NCCapType) cap

Method is used to specify the cap style for the polyline’s outline ends.

Parameters

cap	The cap type cap_type. Default: BUTT.

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 polyline’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.

◆ setOutlineJoinType:

- (BOOL) setOutlineJoinType: (NCJoinType) join

Method is used to specify the join style for the polyline’s outline segments.

Parameters

join	The join type join_type. Default: MITER.

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

◆ setOutlineMiterLimit:

- (BOOL) setOutlineMiterLimit: (float) miterLimit

Method is used to specify the miter limit for the polyline’s outline miter joins.

Parameters

miterLimit The miter limit value for outline miter joins. Default: 3.

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

◆ setOutlineOrder:

- (BOOL) setOutlineOrder: (int32_t) order

Method is used to specify the rendering order of the polyline’s outline.

Parameters

order The rendering order value for the outline. Default: 0.

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

◆ setOutlineWidth:

- (BOOL) setOutlineWidth: (float) radius

Method is used to specify the width of the polyline’s outline.

Parameters

radius Width of the outline in pixels.

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

◆ setPolyLine:

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

Method is used to specify the source polyline of the object.

Parameters

polyline Metrics coordinates of the polyline LocationPolyline.

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.

◆ setWidth:

- (BOOL) setWidth: (float) width

Method is used to specify the width of the polyline.

Parameters

width Width of the polyline in pixels.

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

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

NCPolylineMapObject.h

Instance Methods

Detailed Description

Method Documentation

◆ getData

◆ getId

◆ getType

◆ setAlpha:

◆ setCapType:

◆ setColor:green:blue:alpha:

◆ setData:

◆ setInteractive:

◆ setJoinType:

◆ setMiterLimit:

◆ setOrder:

◆ setOutlineAlpha:

◆ setOutlineCapType:

◆ setOutlineColor:green:blue:alpha:

◆ setOutlineJoinType:

◆ setOutlineMiterLimit:

◆ setOutlineOrder:

◆ setOutlineWidth:

◆ setPolyLine:

◆ setTitle:

◆ setVisible:

◆ setWidth: