Online Maps  v3
OnlineMapsElevationManagerBase Class Referenceabstract

Base class for components that implement elevations More...

Inheritance diagram for OnlineMapsElevationManagerBase:
OnlineMapsElevationManager< T > OnlineMapsSinglePartElevationManager< T > OnlineMapsTiledElevationManager< T >

Public Member Functions

abstract void CancelCurrentElevationRequest ()
 Cancel current elevation request More...
 
float GetMaxElevation (float yScale)
 Returns the maximum known elevation value More...
 
float GetMinElevation (float yScale)
 Returns the minimum known elevation value More...
 
abstract void RequestNewElevationData ()
 Downloads new elevation data for area More...
 

Static Public Member Functions

static float GetBestElevationYScale ()
 Returns yScale for an area More...
 
static float GetBestElevationYScale (double tlx, double tly, double brx, double bry)
 Returns yScale for an area More...
 
static float GetElevation (double x, double z, float? yScale=null)
 Returns the scaled elevation value for a point in the scene relative to left-top corner of the map. More...
 
static float GetElevation (double x, double z, float yScale, double tlx, double tly, double brx, double bry)
 Returns the scaled elevation value for a point in the scene relative to left-top corner of the map. More...
 
static float GetUnscaledElevation (double x, double z)
 Returns the unscaled elevation value for a point in the scene relative to left-top corner of the map. More...
 
static float GetUnscaledElevation (double x, double z, double tlx, double tly, double brx, double bry)
 Returns the unscaled elevation value for a point in the scene relative to left-top corner of the map. More...
 

Public Attributes

Action< string > OnElevationFails
 Called when downloading elevation data failed More...
 
Action OnElevationRequested
 Called when downloading of elevation data began More...
 
Action OnElevationUpdated
 Called when elevation data has been updated More...
 
Action< double, double, double, double > OnGetElevation
 Called when downloading of elevation data for an area begins More...
 
OnlineMapsElevationBottomMode bottomMode = OnlineMapsElevationBottomMode.zero
 The rule for calculating the lowest point of the map mesh More...
 
float scale = 1
 Scale of elevation values More...
 
OnlineMapsRange zoomRange = new OnlineMapsRange(11, OnlineMaps.MAXZOOM)
 Range when elevations will be shown More...
 
short minValue
 The minimum elevation value. More...
 
short maxValue
 The maximum elevation value. More...
 
bool lockYScale = false
 Lock yScale value More...
 
float yScaleValue = 1
 Fixed yScale value More...
 

Properties

static OnlineMapsElevationManagerBase instance [get]
 Instance of elevation manager More...
 
static bool isActive [get]
 Elevation manager is active? More...
 
static bool useElevation [get]
 Are elevations used for map? More...
 
abstract bool hasData [get]
 Elevation manager has elevation data More...
 

Detailed Description

Base class for components that implement elevations

Member Function Documentation

◆ CancelCurrentElevationRequest()

abstract void OnlineMapsElevationManagerBase.CancelCurrentElevationRequest ( )
pure virtual

Cancel current elevation request

◆ GetBestElevationYScale() [1/2]

static float OnlineMapsElevationManagerBase.GetBestElevationYScale ( )
static

Returns yScale for an area

Returns
yScale for an area

◆ GetBestElevationYScale() [2/2]

static float OnlineMapsElevationManagerBase.GetBestElevationYScale ( double  tlx,
double  tly,
double  brx,
double  bry 
)
static

Returns yScale for an area

Parameters
tlxLeft longitude
tlyTop latitude
brxRight longitude
bryBottom latitude
Returns
yScale for an area

◆ GetElevation() [1/2]

static float OnlineMapsElevationManagerBase.GetElevation ( double  x,
double  z,
float?  yScale = null 
)
static

Returns the scaled elevation value for a point in the scene relative to left-top corner of the map.

Parameters
xPoint X
zPoint Y
yScaleScale factor
Returns
Elevation value

◆ GetElevation() [2/2]

static float OnlineMapsElevationManagerBase.GetElevation ( double  x,
double  z,
float  yScale,
double  tlx,
double  tly,
double  brx,
double  bry 
)
static

Returns the scaled elevation value for a point in the scene relative to left-top corner of the map.

Parameters
xPoint X
zPoint Y
yScaleScale factor
tlxLeft longitude
tlyTop latitude
brxRight longitude
bryBottom latitude
Returns
Elevation value

◆ GetMaxElevation()

float OnlineMapsElevationManagerBase.GetMaxElevation ( float  yScale)

Returns the maximum known elevation value

Parameters
yScaleScale factor
Returns
Maximum known elevation value

◆ GetMinElevation()

float OnlineMapsElevationManagerBase.GetMinElevation ( float  yScale)

Returns the minimum known elevation value

Parameters
yScaleScale factor
Returns
Minimum known elevation value

◆ GetUnscaledElevation() [1/2]

static float OnlineMapsElevationManagerBase.GetUnscaledElevation ( double  x,
double  z 
)
static

Returns the unscaled elevation value for a point in the scene relative to left-top corner of the map.

Parameters
xPoint X
zPoint Z
Returns
Elevation value

◆ GetUnscaledElevation() [2/2]

static float OnlineMapsElevationManagerBase.GetUnscaledElevation ( double  x,
double  z,
double  tlx,
double  tly,
double  brx,
double  bry 
)
static

Returns the unscaled elevation value for a point in the scene relative to left-top corner of the map.

Parameters
xPoint X
zPoint Z
tlxLeft longitude
tlyTop latitude
brxRight longitude
bryBottom latitude
Returns
Elevation value

◆ RequestNewElevationData()

abstract void OnlineMapsElevationManagerBase.RequestNewElevationData ( )
pure virtual

Downloads new elevation data for area

Implemented in OnlineMapsElevationManager< T >.

Member Data Documentation

◆ bottomMode

OnlineMapsElevationBottomMode OnlineMapsElevationManagerBase.bottomMode = OnlineMapsElevationBottomMode.zero

The rule for calculating the lowest point of the map mesh

◆ lockYScale

bool OnlineMapsElevationManagerBase.lockYScale = false

Lock yScale value

◆ maxValue

short OnlineMapsElevationManagerBase.maxValue

The maximum elevation value.

◆ minValue

short OnlineMapsElevationManagerBase.minValue

The minimum elevation value.

◆ OnElevationFails

Action<string> OnlineMapsElevationManagerBase.OnElevationFails

Called when downloading elevation data failed

◆ OnElevationRequested

Action OnlineMapsElevationManagerBase.OnElevationRequested

Called when downloading of elevation data began

◆ OnElevationUpdated

Action OnlineMapsElevationManagerBase.OnElevationUpdated

Called when elevation data has been updated

◆ OnGetElevation

Action<double, double, double, double> OnlineMapsElevationManagerBase.OnGetElevation

Called when downloading of elevation data for an area begins

◆ scale

float OnlineMapsElevationManagerBase.scale = 1

Scale of elevation values

◆ yScaleValue

float OnlineMapsElevationManagerBase.yScaleValue = 1

Fixed yScale value

◆ zoomRange

OnlineMapsRange OnlineMapsElevationManagerBase.zoomRange = new OnlineMapsRange(11, OnlineMaps.MAXZOOM)

Range when elevations will be shown

Property Documentation

◆ hasData

abstract bool OnlineMapsElevationManagerBase.hasData
get

Elevation manager has elevation data

◆ instance

OnlineMapsElevationManagerBase OnlineMapsElevationManagerBase.instance
staticget

Instance of elevation manager

◆ isActive

bool OnlineMapsElevationManagerBase.isActive
staticget

Elevation manager is active?

◆ useElevation

bool OnlineMapsElevationManagerBase.useElevation
staticget

Are elevations used for map?