Altus Mapping Engine JavaScript API Reference - v2.0.ut.2131.g1fd674f - Wednesday March 29, 2017 SDK Documentation | Builds | BA3 Home
AltusUnified::Map Class Reference

A base class for all Maps. You cannot create this map directly. More...

Inheritance diagram for AltusUnified::Map:

Public Member Functions

string getName ()
 Retrieves the name of this map. More...
 
void setAlpha (double alpha)
 Sets the alpha transparency of the map. More...
 
void setOrder (uint order)
 Set the map order (which maps get drawn first). More...
 
void setPriority (int priority)
 Set the map priority, used for queing downloads, for example. More...
 
void setMaxLevel (uint level)
 Sets the maximum level of the map. The higher the level, the more detail the map will display as you zoom in. More...
 
void setVisibility (bool visible)
 Sets the visibility of the map. More...
 
void setLightingParameters (float minLightness, bool nightAlphaMaskEnabled)
 Sets lighting parameters. More...
 
MapType getMapType ()
 Retrieves the type of this map. More...
 
void reload ()
 Reload this map. More...
 
void reloadRegion (BoundingBox boundingBox)
 Reload a region of this map. More...
 

Detailed Description

A base class for all Maps. You cannot create this map directly.

Member Function Documentation

MapType AltusUnified::Map::getMapType ( )

Retrieves the type of this map.

string AltusUnified::Map::getName ( )

Retrieves the name of this map.

void AltusUnified::Map::reload ( )

Reload this map.

void AltusUnified::Map::reloadRegion ( BoundingBox  boundingBox)

Reload a region of this map.

Parameters
boundingBoxThe BoundingBox of the region to be reloaded.
void AltusUnified::Map::setAlpha ( double  alpha)

Sets the alpha transparency of the map.

Parameters
alphaThe opacity of the map. 0 means fully transparent and 1 means fully opaque.
void AltusUnified::Map::setLightingParameters ( float  minLightness,
bool  nightAlphaMaskEnabled 
)

Sets lighting parameters.

Parameters
minLightnessminimum lightness.
nightAlphaMaskEnabledenable night alpha mask.
void AltusUnified::Map::setMaxLevel ( uint  level)

Sets the maximum level of the map. The higher the level, the more detail the map will display as you zoom in.

Parameters
levelThe maximum level.
void AltusUnified::Map::setOrder ( uint  order)

Set the map order (which maps get drawn first).

void AltusUnified::Map::setPriority ( int  priority)

Set the map priority, used for queing downloads, for example.

Parameters
priorityLower means higher priority
void AltusUnified::Map::setVisibility ( bool  visible)

Sets the visibility of the map.