OnlineMapsTileSetControl Class Reference

Class control the map for the Tileset. Tileset - a dynamic mesh, created at runtime. More...

Inheritance diagram for OnlineMapsTileSetControl:

Public Types
enum	OnlineMapsColliderType
	Type of tileset map collider.
Public Types inherited from OnlineMapsControlBaseDynamicMesh
enum	CreateMapTarget { currentGameobject , newGameobject }
	Where to create a mesh? More...

Public Member Functions
Vector2	GetCoordsByWorldPosition (Vector3 position)
	Returns the geographical coordinates by world position.
bool	GetCoordsByWorldPosition (Vector3 position, out double lng, out double lat)
	Returns the geographical coordinates by world position.
bool	GetCoordsByWorldPosition (Vector3 position, out double lng, out double lat, out float altitude)
	Returns the geographical coordinates by world position.
override Vector2	GetScreenPosition (double lng, double lat)
	Converts geographical coordinate to position in screen space.
bool	GetTileByWorldPosition (Vector3 position, out double tx, out double ty)
	Returns the tile coordinates by world position.
override void	OnAwakeBefore ()
	Event that occurs before Awake.
void	Resize (int width, int height, bool changeSizeInScene=true)
	Resize map.
void	Resize (int width, int height, float sizeX, float sizeZ)
	Resize map.
void	Resize (int width, int height, Vector2 sizeInScene)
	Resize map.
override void	UpdateControl ()
	Updates the current control.
Public Member Functions inherited from OnlineMapsControlBaseDynamicMesh
override void	GetPosition (double lng, double lat, out double px, out double py)
	Converts geographical coordinate to position in the scene relative to the top-left corner of the map in map space.
Vector3	GetWorldPosition (Vector2 coords)
	Converts geographical coordinates to position in world space.
Vector3	GetWorldPosition (double lng, double lat)
	Converts geographical coordinates to position in world space.
Vector3	GetWorldPositionWithElevation (double lng, double lat)
	Converts geographical coordinates to position in world space with elevation.
Vector3	GetWorldPositionWithElevation (Vector2 coords, Vector2 topLeftPosition, Vector2 bottomRightPosition)
	Converts geographical coordinates to position in world space with elevation.
Vector3	GetWorldPositionWithElevation (Vector2 coords, double tlx, double tly, double brx, double bry)
	Converts geographical coordinates to position in world space with elevation.
Vector3	GetWorldPositionWithElevation (double lng, double lat, double tlx, double tly, double brx, double bry)
	Converts geographical coordinates to position in world space with elevation.
Vector3	GetWorldPositionWithElevation (double lng, double lat, float altitude)
	Converts geographical coordinates to position in world space with elevation.
Public Member Functions inherited from OnlineMapsControlBase3D
OnlineMapsMarkerInstanceBase	GetBillboardMarkerFromScreen (Vector2 screenPosition)
	Gets billboard marker on the screen position.
override IOnlineMapsInteractiveElement	GetInteractiveElement (Vector2 screenPosition)
	Get the interactive element located at the screen position.
Public Member Functions inherited from OnlineMapsControlBase
virtual OnlineMapsTile	CreateTile (int x, int y, int zoom, bool isMapTile=true)
	Creates a new tile.
Vector2	GetCoords ()
	Returns the geographical coordinates of the location where the cursor is.
Vector2	GetCoords (Vector2 position)
	Returns the geographical coordinates at the specified coordinates of the screen.
bool	GetCoords (out double lng, out double lat)
	Returns the geographical coordinates of the location where the cursor is.
bool	GetCoords (Vector2 position, out double lng, out double lat)
	Returns the geographical coordinates of the location where the position is.
Vector2	GetInputPosition ()
	Returns the current cursor position.
Vector2	GetPosition (Vector2 coords)
	Converts geographical coordinate to position in the scene relative to the top-left corner of the map in map space.
virtual Rect	GetRect ()
	Screen area occupied by the map.
OnlineMapsSavableItem[]	GetSavableItems ()
	Returns an array of items to save.
Vector2	GetScreenPosition (Vector2 coords)
	Converts geographical coordinate to position in screen space.
bool	GetTile (Vector2 position, out double tx, out double ty)
	Gets a tile by screen position.
int	GetTouchCount ()
	Returns the current number of touches.
void	InvokeBasePress ()
	Invokes OnMapBasePress.
void	InvokeBaseRelease ()
	Invokes OnMapBaseRelease.
bool	IsCursorOnUIElement (Vector2 position)
	Whether the screen position is on UI element.
virtual void	SetTexture (Texture2D texture)
	Specifies the texture, which will draw the map. In texture must be enabled "Read / Write Enabled".
void	UpdateLastPosition ()
	Force updates the latest coordinates of cursor.
bool	ZoomOnPoint (float zoomOffset, Vector2 screenPosition)
	Changes the zoom keeping a specified point on same place.

Public Attributes
Action< OnlineMapsTile, Material >	OnChangeMaterialTexture
	The event, which occurs when the changed texture tile maps.
Action< OnlineMapsTile, Material >	OnDrawTile
	The event that occurs after draw the tile.
Action< OnlineMapsTile, Material >	OnUpdateMapSubMeshLate
	The event that occurs after draw the tile. The difference with OnDrawTile is that it is always called for the original tile, whether or not it was loaded.
OnlineMapsColliderType	colliderType = OnlineMapsColliderType.fullMesh
	Type of collider: box - for performance, mesh - for elevation.
bool	compressTextures = true
	Compress texture to reduce memory usage.
Plane?	dragPlane
	Plane by using which the map is dragged. Exists only during drag.
GameObject	drawingsGameObject
	Container for drawing elements.
OnlineMapsTilesetDrawingMode	drawingMode = OnlineMapsTilesetDrawingMode.meshes
	Drawing API mode (meshes or overlay).
Shader	drawingShader
	Shader of drawing elements.
bool	overlayFromParentTiles = true
	Whether the overlay from the parent tiles should be shown.
Material	tileMaterial
	Material that will be used for tile.
Shader	tilesetShader
	Shader of map.
Public Attributes inherited from OnlineMapsControlBaseDynamicMesh
Action	OnMeshUpdated
	Event that occurs after the map mesh has been updated.
Action	OnUpdateMeshAfter
	The event is called after updating the map mesh.
Action	OnUpdateMeshBefore
	The event is called before updating the map mesh.
OnlineMapsTilesetCheckMarker2DVisibility	checkMarker2DVisibility = OnlineMapsTilesetCheckMarker2DVisibility.pivot
	Type of checking 2D markers on visibility.
int	elevationResolution = 32
	Resolution of the elevation map.
Material	markerMaterial
	Material that will be used for marker.
Shader	markerShader
	Shader of markers.
Vector2	sizeInScene = new Vector2(1024, 1024)
	Size of the map in the scene.
Public Attributes inherited from OnlineMapsControlBase3D
Action	OnUpdate3DMarkers
	Called when drawing 3d markers.
Camera	activeCamera
	The camera you are using to display the map.
OnlineMapsElevationManagerBase	elevationManager
	Reference to the elevation manager.
OnlineMapsMarker2DMode	marker2DMode = OnlineMapsMarker2DMode.flat
	Mode of 2D markers. Bake in texture or Billboard.
float	marker2DSize = 100
	Size of billboard markers.
OnlineMapsMarker3DManager	marker3DManager
	Reference to marker 3D manager.
Public Attributes inherited from OnlineMapsControlBase
Action	OnDrawMarkers
	Event that occurs when need to draw markers.
Func< Vector2 >	OnGetInputPosition
	Event intercepts getting current cursor position.
Func< Vector2[]>	OnGetMultitouchInputPositions
	The event intercepts getting of the current multitouch points.
Func< int >	OnGetTouchCount
	Event intercepts getting number of touches.
Action	OnMapClick
	Event that occurs when you click on the map.
Action	OnMapDoubleClick
	Event that occurs when you double-click on the map.
Action	OnMapDrag
	Event that occurs when you drag the map.
Action	OnMapLongPress
	Event that occurs when you long press the map.
Action	OnMapPress
	Event that occurs when you press on the map.
Action	OnMapRelease
	Event that occurs when you release the map.
Action	OnMapZoom
	Event that occurs when you zoom the map.
Action	OnSmoothZoomBegin
	Event, which occurs when the smooth zoom is started.
Action	OnSmoothZoomFinish
	Event, which occurs when the smooth zoom is finish.
Action	OnSmoothZoomInit
	Event, which occurs when the smooth zoom is starts init.
Action	OnSmoothZoomProcess
	Event, which occurs when the smooth zoom is process.
Action	OnUpdateAfter
	Event that occurs at end Update.
Action	OnUpdateBefore
	Event that occurs at start Update.
Predicate< GameObject >	OnValidateCursorOnUIElement
	Event validating that cursor is on UI element. True - cursor on UI element, false - otherwise.
Func< OnlineMapsZoomEvent, float, bool >	OnValidateZoom
	Event validating that current zoom event is allowed. True - zoom is allowed, false - forbidden.
Texture2D	activeTexture
	Texture, which will draw the map. To change the texture use OnlineMapsControlBase.SetTexture.
bool	allowZoom = true
	Specifies whether the user can change zoom of the map.
bool	allowUserControl = true
	Specifies whether the user can manipulate the map.
bool	checkScreenSizeForWheelZoom = true
	Check that the input position is on the screen.
OnlineMapsDrawingElementManager	drawingElementManager
	Reference to drawing element manager.
bool	isMapDrag
	Specifies whether to move map.
bool	invertTouchZoom = false
	Inverts the map touch zoom for mobile devices.
OnlineMapsMarkerManager	markerManager
	Reference to marker manager.
bool	smoothZoom = true
	Specifies whether to use a smooth touch zoom.
bool	zoomInOnDoubleClick = true
	Allows you to zoom the map when double-clicked.
OnlineMapsZoomMode	zoomMode = OnlineMapsZoomMode.target
	Mode of zoom.
float	zoomSensitivity = 1
	Sensitivity of the touch zoom.
float	zoomSpeed = 1
	Zoom speed with any interaction (wheel, double click, touch)

Protected Member Functions
override bool	HitTest (Vector2 position)
	Checks whether specified position over the map.
override void	OnDestroyLate ()
	Event is called after the control has been disposed.
override void	OnMapBasePress ()
	Method that is called when you press the map.
override void	OnMapBaseRelease ()
	Method that is called when you release the map.
Protected Member Functions inherited from OnlineMapsControlBaseDynamicMesh
override void	OnEnableLate ()
	Function that is called after control of the map enabled.
Protected Member Functions inherited from OnlineMapsControlBase3D
override void	AfterUpdate ()
	Function, which is executed after map updating.
Protected Member Functions inherited from OnlineMapsControlBase
virtual void	BeforeUpdate ()
	Function, which is executed before map updating.
void	DragMarker ()
	Moves the marker to the location of the cursor.
bool	HitTest ()
	Checks whether the cursor over the map.
virtual void	OnGestureZoom (Vector2 p1, Vector2 p2)
	Called when a gesture zoom.
void	UpdatePosition ()
	Updates the map coordinates for the actions of the user.
void	UpdateZoom ()
	Updates the map zoom for mouse wheel.

Properties
static new OnlineMapsTileSetControl	instance [get]
	Singleton instance of OnlineMapsTileSetControl control.
Properties inherited from OnlineMapsControlBaseDynamicMesh
OnlineMapsVector2i	bufferPosition [get, set]
	Position of the buffer.
Vector3	center [get]
	The center point of the map (without elevations) in local space.
bool	hasElevation [get]
	Returns true when the elevation manager is available and enabled.
static new OnlineMapsControlBaseDynamicMesh	instance [get]
	Singleton instance of OnlineMapsControlBaseDynamicMesh.
Properties inherited from OnlineMapsControlBase3D
Camera	currentCamera [get]
	Reference to current camera.
static new OnlineMapsControlBase3D	instance [get]
	Singleton instance of OnlineMapsControlBase3D control.
Collider	cl [get]
	Reference to the collider.
MeshFilter	meshFilter [get]
	MeshFilter of the map.
OnlineMapsMarker3DDrawer	marker3DDrawer [get, set]
	Get/set marker 3D drawer.
Renderer	rendererInstance [get]
	Reference to the renderer.
Properties inherited from OnlineMapsControlBase
static OnlineMapsControlBase	instance [get]
	Singleton instance of map control.
virtual bool	allowMarkerScreenRect [get]
	Indicates whether it is possible to get the screen coordinates store. True - for 2D map, false - for the 3D map.
virtual bool	allowTouchZoom [get]
	Indicates whether it is possible to use the touch zoom.
OnlineMapsMarkerBase	dragMarker [get, set]
	Marker that dragged at the moment.
OnlineMapsMarker2DDrawer	markerDrawer [get, set]
	Gets/sets the marker drawer.
OnlineMaps	map [get]
	Reference to map instance.
virtual bool	mipmapForTiles [get, set]
	Mipmap for tiles.
virtual Rect	screenRect [get]
	Screen area occupied by the map.
bool	resultIsTexture [get]
	Whether the current control draws to a texture.
virtual OnlineMapsTarget	resultType [get]
	The result type of the current control.
virtual bool	useRasterTiles [get]
	Whether the current control uses raster tiles.
virtual Rect	uvRect [get]
	UV rectangle used by the texture of the map. NGUI: uiTexture.uvRect. Other: new Rect(0, 0, 1, 1);.

Additional Inherited Members
Static Public Attributes inherited from OnlineMapsControlBase
static float	longPressDelay = 1
	Delay before invoking event OnMapLongPress.
static float	startDragDistance = 4
	Distance (pixels) after which will start drag the map.
Protected Attributes inherited from OnlineMapsControlBaseDynamicMesh
bool	colliderWithElevation
	Does the collider contain elevations?
Static Protected Attributes inherited from OnlineMapsControlBase
static OnlineMapsControlBase	_instance
	Singleton of control.

Detailed Description

Class control the map for the Tileset. Tileset - a dynamic mesh, created at runtime.

Member Function Documentation

GetCoordsByWorldPosition() [1/3]

Vector2 OnlineMapsTileSetControl.GetCoordsByWorldPosition

(

Vector3

position

)

Returns the geographical coordinates by world position.

Parameters

position

World position

Returns

Geographical coordinates or Vector2.zero

GetCoordsByWorldPosition() [2/3]

bool OnlineMapsTileSetControl.GetCoordsByWorldPosition	(	Vector3	position,
		out double	lng,
		out double	lat )

Returns the geographical coordinates by world position.

Parameters

position	World position
lng	Longitude
lat	Latitude

Returns

True - success, False - otherwise.

GetCoordsByWorldPosition() [3/3]

bool OnlineMapsTileSetControl.GetCoordsByWorldPosition	(	Vector3	position,
		out double	lng,
		out double	lat,
		out float	altitude )

Returns the geographical coordinates by world position.

Parameters

position	World position
lng	Longitude
lat	Latitude
altitude	Altitude

Returns

True - success, False - otherwise.

GetScreenPosition()

override Vector2 OnlineMapsTileSetControl.GetScreenPosition ( double lng, double lat )

virtual

Converts geographical coordinate to position in screen space.

Parameters

lng	Longitude
lat	Latitude

Returns

Screen space position

Reimplemented from OnlineMapsControlBaseDynamicMesh.

GetTileByWorldPosition()

bool OnlineMapsTileSetControl.GetTileByWorldPosition	(	Vector3	position,
		out double	tx,
		out double	ty )

Returns the tile coordinates by world position.

Parameters

position	World position
tx	Tile X
ty	Tile Y

Returns

True - success, False - otherwise.

HitTest()

override bool OnlineMapsTileSetControl.HitTest ( Vector2 position )

protectedvirtual

Checks whether specified position over the map.

Parameters

position

Screen position

Returns

True - if the position over the map, false - if not.

Reimplemented from OnlineMapsControlBase.

Resize() [1/3]

void OnlineMapsTileSetControl.Resize	(	int	width,
		int	height,
		bool	changeSizeInScene = true )

Resize map.

Parameters

width	Width (pixels)
height	Height (pixels)
changeSizeInScene	Change the size of the map in the scene or leave the same.

Resize() [2/3]

void OnlineMapsTileSetControl.Resize	(	int	width,
		int	height,
		float	sizeX,
		float	sizeZ )

Resize map.

Parameters

width	Width (pixels)
height	Height (pixels)
sizeX	Size X (in scene)
sizeZ	Size Z (in scene)

Resize() [3/3]

void OnlineMapsTileSetControl.Resize	(	int	width,
		int	height,
		Vector2	sizeInScene )

Resize map.

Parameters

width	Width (pixels)
height	Height (pixels)
sizeInScene	Size in scene (X-X, Y-Z)