Altus Mapping Engine JavaScript API Reference - v2.0.ut.2153.g60764257e - Tuesday May 16, 2017 SDK Documentation | Builds | BA3 Home
AltusUnified::Scene Class Reference

The main rendering component and container of other objects. More...

Inheritance diagram for AltusUnified::Scene:
Collaboration diagram for AltusUnified::Scene:

Public Member Functions

 Scene (string name, uint width, uint height)
 
string getName ()
 
void update (TimeStamp timeStamp)
 
void setLicenseKey (string licenseKey)
 Turns off the water-mark if the license key is valid. Use this if you have an old style license key. More...
 
void setLicenseKey (string licenseKey, string domain)
 Turns off the water-mark if the license key is valid. Use this if you have a new style license key. More...
 
void addMap (Map map)
 Adds a new map layer. If there is an existing map with the same name, the existing map will be removed using clearCache = false, so tiles will remain in the cache and be used for the new map. You should use RemoveMap with clearCache = true if you are done with the existing map. More...
 
void removeMap (Map map, bool clearCache)
 Removes a map layer optionally clearing the cache. More...
 
void setBaseMapImage (Image image)
 Sets the image that will be rendered while waiting for other map data to load. More...
 
Map findMap (string name)
 Returns a map with the given name assuming it has been previously added. More...
 
VectorString getMapNames ()
 Returns a list of currently loaded maps. More...
 
void setShadedReliefColorBar (ColorBar colorBar)
 
void setTawsColorBar (ColorBar colorBar)
 
void setTawsAltitude (float altitude)
 
void setAltitudeScale (double altitudeScale, double animationDuration)
 
ResourceManager getResourceManager ()
 
Screen screen ()
 
Camera camera ()
 
AnimationManager animationManager ()
 
ClassicCameraModifier classicCameraModifier ()
 
Atmospherics atmospherics ()
 
HitTesting hitTesting ()
 
Framerate framerate ()
 
Diagnostics diagnostics ()
 
FrameRenderer frameRenderer ()
 
void setDelegate (SceneDelegate delegate)
 
void addDelegate (SceneDelegate delegate)
 
bool removeDelegate (SceneDelegate delegate)
 
- Public Member Functions inherited from AltusUnified::ITimerListener
void update (TimeStamp timeStamp)
 

Static Public Member Functions

static string versionTag ()
 The version tag from the BA3 source repository this version was built from. More...
 
static string versionHash ()
 The version hash from the BA3 source repository this version was built from. More...
 

Detailed Description

The main rendering component and container of other objects.

Constructor & Destructor Documentation

AltusUnified::Scene::Scene ( string  name,
uint  width,
uint  height 
)

Member Function Documentation

void AltusUnified::Scene::addDelegate ( SceneDelegate  delegate)
void AltusUnified::Scene::addMap ( Map  map)

Adds a new map layer. If there is an existing map with the same name, the existing map will be removed using clearCache = false, so tiles will remain in the cache and be used for the new map. You should use RemoveMap with clearCache = true if you are done with the existing map.

Parameters
mapMap to add.
AnimationManager AltusUnified::Scene::animationManager ( )
Atmospherics AltusUnified::Scene::atmospherics ( )
Camera AltusUnified::Scene::camera ( )
ClassicCameraModifier AltusUnified::Scene::classicCameraModifier ( )
Diagnostics AltusUnified::Scene::diagnostics ( )
Map AltusUnified::Scene::findMap ( string  name)

Returns a map with the given name assuming it has been previously added.

Framerate AltusUnified::Scene::framerate ( )
FrameRenderer AltusUnified::Scene::frameRenderer ( )
VectorString AltusUnified::Scene::getMapNames ( )

Returns a list of currently loaded maps.

string AltusUnified::Scene::getName ( )
ResourceManager AltusUnified::Scene::getResourceManager ( )
HitTesting AltusUnified::Scene::hitTesting ( )
bool AltusUnified::Scene::removeDelegate ( SceneDelegate  delegate)
void AltusUnified::Scene::removeMap ( Map  map,
bool  clearCache 
)

Removes a map layer optionally clearing the cache.

Screen AltusUnified::Scene::screen ( )
void AltusUnified::Scene::setAltitudeScale ( double  altitudeScale,
double  animationDuration 
)
void AltusUnified::Scene::setBaseMapImage ( Image  image)

Sets the image that will be rendered while waiting for other map data to load.

void AltusUnified::Scene::setDelegate ( SceneDelegate  delegate)
void AltusUnified::Scene::setLicenseKey ( string  licenseKey)

Turns off the water-mark if the license key is valid. Use this if you have an old style license key.

Parameters
licenseKeyYour unique license key.
void AltusUnified::Scene::setLicenseKey ( string  licenseKey,
string  domain 
)

Turns off the water-mark if the license key is valid. Use this if you have a new style license key.

Parameters
licenseKeyYour unique license key.
domainThe domain your license key is registered to.
void AltusUnified::Scene::setShadedReliefColorBar ( ColorBar  colorBar)
void AltusUnified::Scene::setTawsAltitude ( float  altitude)
void AltusUnified::Scene::setTawsColorBar ( ColorBar  colorBar)
void AltusUnified::Scene::update ( TimeStamp  timeStamp)
static string AltusUnified::Scene::versionHash ( )
static

The version hash from the BA3 source repository this version was built from.

static string AltusUnified::Scene::versionTag ( )
static

The version tag from the BA3 source repository this version was built from.