OnlineMapsDrawingLine Class Reference

Class that draws a line on the map. More...

Inheritance diagram for OnlineMapsDrawingLine:

Public Member Functions
	OnlineMapsDrawingLine ()
	Creates a new line.
	OnlineMapsDrawingLine (IEnumerable points)
	Creates a new line.
	OnlineMapsDrawingLine (IEnumerable points, Color color)
	Creates a new line.
	OnlineMapsDrawingLine (IEnumerable points, Color color, float width)
	Creates a new line.
override void	Draw (Color32[] buffer, Vector2 bufferPosition, int bufferWidth, int bufferHeight, float zoom, bool invertY=false)
	Draw element on the map.
override void	DrawOnTileset (OnlineMapsTileSetControl control, int index)
	Draws element on a specified TilesetControl.
override bool	HitTest (Vector2 positionLngLat, int zoom)
	Determines if the drawing element at the specified coordinates.
override bool	Validate ()
	Validate drawing element.
Public Member Functions inherited from OnlineMapsDrawingElement
virtual void	DestroyInstance ()
	Destroys the instance of the drawing element.
void	Dispose ()
	Dispose drawing element.

Public Attributes
bool	followRelief = false
	Forces the line to follow the relief.
float?	hitTestWidth
	Sets the line width used for HitTest.
Public Attributes inherited from OnlineMapsDrawingElement
Action< OnlineMapsDrawingElement >	OnClick
	Events that occur when user click on the drawing element.
Action< OnlineMapsDrawingElement >	OnDoubleClick
	Events that occur when user double click on the drawing element.
Action< OnlineMapsDrawingElement >	OnDrawTooltip
	Event caused to draw tooltip.
Action< OnlineMapsDrawingElement, Renderer >	OnInitMesh
	Event that occur when tileset initializes a mesh.
Action< OnlineMapsDrawingElement >	OnLongPress
	Events that occur when user long press on the drawing element.
Action< OnlineMapsDrawingElement >	OnPress
	Events that occur when user press on the drawing element.
Action< OnlineMapsDrawingElement >	OnRelease
	Events that occur when user release on the drawing element.
bool	checkMapBoundaries = true
	Need to check the map boundaries? It allows you to make drawing element, which are active outside the map.
OnlineMapsRange	range
	Zoom range, in which the drawing element will be displayed.
string	tooltip
	Tooltip that is displayed when user hover on the drawing element.
float	yOffset = 0
	The local Y position for the GameObject on Tileset.

Properties
Color	color [get, set]
	Color of the line.
Texture2D	texture [get, set]
	Texture of line. Uses only in tileset.
IEnumerable	points [get, set]
	IEnumerable of points of the line. Geographic coordinates. Can be: IEnumerable<Vector2>, where X - longitide, Y - latitude, IEnumerable<float> or IEnumerable<double>, where values (lng, lat, lng, lat... etc).
float	width [get, set]
	Width of the line.
Properties inherited from OnlineMapsDrawingElement
object	this[string key] [get, set]
	Gets or sets custom data by key.
virtual bool	active [get, set]
	Gets or sets the active state of the drawing element GameObject.
bool	createBackgroundMaterial [get]
	Creates a background material for the drawing element.
Dictionary< string, object >	customFields [get]
	Gets custom fields.
virtual OnlineMapsVector2d	center [get]
	Center point of the drawing element.
virtual string	defaultName [get]
	Default name of the drawing element.
OnlineMapsElevationManagerBase	elevationManager [get]
	Gets the elevation manager.
bool	hasElevation [get]
	Checks if the elevation is used.
GameObject	instance [get]
	Instance of the drawing element.
IOnlineMapsInteractiveElementManager	manager [get, set]
	Reference to DrawingElementManager.
string	name [get, set]
	Gets or sets the name of the drawing element.
int	renderQueueOffset [get, set]
	Gets or sets the render queue offset.
virtual bool	splitToPieces [get]
	Should the drawing element be split into pieces?
virtual bool	visible [get, set]
	Gets or sets the visibility of the drawing element.

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.
Static Public Attributes inherited from OnlineMapsDrawingElement
static Action< OnlineMapsDrawingElement >	OnElementDrawTooltip
	Default event caused to draw tooltip.

Detailed Description

Class that draws a line on the map.

Constructor & Destructor Documentation

OnlineMapsDrawingLine() [1/3]

OnlineMapsDrawingLine.OnlineMapsDrawingLine

(

IEnumerable

points

)

Creates a new line.

Parameters

points

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

OnlineMapsDrawingLine() [2/3]

OnlineMapsDrawingLine.OnlineMapsDrawingLine	(	IEnumerable	points,
		Color	color )

Creates a new line.

Parameters

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

OnlineMapsDrawingLine() [3/3]

OnlineMapsDrawingLine.OnlineMapsDrawingLine	(	IEnumerable	points,
		Color	color,
		float	width )

Creates a new line.

Parameters

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

Member Function Documentation

Draw()

override void OnlineMapsDrawingLine.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 OnlineMapsDrawingLine.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 OnlineMapsDrawingLine.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 OnlineMapsDrawingLine.Validate ( )

virtual

Validate drawing element.

Returns

The result of validation.

Reimplemented from OnlineMapsDrawingElement.