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

Inheritance diagram for com.navigine.idl.java.PolylineMapObject:

Public Member Functions
abstract boolean	setPolyLine (LocationPolyline polyline)
	Method is used to specify the source polyline of the object.

abstract boolean	setWidth (float width)
	Method is used to specify the width of the polyline.

abstract boolean	setColor (float red, float green, float blue, float alpha)
	Method is used to specify the fill color of the polyline.

abstract boolean	setOrder (int order)
	Method is used to specify the rendering order of the polyline.

abstract boolean	setCapType (CapType cap)
	Method is used to specify the cap style for the polyline ends.

abstract boolean	setJoinType (JoinType join)
	Method is used to specify the join style for polyline segments.

abstract boolean	setMiterLimit (float miterLimit)
	Method is used to specify the miter limit for miter joins.

abstract boolean	setOutlineColor (float red, float green, float blue, float alpha)
	Method is used to specify the color of the polyline’s outline.

abstract boolean	setOutlineWidth (float radius)
	Method is used to specify the width of the polyline’s outline.

abstract boolean	setOutlineAlpha (float alpha)
	Method is used to specify the opacity of the polyline’s outline.

abstract boolean	setOutlineCapType (CapType cap)
	Method is used to specify the cap style for the polyline’s outline ends.

abstract boolean	setOutlineJoinType (JoinType join)
	Method is used to specify the join style for the polyline’s outline segments.

abstract boolean	setOutlineMiterLimit (float miterLimit)
	Method is used to specify the miter limit for the polyline’s outline miter joins.

abstract boolean	setOutlineOrder (int order)
	Method is used to specify the rendering order of the polyline’s outline.

abstract int	getId ()
	Gets the unique identifier of the map object.

abstract MapObjectType	getType ()
	Gets the type of the map object.

abstract byte[]	getData ()
	Gets the user-defined data associated with the map object.

abstract boolean	setVisible (boolean visible)
	Method is used to specify the visibility of the map object.

abstract boolean	setInteractive (boolean interactive)
	Method is used to specify whether the map object can be interacted with.

abstract void	setData (byte[] data)
	Method is used to set user-defined data for the map object.

abstract boolean	setTitle (String title)
	Method is used to set the title of the map object.

abstract boolean	setAlpha (float alpha)
	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 16 of file PolylineMapObject.java.

Member Function Documentation

◆ getData()

abstract byte[] com.navigine.idl.java.MapObject.getData ( )

abstractinherited

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

Returns: The data stored in the map object.

◆ getId()

abstract int com.navigine.idl.java.MapObject.getId ( )

abstractinherited

Gets the unique identifier of the map object.

Returns: The unique identifier of the map object.

◆ getType()

abstract MapObjectType com.navigine.idl.java.MapObject.getType ( )

abstractinherited

Gets the type of the map object.

Returns: The type of the map object map_object_type.

◆ setAlpha()

abstract boolean com.navigine.idl.java.MapObject.setAlpha ( float alpha )

abstractinherited

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setCapType ( CapType cap )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setColor	(	float	red,
		float	green,
		float	blue,
		float	alpha )

abstract

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()

abstract void com.navigine.idl.java.MapObject.setData ( byte[] data )

abstractinherited

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()

abstract boolean com.navigine.idl.java.MapObject.setInteractive ( boolean interactive )

abstractinherited

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setJoinType ( JoinType join )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setMiterLimit ( float miterLimit )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setOrder ( int order )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setOutlineAlpha ( float alpha )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setOutlineCapType ( CapType cap )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setOutlineColor	(	float	red,
		float	green,
		float	blue,
		float	alpha )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setOutlineJoinType ( JoinType join )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setOutlineMiterLimit ( float miterLimit )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setOutlineOrder ( int order )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setOutlineWidth ( float radius )

abstract

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setPolyLine ( LocationPolyline polyline )

abstract

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()

abstract boolean com.navigine.idl.java.MapObject.setTitle ( String title )

abstractinherited

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()

abstract boolean com.navigine.idl.java.MapObject.setVisible ( boolean visible )

abstractinherited

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()

abstract boolean com.navigine.idl.java.PolylineMapObject.setWidth ( float width )

abstract

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:

PolylineMapObject.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ getData()

◆ getId()

◆ getType()

◆ setAlpha()

◆ setCapType()

◆ setColor()

◆ setData()

◆ setInteractive()

◆ setJoinType()

◆ setMiterLimit()

◆ setOrder()

◆ setOutlineAlpha()

◆ setOutlineCapType()

◆ setOutlineColor()

◆ setOutlineJoinType()

◆ setOutlineMiterLimit()

◆ setOutlineOrder()

◆ setOutlineWidth()

◆ setPolyLine()

◆ setTitle()

◆ setVisible()

◆ setWidth()