VRS::AtmosphericEnvironment Class Reference
#include <vrs/atmosphericenvironment.h>
Public Member Functions | |
| AtmosphericEnvironment (bool showSky=false, bool showFlare=true, bool applySunLight=true, bool aerialPerspective=true, Sky *sky=NULL, Flare *flare=NULL) | |
| Constructs a sky attribute. | |
| void | setShowSky (bool showSky) |
| Sets whether a sky will be displayed. | |
| bool | getShowSky () const |
| Returns whether a sky will be displayed. | |
| void | setShowFlare (bool showFlare) |
| Sets whether a lens flare effect will be displayed. | |
| bool | getShowFlare () const |
| Returns whether a lens flare effect will be displayed. | |
| void | setApplySunLight (bool adjustDistantLight) |
| Sets whether the distant light, representing the sun light, is used. | |
| bool | getApplySunLight () const |
| Returns whether the sun light is simulated. | |
| void | setAerialPerspective (bool aerialPerspective) |
| Sets whether a fog is displayed that simulates the blurring towards the horizon. | |
| bool | getAerialPerspective () const |
| Returns whether a fog is displayed that simulates the blurring towards the horizon. | |
| void | setSky (Sky *newSky) |
| Sets the sky to be displayed. | |
| Sky * | getSky () const |
| Returns the sky to be displayed. | |
| void | setFlare (Flare *newFlare) |
| Sets the lens flare effect to be displayed. | |
| Flare * | getFlare () const |
| Returns the lens flare effect to be displayed. | |
| VRS_TYPEINFO (AtmosphericEnvironment, MonoAttribute) | |
| VRS_SERIALIZABLE (AtmosphericEnvironment) | |
Detailed Description
Attribute for displaying outdoor scenes This attribute displays a sky, a lens flare effect, adjusts the distant light's position that it fits the sun direction and sets a fog that simulates the blurring towards the horizon.Constructor & Destructor Documentation
| VRS::AtmosphericEnvironment::AtmosphericEnvironment | ( | bool | showSky = false, |
|
| bool | showFlare = true, |
|||
| bool | applySunLight = true, |
|||
| bool | aerialPerspective = true, |
|||
| Sky * | sky = NULL, |
|||
| Flare * | flare = NULL | |||
| ) |
Constructs a sky attribute.
If sky and/or flare are set to NULL (and the sky and/or flare are activated), they will be created with standard parameters.
Member Function Documentation
| void VRS::AtmosphericEnvironment::setShowSky | ( | bool | showSky | ) |
Sets whether a sky will be displayed.
| bool VRS::AtmosphericEnvironment::getShowSky | ( | ) | const [inline] |
Returns whether a sky will be displayed.
| void VRS::AtmosphericEnvironment::setShowFlare | ( | bool | showFlare | ) |
Sets whether a lens flare effect will be displayed.
The lens flare may only be displayed, if there is a valid sky.
| bool VRS::AtmosphericEnvironment::getShowFlare | ( | ) | const [inline] |
Returns whether a lens flare effect will be displayed.
| void VRS::AtmosphericEnvironment::setApplySunLight | ( | bool | adjustDistantLight | ) |
Sets whether the distant light, representing the sun light, is used.
The sun light may only be used if there is a valid sky.
| bool VRS::AtmosphericEnvironment::getApplySunLight | ( | ) | const [inline] |
Returns whether the sun light is simulated.
| void VRS::AtmosphericEnvironment::setAerialPerspective | ( | bool | aerialPerspective | ) |
Sets whether a fog is displayed that simulates the blurring towards the horizon.
The aerial perspective may only be used if there is a valid sky.
| bool VRS::AtmosphericEnvironment::getAerialPerspective | ( | ) | const [inline] |
Returns whether a fog is displayed that simulates the blurring towards the horizon.
| void VRS::AtmosphericEnvironment::setSky | ( | Sky * | newSky | ) |
Sets the sky to be displayed.
| Sky * VRS::AtmosphericEnvironment::getSky | ( | ) | const [inline] |
Returns the sky to be displayed.
| void VRS::AtmosphericEnvironment::setFlare | ( | Flare * | newFlare | ) |
Sets the lens flare effect to be displayed.
| Flare * VRS::AtmosphericEnvironment::getFlare | ( | ) | const [inline] |
Returns the lens flare effect to be displayed.
| VRS::AtmosphericEnvironment::VRS_TYPEINFO | ( | AtmosphericEnvironment | , | |
| MonoAttribute | ||||
| ) |
| VRS::AtmosphericEnvironment::VRS_SERIALIZABLE | ( | AtmosphericEnvironment | ) |
The documentation for this class was generated from the following file: