OnlineMapsDrawingRect Class Reference

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

Inheritance diagram for OnlineMapsDrawingRect:

Public Member Functions
	OnlineMapsDrawingRect (double x, double y, double width, double height)
	Creates a new rectangle.
	OnlineMapsDrawingRect (OnlineMapsVector2d position, OnlineMapsVector2d size)
	Creates a new rectangle.
	OnlineMapsDrawingRect (Rect rect)
	Creates a new rectangle.
	OnlineMapsDrawingRect (double x, double y, double width, double height, Color borderColor)
	Creates a new rectangle.
	OnlineMapsDrawingRect (OnlineMapsVector2d position, OnlineMapsVector2d size, Color borderColor)
	Creates a new rectangle.
	OnlineMapsDrawingRect (Rect rect, Color borderColor)
	Creates a new rectangle.
	OnlineMapsDrawingRect (double x, double y, double width, double height, Color borderColor, float borderWidth)
	Creates a new rectangle.
	OnlineMapsDrawingRect (OnlineMapsVector2d position, OnlineMapsVector2d size, Color borderColor, float borderWidth)
	Creates a new rectangle.
	OnlineMapsDrawingRect (Rect rect, Color borderColor, float borderWidth)
	Creates a new rectangle.
	OnlineMapsDrawingRect (double x, double y, double width, double height, Color borderColor, float borderWidth, Color backgroundColor)
	Creates a new rectangle.
	OnlineMapsDrawingRect (OnlineMapsVector2d position, OnlineMapsVector2d size, Color borderColor, float borderWidth, Color backgroundColor)
	Creates a new rectangle.
	OnlineMapsDrawingRect (Rect rect, Color borderColor, float borderWidth, Color backgroundColor)
	Creates a new rectangle.
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.

Properties
override OnlineMapsVector2d	center [get]
	Center point of the rectangle.
Color	backgroundColor [get, set]
	Background color of the rectangle.
Texture2D	backgroundTexture [get, set]
	Background texture of the rectangle. Currently works only for Tileset. For this to work correctly, also set backgroundColor.
Color	borderColor [get, set]
	Border color of the rectangle.
float	borderWidth [get, set]
	Border width of the rectangle.
double	width [get, set]
	Gets or sets the width of the rectangle. Geographic coordinates.
double	height [get, set]
	Gets or sets the height of the rectangle. Geographic coordinates.
double	x [get, set]
	Gets or sets the x position of the rectangle. Geographic coordinates.
double	y [get, set]
	Gets or sets the y position of the rectangle. Geographic coordinates.
OnlineMapsVector2d	topLeft [get, set]
	Coordinates of top-left corner.
OnlineMapsVector2d	topRight [get, set]
	Coordinates of top-right corner.
OnlineMapsVector2d	bottomLeft [get, set]
	Coordinates of bottom-left corner.
OnlineMapsVector2d	bottomRight [get, set]
	Coordinates of bottom-right corner.
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.
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.
Static Public Attributes inherited from OnlineMapsDrawingElement
static Action< OnlineMapsDrawingElement >	OnElementDrawTooltip
	Default event caused to draw tooltip.

Detailed Description

Class that draws a rectangle on the map.

Constructor & Destructor Documentation

OnlineMapsDrawingRect() [1/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	double	x,
		double	y,
		double	width,
		double	height )

Creates a new rectangle.

Parameters

x	Position X. Geographic coordinates.
y	Position Y. Geographic coordinates.
width	Width. Geographic coordinates.
height	Height. Geographic coordinates.

OnlineMapsDrawingRect() [2/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	OnlineMapsVector2d	position,
		OnlineMapsVector2d	size )

Creates a new rectangle.

Parameters

position	The position of the rectangle. Geographic coordinates.
size	The size of the rectangle. Geographic coordinates.

OnlineMapsDrawingRect() [3/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect

(

Rect

rect

)

Creates a new rectangle.

Parameters

rect	Rectangle. Geographic coordinates.

OnlineMapsDrawingRect() [4/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	double	x,
		double	y,
		double	width,
		double	height,
		Color	borderColor )

Creates a new rectangle.

Parameters

x	Position X. Geographic coordinates.
y	Position Y. Geographic coordinates.
width	Width. Geographic coordinates.
height	Height. Geographic coordinates.
borderColor	Border color.

OnlineMapsDrawingRect() [5/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	OnlineMapsVector2d	position,
		OnlineMapsVector2d	size,
		Color	borderColor )

Creates a new rectangle.

Parameters

position	The position of the rectangle. Geographic coordinates.
size	The size of the rectangle. Geographic coordinates.
borderColor	Border color.

OnlineMapsDrawingRect() [6/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	Rect	rect,
		Color	borderColor )

Creates a new rectangle.

Parameters

rect	Rectangle. Geographic coordinates.
borderColor	Border color.

OnlineMapsDrawingRect() [7/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	double	x,
		double	y,
		double	width,
		double	height,
		Color	borderColor,
		float	borderWidth )

Creates a new rectangle.

Parameters

x	Position X. Geographic coordinates.
y	Position Y. Geographic coordinates.
width	Width. Geographic coordinates.
height	Height. Geographic coordinates.
borderColor	Border color.
borderWidth	Border width.

OnlineMapsDrawingRect() [8/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	OnlineMapsVector2d	position,
		OnlineMapsVector2d	size,
		Color	borderColor,
		float	borderWidth )

Creates a new rectangle.

Parameters

position	The position of the rectangle. Geographic coordinates.
size	The size of the rectangle. Geographic coordinates.
borderColor	Border color.
borderWidth	Border width.

OnlineMapsDrawingRect() [9/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	Rect	rect,
		Color	borderColor,
		float	borderWidth )

Creates a new rectangle.

Parameters

rect	Rectangle. Geographic coordinates.
borderColor	Border color.
borderWidth	Border width.

OnlineMapsDrawingRect() [10/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	double	x,
		double	y,
		double	width,
		double	height,
		Color	borderColor,
		float	borderWidth,
		Color	backgroundColor )

Creates a new rectangle.

Parameters

x	Position X. Geographic coordinates.
y	Position Y. Geographic coordinates.
width	Width. Geographic coordinates.
height	Height. Geographic coordinates.
borderColor	Border color.
borderWidth	Border width.
backgroundColor	Background color.

OnlineMapsDrawingRect() [11/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	OnlineMapsVector2d	position,
		OnlineMapsVector2d	size,
		Color	borderColor,
		float	borderWidth,
		Color	backgroundColor )

Creates a new rectangle.

Parameters

position	The position of the rectangle. Geographic coordinates.
size	The size of the rectangle. Geographic coordinates.
borderColor	Border color.
borderWidth	Border width.
backgroundColor	Background color.

OnlineMapsDrawingRect() [12/12]

OnlineMapsDrawingRect.OnlineMapsDrawingRect	(	Rect	rect,
		Color	borderColor,
		float	borderWidth,
		Color	backgroundColor )

Creates a new rectangle.

Parameters

rect	Rectangle. Geographic coordinates.
borderColor	Border color.
borderWidth	Border width.
backgroundColor	Background color.

Member Function Documentation

Draw()

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

virtual

Validate drawing element.

Returns

The result of validation.

Reimplemented from OnlineMapsDrawingElement.