Loading...
Searching...
No Matches
com.navigine.idl.java.PolygonMapObject Class Referenceabstract

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

+ Inheritance diagram for com.navigine.idl.java.PolygonMapObject:

Public Member Functions

abstract boolean setPolygon (LocationPolygon polygon)
 Method is used to specify the source polygon of the object.
 
abstract boolean setColor (float red, float green, float blue, float alpha)
 Method is used to specify the color of the object.
 
abstract boolean setOrder (int order)
 Method is used to specify the rendering order of the object.
 
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 polygon object on the location view.

Referenced from LocationWindow.

Definition at line 18 of file PolygonMapObject.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
alphaOpacity 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.

◆ setColor()

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

Method is used to specify the color of the object.

Parameters
redRed RGBA component.
greenGreen RGBA component.
blueBlue RGBA component.
alphaOpacity multiplier. Values below 0 will be set to 0. Default: 1.
Returns
true if success, 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
dataData 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
interactiveSpecifies 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.

◆ setOrder()

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

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

Parameters
orderThe rendering order value. Default: 0.
Returns
true if success, false otherwise.

◆ setPolygon()

abstract boolean com.navigine.idl.java.PolygonMapObject.setPolygon ( LocationPolygon polygon)
abstract

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

Parameters
polygonMetrics coordinates of the polygon LocationPolygon.
Returns
true if success, 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
titleThe 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
visibleSpecifies 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: