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

Controls the atmospheric and lighting systems More...

Public Member Functions

void setLightingType (LightingType lightingType)
 Sets the lighting type. See Lightingtype. More...
 
void setStarsEnabled (bool bEnableStars)
 Show or hide stars. More...
 
void setSunTextureEnabled (bool bEnableSun)
 Show or hide the Sun sprite. More...
 
void setAtmosphereAlpha (float atmosphereAlpha)
 Set the atmosphere tranparency. 0.0 is fully transparent and 1.0 is fully opaque. More...
 
void setSunLocationType (LocationType locationType)
 Set the Sun location type. See LocationType. More...
 
void setSunLocation (GeographicPosition2D location)
 Set the Sun position, relative to the specified coordinate. See LocationType. More...
 
void setSunTexture (Texture texture)
 Set the Sun sprite texture. Use this if you want to have a specific sun image. More...
 
void setBackgroundColor (Color color)
 Set the background color of the Altus render target. You will see this when zoomed really far out, looking out into space. More...
 

Detailed Description

Controls the atmospheric and lighting systems

Member Function Documentation

void AltusUnified::Atmospherics::setAtmosphereAlpha ( float  atmosphereAlpha)

Set the atmosphere tranparency. 0.0 is fully transparent and 1.0 is fully opaque.

void AltusUnified::Atmospherics::setBackgroundColor ( Color  color)

Set the background color of the Altus render target. You will see this when zoomed really far out, looking out into space.

void AltusUnified::Atmospherics::setLightingType ( LightingType  lightingType)

Sets the lighting type. See Lightingtype.

void AltusUnified::Atmospherics::setStarsEnabled ( bool  bEnableStars)

Show or hide stars.

void AltusUnified::Atmospherics::setSunLocation ( GeographicPosition2D  location)

Set the Sun position, relative to the specified coordinate. See LocationType.

void AltusUnified::Atmospherics::setSunLocationType ( LocationType  locationType)

Set the Sun location type. See LocationType.

void AltusUnified::Atmospherics::setSunTexture ( Texture  texture)

Set the Sun sprite texture. Use this if you want to have a specific sun image.

void AltusUnified::Atmospherics::setSunTextureEnabled ( bool  bEnableSun)

Show or hide the Sun sprite.