LuciadCPillar 2024.0.08
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
luciad::AtmosphereEffect Class Referencefinal

Graphics effect which adds a sky/atmosphere background to a 3D view. More...

#include <luciad/maps/effects/AtmosphereEffect.h>

Public Member Functions

 AtmosphereEffect (const AtmosphereEffect &)=delete
 
Color getHorizonColor () const
 Returns the horizon color. More...
 
Color getSkyColor () const
 Returns the sky color. More...
 
bool isEnabled () const
 Returns whether the atmosphere effect is enabled. More...
 
AtmosphereEffectoperator= (const AtmosphereEffect &)=delete
 
void setEnabled (bool enabled)
 Sets whether the atmosphere effect is enabled. More...
 
void setHorizonColor (const Color &color)
 Sets the horizon color. More...
 
void setSkyColor (const Color &color)
 Sets the sky color. More...
 

Detailed Description

Graphics effect which adds a sky/atmosphere background to a 3D view.

This effect is only applied in 3D views.

If the view has a geocentric reference, an atmospheric glow effect is drawn around the globe. The colors of this glow can be configured using setHorizonColor() and setSkyColor().

You cannot create an AtmosphereEffect. Instead, you can retrieve it from luciad::GraphicsEffects::getAtmosphere.

Since
2023.1

Constructor & Destructor Documentation

◆ AtmosphereEffect()

luciad::AtmosphereEffect::AtmosphereEffect ( const AtmosphereEffect )
delete

Member Function Documentation

◆ getHorizonColor()

Color luciad::AtmosphereEffect::getHorizonColor ( ) const

Returns the horizon color.

Only used in geocentric views, where a gradient going from getHorizonColor() to getSkyColor() will be visible on the horizon.

Returns
the color of the horizon.

◆ getSkyColor()

Color luciad::AtmosphereEffect::getSkyColor ( ) const

Returns the sky color.

Only used in geocentric views, where a gradient going from getHorizonColor() to getSkyColor() will be visible on the horizon.

Returns
the color of the sky.

◆ isEnabled()

bool luciad::AtmosphereEffect::isEnabled ( ) const

Returns whether the atmosphere effect is enabled.

Returns
whether the atmosphere effect is enabled.

◆ operator=()

AtmosphereEffect & luciad::AtmosphereEffect::operator= ( const AtmosphereEffect )
delete

◆ setEnabled()

void luciad::AtmosphereEffect::setEnabled ( bool  enabled)

Sets whether the atmosphere effect is enabled.

The default is true.

Parameters
enabledtrue to enable the atmosphere effect or false to disable it.

◆ setHorizonColor()

void luciad::AtmosphereEffect::setHorizonColor ( const Color color)

Sets the horizon color.

Parameters
colorthe horizon color.

◆ setSkyColor()

void luciad::AtmosphereEffect::setSkyColor ( const Color color)

Sets the sky color.

Parameters
colorthe sky color.