PolygonMapObject Class Reference

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

Inheritance diagram for PolygonMapObject:

Public Member Functions
bool	setPolygon (LocationPolygon polygon)
	Method is used to specify the source polygon of the object.
bool	setColor (double red, double green, double blue, double alpha)
	Method is used to specify the color of the object.
bool	setOrder (int order)
	Method is used to specify the rendering order of the object.
int	getId ()
	Gets the unique identifier of the map object.
MapObjectType	getType ()
	Gets the type of the map object.
Uint8List	getData ()
	Gets the user-defined data associated with the map object.
bool	setVisible (bool visible)
	Method is used to specify the visibility of the map object.
bool	setInteractive (bool interactive)
	Method is used to specify whether the map object can be interacted with.
void	setData (Uint8List data)
	Method is used to set user-defined data for the map object.
bool	setTitle (String title)
	Method is used to set the title of the map object.
bool	setAlpha (double 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 24 of file polygon_map_object.dart.

Member Function Documentation

getData()

Uint8List MapObject.getData ( )

inherited

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

Returns

The data stored in the map object.

getId()

int MapObject.getId ( )

inherited

Gets the unique identifier of the map object.

Returns

The unique identifier of the map object.

getType()

MapObjectType MapObject.getType ( )

inherited

Gets the type of the map object.

Returns

The type of the map object map_object_type.

setAlpha()

bool MapObject.setAlpha ( double alpha )

inherited

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.

setColor()

bool PolygonMapObject.setColor	(	double	red,
		double	green,
		double	blue,
		double	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 MapObject.setData ( Uint8List data )

inherited

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 MapObject.setInteractive ( bool interactive )

inherited

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.

setOrder()

bool PolygonMapObject.setOrder

(

int

order

)

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

Parameters

order

The rendering order value. Default: 0.

Returns

true if success, false otherwise.

setPolygon()

bool PolygonMapObject.setPolygon

(

LocationPolygon

polygon

)

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

Parameters

polygon

Metrics coordinates of the polygon LocationPolygon.

Returns

true if success, false otherwise.

setTitle()

bool MapObject.setTitle ( String title )

inherited

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 MapObject.setVisible ( bool visible )

inherited

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:

• polygon_map_object.dart