Class draws a closed polygon on the map. More...

Inheritance diagram for OnlineMapsDrawingPoly:

Public Member Functions
	OnlineMapsDrawingPoly ()
	Creates a new polygon. More...

	OnlineMapsDrawingPoly (IEnumerable points)
	Creates a new polygon. More...

	OnlineMapsDrawingPoly (IEnumerable points, Color borderColor)
	Creates a new polygon. More...

	OnlineMapsDrawingPoly (IEnumerable points, Color borderColor, float borderWidth)
	Creates a new polygon. More...

	OnlineMapsDrawingPoly (IEnumerable points, Color borderColor, float borderWidth, Color backgroundColor)
	Creates a new polygon. More...

override void	Draw (Color32[] buffer, Vector2 bufferPosition, int bufferWidth, int bufferHeight, float zoom, bool invertY=false)
	Draw element on the map. More...

override void	DrawOnTileset (OnlineMapsTileSetControl control, int index)
	Draws element on a specified TilesetControl. More...

override bool	HitTest (Vector2 positionLngLat, int zoom)
	Determines if the drawing element at the specified coordinates. More...

override bool	Validate ()
	Validate drawing element. More...

Public Member Functions inherited from OnlineMapsDrawingElement
virtual void	DestroyInstance ()
	Destroys the instance of the drawing element. More...

void	Dispose ()
	Dispose drawing element. More...

Properties
Color	backgroundColor `[get, set]`
	Background color of the polygon. Note: Not supported in tileset. More...

Color	borderColor `[get, set]`
	Border color of the polygon. More...

float	borderWidth `[get, set]`
	Border width of the polygon. More...

IEnumerable	points `[get, set]`
	IEnumerable of points of the polygon. Geographic coordinates. The values can be of type: Vector2, float, double. If values float or double, the value should go in pairs(longitude, latitude). More...

override OnlineMapsVector2d	center `[get]`
	Center point of the polygon. More...

Properties inherited from OnlineMapsDrawingElement
object?	this[string key] `[get, set]`
	Gets or sets custom data by key. More...

virtual bool	active `[get, set]`
	Gets or sets the active state of the drawing element GameObject. More...

abstract bool	createBackgroundMaterial `[get]`
	Creates a background material for the drawing element. More...

Dictionary< string, object >	customFields `[get]`
	Gets custom fields. More...

virtual OnlineMapsVector2d	center `[get]`
	Center point of the drawing element. More...

virtual string	defaultName `[get]`
	Default name of the drawing element. More...

OnlineMapsElevationManagerBase	elevationManager `[get]`
	Gets the elevation manager. More...

bool	hasElevation `[get]`
	Checks if the elevation is used. More...

GameObject	instance `[get]`
	Instance of the drawing element. More...

IOnlineMapsInteractiveElementManager?	manager `[get, set]`
	Reference to DrawingElementManager. More...

string	name `[get, set]`
	Gets or sets the name of the drawing element. More...

int	renderQueueOffset `[get, set]`
	Gets or sets the render queue offset. More...

virtual bool	splitToPieces `[get]`
	Should the drawing element be split into pieces? More...

virtual bool	visible `[get, set]`
	Gets or sets the visibility of the drawing element. More...

Additional Inherited Members
Static Public Member Functions inherited from OnlineMapsDrawingElement
static void	MarkChanged ()
	It marks the elements changed. It is used for the Drawing API as an overlay. More...

Public Attributes inherited from OnlineMapsDrawingElement
Action< OnlineMapsDrawingElement >	OnClick
	Events that occur when user click on the drawing element. More...

Action< OnlineMapsDrawingElement >	OnDoubleClick
	Events that occur when user double click on the drawing element. More...

Action< OnlineMapsDrawingElement >	OnDrawTooltip
	Event caused to draw tooltip. More...

Action< OnlineMapsDrawingElement, Renderer >	OnInitMesh
	Event that occur when tileset initializes a mesh. More...

Action< OnlineMapsDrawingElement >	OnLongPress
	Events that occur when user long press on the drawing element. More...

Action< OnlineMapsDrawingElement >	OnPress
	Events that occur when user press on the drawing element. More...

Action< OnlineMapsDrawingElement >	OnRelease
	Events that occur when user release on the drawing element. More...

bool	checkMapBoundaries = true
	Need to check the map boundaries? It allows you to make drawing element, which are active outside the map. More...

OnlineMapsRange	range
	Zoom range, in which the drawing element will be displayed. More...

string	tooltip
	Tooltip that is displayed when user hover on the drawing element. More...

float	yOffset = 0
	The local Y position for the GameObject on Tileset. More...

Static Public Attributes inherited from OnlineMapsDrawingElement
static Action< OnlineMapsDrawingElement >	OnElementDrawTooltip
	Default event caused to draw tooltip. More...

Detailed Description

Class draws a closed polygon on the map.

Constructor & Destructor Documentation

◆ OnlineMapsDrawingPoly() [1/5]

OnlineMapsDrawingPoly.OnlineMapsDrawingPoly ( )

Creates a new polygon.

◆ OnlineMapsDrawingPoly() [2/5]

OnlineMapsDrawingPoly.OnlineMapsDrawingPoly ( IEnumerable points )

Creates a new polygon.

Parameters

points IEnumerable of points of the polygon. Geographic coordinates.
The values can be of type: Vector2, float, double.
If values float or double, the value should go in pairs(longitude, latitude).

◆ OnlineMapsDrawingPoly() [3/5]

OnlineMapsDrawingPoly.OnlineMapsDrawingPoly	(	IEnumerable	points,
		Color	borderColor
	)

Creates a new polygon.

Parameters

points	IEnumerable of points of the polygon. Geographic coordinates. The values can be of type: Vector2, float, double. If values float or double, the value should go in pairs(longitude, latitude).
borderColor	Border color of the polygon.

◆ OnlineMapsDrawingPoly() [4/5]

OnlineMapsDrawingPoly.OnlineMapsDrawingPoly	(	IEnumerable	points,
		Color	borderColor,
		float	borderWidth
	)

Creates a new polygon.

Parameters

points	IEnumerable of points of the polygon. Geographic coordinates. The values can be of type: Vector2, float, double. If values float or double, the value should go in pairs(longitude, latitude).
borderColor	Border color of the polygon.
borderWidth	Border width of the polygon.

◆ OnlineMapsDrawingPoly() [5/5]

OnlineMapsDrawingPoly.OnlineMapsDrawingPoly	(	IEnumerable	points,
		Color	borderColor,
		float	borderWidth,
		Color	backgroundColor
	)

Creates a new polygon.

Parameters

points	IEnumerable of points of the polygon. Geographic coordinates. The values can be of type: Vector2, float, double. If values float or double, the value should go in pairs(longitude, latitude).
borderColor	Border color of the polygon.
borderWidth	Border width of the polygon.
backgroundColor	Background color of the polygon. Note: Not supported in tileset.

Member Function Documentation

◆ Draw()

override void OnlineMapsDrawingPoly.Draw	(	Color32[]	buffer,
		Vector2	bufferPosition,
		int	bufferWidth,
		int	bufferHeight,
		float	zoom,
		bool	invertY = `false`
	)

virtual

Draw element on the map.

Parameters

buffer	Backbuffer
bufferPosition	Backbuffer position
bufferWidth	Backbuffer width
bufferHeight	Backbuffer height
zoom	Zoom of the map
invertY	Invert Y direction

Reimplemented from OnlineMapsDrawingElement.

◆ DrawOnTileset()

override void OnlineMapsDrawingPoly.DrawOnTileset	(	OnlineMapsTileSetControl	control,
		int	index
	)

virtual

Draws element on a specified TilesetControl.

Parameters

control	Reference to tileset control.
index	Index of drawing element

Reimplemented from OnlineMapsDrawingElement.

◆ HitTest()

override bool OnlineMapsDrawingPoly.HitTest	(	Vector2	positionLngLat,
		int	zoom
	)

virtual

Determines if the drawing element at the specified coordinates.

Parameters

positionLngLat	Position.
zoom	The zoom.

Returns: True if the drawing element in position, false if not.

Reimplemented from OnlineMapsDrawingElement.

◆ Validate()

override bool OnlineMapsDrawingPoly.Validate ( )

virtual

Validate drawing element.

Returns: The result of validation.

Reimplemented from OnlineMapsDrawingElement.

Property Documentation

◆ backgroundColor

Color OnlineMapsDrawingPoly.backgroundColor

getset

Background color of the polygon.
Note: Not supported in tileset.

◆ borderColor

Color OnlineMapsDrawingPoly.borderColor

getset

Border color of the polygon.

◆ borderWidth

float OnlineMapsDrawingPoly.borderWidth

getset

Border width of the polygon.

◆ center

override OnlineMapsVector2d OnlineMapsDrawingPoly.center

get

Center point of the polygon.

◆ points

IEnumerable OnlineMapsDrawingPoly.points

getset

IEnumerable of points of the polygon. Geographic coordinates.
The values can be of type: Vector2, float, double.
If values float or double, the value should go in pairs(longitude, latitude).

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OnlineMapsDrawingPoly() [1/5]

◆ OnlineMapsDrawingPoly() [2/5]

◆ OnlineMapsDrawingPoly() [3/5]

◆ OnlineMapsDrawingPoly() [4/5]

◆ OnlineMapsDrawingPoly() [5/5]

Member Function Documentation

◆ Draw()

◆ DrawOnTileset()

◆ HitTest()

◆ Validate()

Property Documentation

◆ backgroundColor

◆ borderColor

◆ borderWidth

◆ center

◆ points