Online Maps v3
Loading...
Searching...
No Matches
OnlineMapsMarkerBase Class Reference

The base class for markers. More...

Inheritance diagram for OnlineMapsMarkerBase:
IOnlineMapsInteractiveElement OnlineMapsMarker OnlineMapsMarker3D

Public Member Functions

virtual void Dispose ()
 Disposes marker.
 
Get< T > (string key)
 Gets the value from the customFields dictionary by key.
 
void GetPosition (out double lng, out double lat)
 Gets location of marker.
 
void GetTilePosition (out double px, out double py)
 Get tile position of the marker.
 
void GetTilePosition (out double px, out double py, int zoom)
 Get tile position of the marker.
 
void GetTilePosition (int zoom, out double px, out double py)
 Get tile position of the marker.
 
bool InMapView ()
 Checks if the marker is in the current map view.
 
virtual void LookToCoordinates (OnlineMapsVector2d coordinates)
 Turns the marker in the direction specified coordinates.
 
void LookToCoordinates (double longitude, double latitude)
 Turns the marker in the direction specified coordinates.
 
void SetPosition (double lng, double lat)
 Set location of marker.
 
void SetDraggable (bool value=true)
 Makes the marker draggable or un draggable.
 
virtual void Update ()
 Update of marker instance.
 
virtual void Update (double tlx, double tly, double brx, double bry, int zoom)
 Method that called when need update marker.
 

Public Attributes

Action< OnlineMapsMarkerBaseOnClick
 Events that occur when user click on the marker.
 
Action< OnlineMapsMarkerBaseOnDoubleClick
 Events that occur when user double click on the marker.
 
Action< OnlineMapsMarkerBaseOnDrag
 Events that occur when user drag the marker.
 
Action< OnlineMapsMarkerBaseOnDrawTooltip
 Event caused to draw tooltip.
 
Action< OnlineMapsMarkerBaseOnEnabledChange
 Event occurs when the marker enabled change.
 
Action< OnlineMapsMarkerBaseOnInitComplete
 Event occurs when the marker is initialized.
 
Action< OnlineMapsMarkerBaseOnLongPress
 Events that occur when user long press on the marker.
 
Action< OnlineMapsMarkerBaseOnPress
 Events that occur when user press on the marker.
 
Action< OnlineMapsMarkerBaseOnPositionChanged
 Event that occurs when the marker position changed.
 
Action< OnlineMapsMarkerBaseOnRelease
 Events that occur when user release on the marker.
 
Action< OnlineMapsMarkerBaseOnRollOut
 Events that occur when user roll out marker.
 
Action< OnlineMapsMarkerBaseOnRollOver
 Events that occur when user roll over marker.
 
string label = ""
 Marker label.
 
OnlineMapsRange range
 Zoom range, in which the marker will be displayed.
 
List< string > tags
 List of tags.
 

Static Public Attributes

static Action< OnlineMapsMarkerBaseOnMarkerDrawTooltip
 Default event caused to draw tooltip.
 

Properties

Dictionary< string, object > customFields [get]
 Get customFields dictionary.
 
virtual bool enabled [get, set]
 Gets or sets marker enabled.
 
bool isDraggable [get, set]
 Makes the marker draggable or un draggable.
 
IOnlineMapsInteractiveElementManager manager [get, set]
 Reference to Marker Manager.
 
Vector2 position [get, set]
 Marker coordinates.
 
virtual float scale [get, set]
 Scale of marker.
 
virtual bool inMapView [get]
 Checks to display marker in current map view.
 
object this[string key] [get, set]
 Get or set a value in the customFields dictionary by key.
 

Detailed Description

The base class for markers.

Member Function Documentation

◆ Get< T >()

T OnlineMapsMarkerBase.Get< T > ( string key)

Gets the value from the customFields dictionary by key.

Parameters
keyField key.
Template Parameters
TType of value.
Returns
Field value.

◆ GetPosition()

void OnlineMapsMarkerBase.GetPosition ( out double lng,
out double lat )

Gets location of marker.

Parameters
lngLongitude
latLatitude

◆ GetTilePosition() [1/3]

void OnlineMapsMarkerBase.GetTilePosition ( int zoom,
out double px,
out double py )

Get tile position of the marker.

Parameters
zoomZoom
pxTile X
pyTile Y

◆ GetTilePosition() [2/3]

void OnlineMapsMarkerBase.GetTilePosition ( out double px,
out double py )

Get tile position of the marker.

Parameters
pxTile X
pyTile Y

◆ GetTilePosition() [3/3]

void OnlineMapsMarkerBase.GetTilePosition ( out double px,
out double py,
int zoom )

Get tile position of the marker.

Parameters
pxTile X
pyTile Y
zoomZoom

◆ InMapView()

bool OnlineMapsMarkerBase.InMapView ( )

Checks if the marker is in the current map view.

Returns
True - in map view. False - outside map view

◆ LookToCoordinates() [1/2]

void OnlineMapsMarkerBase.LookToCoordinates ( double longitude,
double latitude )

Turns the marker in the direction specified coordinates.

Parameters
longitudeLongitude
latitudeLatitude

◆ LookToCoordinates() [2/2]

virtual void OnlineMapsMarkerBase.LookToCoordinates ( OnlineMapsVector2d coordinates)
virtual

Turns the marker in the direction specified coordinates.

Parameters
coordinatesThe coordinates

Reimplemented in OnlineMapsMarker, and OnlineMapsMarker3D.

◆ SetDraggable()

void OnlineMapsMarkerBase.SetDraggable ( bool value = true)

Makes the marker draggable or un draggable.

Parameters
valueTrue - set draggable, false - unset draggable

◆ SetPosition()

void OnlineMapsMarkerBase.SetPosition ( double lng,
double lat )

Set location of marker.

Parameters
lngLongitude
latLatitude

◆ Update()

virtual void OnlineMapsMarkerBase.Update ( double tlx,
double tly,
double brx,
double bry,
int zoom )
virtual

Method that called when need update marker.

Parameters
tlxTop-left longitude.
tlyTop-left latutude.
brxBottom-right longitude.
bryBottom-right latitude.
zoomMap zoom.

Reimplemented in OnlineMapsMarker3D.

Property Documentation

◆ enabled

virtual bool OnlineMapsMarkerBase.enabled
getset

Gets or sets marker enabled.

true if enabled, false if not.

◆ this[string key]

object OnlineMapsMarkerBase.this[string key]
getset

Get or set a value in the customFields dictionary by key.

Parameters
keyField key.
Returns
Field value.