SilverLining: SilverLining::Atmosphere Class Reference

Public Member Functions | Static Public Member Functions

# SilverLining::Atmosphere Class Reference

This class is the main interface to SilverLining. More...

`#include <Atmosphere.h>`

Inherits SilverLining::MemObject.

Collaboration diagram for SilverLining::Atmosphere:
[legend]

List of all members.

## Public Member Functions
| Atmosphere (const char *userName, const char *licenseKey)
| Constructor.
| ~Atmosphere ()
| Destructor.
float SILVERLINING_API | GetVersionNumber () const
| Returns the version number of SilverLining (ie, 1.0).
void SILVERLINING_API | SetConditions (const AtmosphericConditions &conditions)
| Configures the simulated cloud, wind, time, and location.
const AtmosphericConditions &SILVERLINING_API | GetConditions () const
| Accessor to the current cloud, wind, time, and location settings.
void SILVERLINING_API | GetSunOrMoonPosition (float *x, float *y, float *z) const
| Retrieve the normalized direction of the dominant directional light source.
void SILVERLINING_API | GetSunOrMoonPositionGeographic (float *x, float *y, float *z) const
| Retrieve the normalized direction of the dominant directional light source.
void SILVERLINING_API | GetSunOrMoonPositionEquatorial (float *x, float *y, float *z) const
| Retrieve the normalized direction of the dominant directional light source.
void SILVERLINING_API | GetSunPosition (float *x, float *y, float *z) const
| Retrieve the normalized direction of the sun's light source.
void SILVERLINING_API | GetMoonPosition (float *x, float *y, float *z) const
| Retrieve the normalized direction of the moon's light source.
void SILVERLINING_API | GetSunPositionGeographic (float *x, float *y, float *z) const
| Retrieve the direction of the sun, relative to the center of the Earth in a geocentric coordinate system, where the z axis points from the center of the Earth to the North Pole, and x points toward the prime meridian.
void SILVERLINING_API | GetMoonPositionGeographic (float *x, float *y, float *z) const
| Retrieve the direction of the moon, relative to the center of the Earth in a geocentric coordinate system, where the z axis points from the center of the Earth to the North Pole, and x points toward the prime meridian.
void SILVERLINING_API | GetSunPositionEquatorial (float *x, float *y, float *z) const
| Retrieve the direction of the sun in equatorial coordinates; where x points toward the vernal equinox (where the equator and ecliptic intersect), z points through the north pole.
void SILVERLINING_API | GetMoonPositionEquatorial (float *x, float *y, float *z) const
| Retrieve the direction of the moon in equatorial coordinates; where x points toward the vernal equinox (where the equator and ecliptic intersect), z points through the north pole.
void SILVERLINING_API | GetSunOrMoonColor (float *r, float *g, float *b) const
| Returns the color of the dominant directional light source.
void SILVERLINING_API | GetSunColor (float *r, float *g, float *b) const
| Returns the color of the sun's light source.
void SILVERLINING_API | GetMoonColor (float *r, float *g, float *b) const
| Returns the color of the moon's light source.
void SILVERLINING_API | GetAmbientColor (float *r, float *g, float *b) const
| Returns the color of the ambient "skylight".
void SILVERLINING_API | GetHorizonColor (float yawDegrees, float pitchDegrees, float *r, float *g, float *b) const
| Returns the average color of the sky at the horizon.
void SILVERLINING_API | GetHorizonColor (float pitchDegrees, float *r, float *g, float *b) const
| Returns the average color of the sky at the horizon.
bool SILVERLINING_API | GetFogEnabled () const
| Returns whether SilverLining would like to suggest fog settings.
void SILVERLINING_API | GetFogSettings (float *density, float *r, float *g, float *b) const
| Returns exponential fog settings appropriate for your scene.
void SILVERLINING_API | SetHaze (float hazeR, float hazeG, float hazeB, double hazeDepth, double hazeDensity)
| Causes the sky to blend toward a specified "haze color" toward the horizon.
void SILVERLINING_API | GetHaze (float &hazeR, float &hazeG, float &hazeB, double &hazeDepth, double &hazeDensity)
| Retrieves the haze parameters set previously by SetHaze().
void SILVERLINING_API | SetGamma (double gamma)
| Sets the value used for gamma correction of the display.
double SILVERLINING_API | GetGamma () const
| Retrieves the value being used for display gamma correction.
void SILVERLINING_API | ForceLightingRecompute ()
| Force SilverLining to recompute all cloud lighting.
AtmosphericConditions *SILVERLINING_API | GetConditions ()
| Return a reference to the current simulated conditions.
int SILVERLINING_API | Initialize (int renderer, const char *resourceDirectoryPath, bool rightHanded, void *environment)
| Call this immediately after constructing your scene's Atmosphere and initializing your graphics subsystem (OpenGL, OpenGL32, DirectX9, DirectX10, or DirectX11).
void SILVERLINING_API | SetUpVector (double x, double y, double z)
| Sets the assumption of what direction is "up".
void SILVERLINING_API | GetUpVector (double &x, double &y, double &z)
| Returns the direction that SilverLining assumes is "up" as a unit vector.
void SILVERLINING_API | SetRightVector (double x, double y, double z)
| Sets the assumption of what direction is "right".
void SILVERLINING_API | GetRightVector (double &x, double &y, double &z)
| Returns the direction that SilverLining assumes is "right" as a unit vector.
void SILVERLINING_API | SetCameraMatrix (const double *cameraMatrix)
| Call this at the beginning of each rendering loop, prior to calling DrawSky().
void SILVERLINING_API | SetProjectionMatrix (const double *projectionMatrix)
| Call this at the beginning of each rendering loop, prior to calling DrawSky().
bool SILVERLINING_API | DrawSky (bool drawSky, bool geocentricMode=false, double skyBoxDimension=0, bool drawStars=true, bool clearDepth=true)
| Call this at the beginning of your rendering loop.
bool SILVERLINING_API | DrawObjects (bool drawClouds=true, bool drawPrecipitation=true, bool enableDepthTest=true)
| Call this at the end of your rendering loop.
void SILVERLINING_API | OverrideCloudLighting (float ambientR, float ambientG, float ambientB, float diffuseR, float diffuseG, float diffuseB)
| Use this to use specific colors for lighting the clouds, instead of the sun, moon, and sky colors.
void SILVERLINING_API | ClearCloudLightingOverride ()
| Clears any manual overrides of the cloud light color that were previously set with Atmosphere::OverrideCloudLighting().
double SILVERLINING_API | GetFramerate () const
| Return the current framerate, based on the rendering time of the previous frame, in frames per second.
| SL_VECTOR (ObjectHandle)&SILVERLINING_API GetObjects() const
| If you called DrawObjects() with the drawClouds parameter set to false, no clouds will actually be drawn.
float SILVERLINING_API | GetObjectDistance (ObjectHandle obj, float obj2X, float obj2Y, float obj2Z, float sortPosX, float sortPosY, float sortPosZ)
| If you are managing your own cloud drawing, you'll need to sort them from back to front along with the other objects in your scene.
float SILVERLINING_API | GetObjectDistance (ObjectHandle obj, ObjectHandle obj2, float sortPosX, float sortPosY, float sortPosZ)
| If you are managing your own cloud drawing, you'll need to sort them from back to front along with the other objects in your scene.
void SILVERLINING_API | GetObjectPosition (ObjectHandle obj, float &x, float &y, float &z)
| Obtains the position, in world coordinates, of a given ObjectHandle obtained from the list returned from GetObjects().
void SILVERLINING_API | DrawObject (ObjectHandle obj)
| If you are managing your own cloud object drawing by calling DrawObjects(false), then your sorted list of objects may drawn by calling DrawObject() on each object.
void SILVERLINING_API | ReloadConfigFile ()
| Reloads the SilverLining.config file in the resources directory.
void SILVERLINING_API | SetConfigOption (const char *key, const char *value)
| Sets a specific SilverLining.config value.
const char *SILVERLINING_API | GetConfigOptionString (const char *key) const
| Retrieves a specific SilverLining.config value as a string.
double SILVERLINING_API | GetConfigOptionDouble (const char *key) const
| Retrieves a specific SilverLining.config value as a double.
bool SILVERLINING_API | GetConfigOptionBoolean (const char *key) const
| Retrieves a specific SilverLining.config value as a double.
void SILVERLINING_API | UpdateEphemeris ()
| Forces the ephemeris model to recalculate the position of the sun, moon, and stars for the currently simulated time and location.
void SILVERLINING_API | SetInfraRedMode (bool bInfraRed)
| Sets infrared sensor simulator mode.
bool SILVERLINING_API | GetInfraRedMode () const
| Gets whether infrared sensor mode is enabled.
void SILVERLINING_API | DisableFarCulling (bool bDisable)
| Allows you to disable culling of clouds against the far clip plane of your projection matrix.
bool SILVERLINING_API | GetFarCullingDisabled () const
| Retrieves whether culling against the far clip plane for clouds is disabled.
void SILVERLINING_API | EnableLensFlare (bool bEnabled)
| Enable or disable a big, flashy lens flare effect when the sun is visible in the scene.
bool SILVERLINING_API | GetLensFlareEnabled () const
| Returns if lens flare is currently enabled.
float SILVERLINING_API | GetSunOcclusion ()
| Returns the percentage of the sun that is currently visible in the scene, as a float from 0 to 1.0.
void SILVERLINING_API | SetRandomNumberGenerator (const RandomNumberGenerator *rng)
| If you wish to override SilverLining's default random number generator, which is based on the standard library's rand() function, you may do so by extending the RandomNumberGenerator base class, instantiating your extended class, and passing in a pointer to your class here.
bool SILVERLINING_API | Serialize (std::ostream &stream)
| Flatten the Atmosphere and everything in it to a stream - useful for capturing the state of everything to save to disk or for recreating the Atmosphere in response to a device reset in DX9.
bool SILVERLINING_API | Unserialize (std::istream &stream)
| Restore the Atmosphere from a stream generated from Atmosphere::Serialize.
void SILVERLINING_API | D3D9DeviceLost ()
| Call when a Direct3D9 device is lost.
void SILVERLINING_API | D3D9DeviceReset ()
| Call when a Direct3D9 device is reset.
## Static Public Member Functions
static void SILVERLINING_API | EnableHDR (bool hdr)
| Enabling High Dynamic Range (HDR) mode will disable all tone mapping, clamping, and gamma correction in SilverLining.
static bool SILVERLINING_API | GetHDREnabled ()
| Retrieve whether high dynamic range rendering mode is currently enabled.
static void SILVERLINING_API | SetResourceLoader (ResourceLoader *loader)
| Overrides the default FILE* - based resource loader with a customer-supplied resource loader object.
static ResourceLoader *SILVERLINING_API | GetResourceLoader ()
| Gets the ResourceLoader object being used to load resources, which may be the default FILE * based loader or a customer-supplied loader.
static void SILVERLINING_API | SetWorldUnits (double meters)
| By default, SilverLining assumes that one world unit is equal to one meter - that is, all of the dimensions for cloud layers, altitudes, etc.
static double SILVERLINING_API | GetUnitScale ()
| Retrieves the scale factor for world units, as set by SetWorldUnits().

## Detailed Description

This class is the main interface to SilverLining.

The Atmosphere simulates the sky, clouds, and weather.

To use an Atmosphere class, simply instantiate one using the default constructor, and then call the Initialize() method to set it up for either the OpenGL or DirectX rendering subsystems.

You may initialize the atmospheric conditions (cloud decks, wind, time, location, etc.) by populating an AtmosphericConditions class and passing this to the SetConditions method prior to rendering.

Then, within your main rendering loop, as soon as you have set the view and projection matrices for your scene to reflect the current camera position, call the DrawSky() method. This will draw the background of the sky and perform any lighting computations required for the atmosphere.

At this point, you may query GetSunOrMoonPosition() and GetSunOrMoonColor() to obtain the tone-mapped directional lighting information for your outdoor scene, and GetAmbientColor() to get the tone-mapped ambient skylight for your scene.

Finally, at the end of your rendering loop, call DrawObjects(). This will draw all of the clouds within the scene in back-to-front order.

## Constructor & Destructor Documentation

SilverLining::Atmosphere::Atmosphere | ( | const char * | userName,
|  | const char * | licenseKey |
| ) |  |  |

Constructor.

Creates an atmosphere object with default settings. You must specify the user name and license key provided with your SilverLining license purchase in order to instantiate an Atmosphere. An invalid name / key combination will result in a dialog box informing the user that this software is unlicensed, and in the application terminating after two minutes of use.

Warning! Displaying a dialog box while in full-screen mode will cause some DirectX applications to crash. To prevent the licensing dialog box on unlicensed SDK's from causing a crash, instantiate your Atmosphere object before entering full-screen mode.

Parameters:

  | userName | The user name, exactly as provided to you in the licensing information received with your SilverLining license purchase. A null-terminated C string.
  | licenseKey | The license key code, exactly as provided to you with your license purchase. Null-terminated C string.

SilverLining::Atmosphere::~Atmosphere | ( |  | ) |

Destructor.

This will clean up all cloud objects owned by the atmospheric conditions.

## Member Function Documentation

void SILVERLINING_API SilverLining::Atmosphere::ClearCloudLightingOverride | ( |  | ) |

Clears any manual overrides of the cloud light color that were previously set with Atmosphere::OverrideCloudLighting().

void SILVERLINING_API SilverLining::Atmosphere::DisableFarCulling | ( | bool | bDisable | ) | `[inline]`

Allows you to disable culling of clouds against the far clip plane of your projection matrix.

This might be useful if you have a very close far clip plane and cannot push it out to encompass the clouds due to depth buffer precision issues. Note, this call will disable culling, not clipping. You'll need to disable clipping explicitly prior to calling Atmosphere::DrawObjects() for this call to have an effect. In OpenGL, you can do this using glEnable(GL_DEPTH_CLAMP_NV) in conjuction with glDepthFunc(GL_LEQUAL).

void SILVERLINING_API SilverLining::Atmosphere::DrawObject | ( | ObjectHandle | obj | ) |

If you are managing your own cloud object drawing by calling DrawObjects(false), then your sorted list of objects may drawn by calling DrawObject() on each object.

Your rendering state must be set for rendering translucent objects. Specifically, you must enable blending with a blend equation of ONE, INVSRCALPHA. Lighting must be off, depth reads enabled, depth writes disabled, fog must be off, and 2D texturing enabled.

Parameters:

  | obj | An object handle obtained from the list returned by GetObjects(), after calling DrawObjects(false).

See also:
  DrawObjects()
  GetObjects()
  GetObjectDistance()

bool SILVERLINING_API SilverLining::Atmosphere::DrawObjects | ( | bool | drawClouds = `true`,
|  | bool | drawPrecipitation = `true`,
|  | bool | enableDepthTest = `true` |
| ) |  |  |

Call this at the end of your rendering loop.

After drawing all of your scene's objects, call the DrawObjects() method. This will draw all of the scene's clouds from back to front, if the drawClouds parameter is set to true. If there are translucent objects in your scene that should be drawn in front of the clouds, you'll want to draw those after calling DrawObjects().

Alternately, you may obtain handles to each cloud object independently and sort them with the other translucent objects in your scene. If you set drawClouds to false, DrawObjects() will build up a list of translucent objects to render for this frame, but not actually render them. You may then access each individual cloud object with the GetObjects() method, sort them against your other translucent objects using the GetObjectDistance() method to obtain their sort distances, and then actually draw them using DrawObject().

For applications where the scene is generally beneath the clouds, setting drawClouds to true and then drawing your own translucent objects after DrawObjects() is generally adequate.

Parameters:

  | drawClouds | Set to true if you want DrawObjects to actually draw all of the clouds, sorted from back to front. Set to false if you just want to build up a list of clouds to draw but not actually draw them; this list may be obtained with GetObjects().
  | drawPrecipitation | Set to false in order to disable rendering of precipitation effects. You may want to do this if you are calling DrawObjects() multiple times per frame (say, for multiple viewports or rendering passes with different viewpoints.) Otherwise, the internally maintained "last position" of each precipitation particle will be incorrect and rain particles will render incorrectly; you should only call DrawObjects with drawPrecipitation set to true once per frame. An alternate solution to this problem is to maintain a seperate Atmosphere object per view.
  | enableDepthTest | By default, translucent objects in the scene will read from the depth buffer but not write to them. If you have objects behind your clouds, this ensures they are drawn properly. However, in some situations, you may have a ground-based viewpoint where nothing is behind the clouds, and you may not have a depth buffer at all, or a depth buffer with undefined contents. In these situations, you may want to disable depth reads by setting enableDepthTest to false.

Returns:
  true if the clouds were successfully drawn.

bool SILVERLINING_API SilverLining::Atmosphere::DrawSky | ( | bool | drawSky,
|  | bool | geocentricMode = `false`,
|  | double | skyBoxDimension = `0`,
|  | bool | drawStars = `true`,
|  | bool | clearDepth = `true` |
| ) |  |  |

Call this at the beginning of your rendering loop.

At the start of each frame in your scene, first call SetCameraMatrix() and SetProjectionMatrix(). Then, call DrawSky(). This will draw the skybox for the simulated time and location, including the sun, moon, stars, and planets, and perform any necessary lighting calculations.

Alternately, DrawSky() may be called instead at the end of your rendering loop (prior to drawing translucent objects and prior to calling DrawObjects() ) if you set the clearDepth parameter to false. This may result in better performance, as it reduces overdraw against the sky box by rendering the sky box last instead of first.

It is important that the camera and projection matrices are set to reflect your scene's current camera prior to calling DrawSky(). Versions of SilverLining prior to 1.7 would extract these matrices automatically, but beginning with 1.7 you MUST call SetCameraMatrix() and SetProjectionMatrix(). We made this change in order to support DirectX 10, which has no fixed function pipeline for us to query for these matrices.

Parameters:

  | drawSky | Pass false to suppress drawing of the skybox, but still perform any lighting calculations required.
  | geocentricMode | If set to true, the stars, planets, sun, and moon will be drawn in a geocentric coordinate frame, where the X axis points through the prime meridian, Z points through the North Pole, and the origin is at the center of the Earth. This is generally only useful for space-based viewpoints. Normally, you'll leave this set to false so that astronomical objects will be drawn in local horizon coordinates.
  | skyBoxDimension | Sets an explicit dimension in world units for the length of a face of the sky box. Useful to prevent clipping of the skybox in systems that dynamically adjust the near and far clip planes; you can specify a value each frame that fits within them. Most applications can just leave this set to 0, in which case it will draw the sky box with the default size specified in SilverLining.config (1000)
  | drawStars | Set true to draw the stars when the sky is dark, conditions are not overcast, and fog is not present - or false to disable the drawing of the stars under all circumstances.
  | clearDepth | Set true to clear depth buffer contents whith sky, false to not clear depth and draw sky with Z test (useful for front to back sorting).

Returns:
  true if the skybox was successfully drawn.

static void SILVERLINING_API SilverLining::Atmosphere::EnableHDR | ( | bool | hdr | ) | `[inline, static]`

Enabling High Dynamic Range (HDR) mode will disable all tone mapping, clamping, and gamma correction in SilverLining.

This is only useful if you are rendering to a floating point framebuffer and applying a tone mapping operator of your own as a postprocessing step - otherwise, it'll just have the effect of making the sky and clouds pure white during the day.

The values written to the framebuffer in HDR mode will represent kilo-candelas per square meter, which may or may not be on a luminance scale comparable to the rest of your scene. The config settings sun-transmission-scale, sun-scattered-scale, moon-transmission-scale, and moon-scattered-scale can be used to scale our luminance values into a range comparable with your own. (You'll find these settings in the file resources/silverlining.config).

HDR is a static state; its current setting will apply to all Atmosphere objects at once. Under DirectX, HDR requires shader model 3.0 support.

See also:
  GetHDREnabled()

Parameters:

  | hdr | True to enable high dynamic range mode and disable all tone mapping and gamma correction. False to tone-map the sky to the displayable range of [0,1.0]. HDR is disabled by default.

void SILVERLINING_API SilverLining::Atmosphere::EnableLensFlare | ( | bool | bEnabled | ) | `[inline]`

Enable or disable a big, flashy lens flare effect when the sun is visible in the scene.

void SILVERLINING_API SilverLining::Atmosphere::ForceLightingRecompute | ( |  | ) | `[inline]`

Force SilverLining to recompute all cloud lighting.

Under normal operation, SilverLining only recomputes cloud lighting when the simulated time, location, or cloud cover changes, or when the camera moves a significant amount relative to each cloud. If you wish to force a lighting computation for all clouds to take place on the next frame, call this method.

There is a performance impact for calling this. Under normal circumstances, there is no reason to call this method.

void SILVERLINING_API SilverLining::Atmosphere::GetAmbientColor | ( | float * | r,
|  | float * | g,
|  | float * | b |
| ) |  |  | const

Returns the color of the ambient "skylight".

This color is suitable for use as an ambient light color for your scene. When used together with the directional light position and color returned by GetSunOrMoonPosition and GetSunOrMoonColor, an accurate simulated model of natural lighting conditions may be obtained.

The color returned by this method is arrived at by simulating the light scattered over the sky above your simulated location at your simulated time, commonly referred to as "skylight." This light is then tone-mapped to account for high dynamic range in the same manner as the directional light. This color is also affected by the presence of thick cloud decks above the camera position.

Parameters:

  | r | A pointer to a float to receive the red channel of the ambient color, from 0 -1.0.
  | g | A pointer to a float to receive the green channel of the ambient color, from 0 -1.0.
  | b | A pointer to a float to receive the blue channel of the ambient color, from 0 -1.0.

const AtmosphericConditions& SILVERLINING_API SilverLining::Atmosphere::GetConditions | ( |  | ) | const

Accessor to the current cloud, wind, time, and location settings.

Returns a const reference to an AtmosphericConditions class that contains the settings for the current simulation.

AtmosphericConditions* SILVERLINING_API SilverLining::Atmosphere::GetConditions | ( |  | ) | `[inline]`

Return a reference to the current simulated conditions.

Use this to change the current simulated time, location, etc., by manipulating the AtmosphericConditions object owned by the Atmosphere class directly.

bool SILVERLINING_API SilverLining::Atmosphere::GetConfigOptionBoolean | ( | const char * | key | ) | const

Retrieves a specific SilverLining.config value as a double.

double SILVERLINING_API SilverLining::Atmosphere::GetConfigOptionDouble | ( | const char * | key | ) | const

Retrieves a specific SilverLining.config value as a double.

const char* SILVERLINING_API SilverLining::Atmosphere::GetConfigOptionString | ( | const char * | key | ) | const

Retrieves a specific SilverLining.config value as a string.

bool SILVERLINING_API SilverLining::Atmosphere::GetFarCullingDisabled | ( |  | ) | const`[inline]`

Retrieves whether culling against the far clip plane for clouds is disabled.

See also:
  DisableFarCulling()

bool SILVERLINING_API SilverLining::Atmosphere::GetFogEnabled | ( |  | ) | const

Returns whether SilverLining would like to suggest fog settings.

SilverLining depends on fog effects to simulate being inside a stratus or broken stratus cloud deck, or to simulate reduced visibility due to the presence of rain or snow at the camera's location. If this method returns true, then you should call GetFogSettings in order to help determine the appropriate fog configuration for your scene in order to preserve these atmospheric effects.

void SILVERLINING_API SilverLining::Atmosphere::GetFogSettings | ( | float * | density,
|  | float * | r,
|  | float * | g,
|  | float * | b |
| ) |  |  | const

Returns exponential fog settings appropriate for your scene.

If GetFogEnabled() returns true, then call GetFogSettings() to obtain suggested fog values required to preserve in-cloud effects and precipitation effects that depend on fog. The r, g, and b colors returned are the color of the fog itself modulated by the directional light color.

Parameters:

  | density | A fog density appropriate for use in GL_FOG_DENSITY in exponential fog mode. ie,
  | r | A pointer to a float to receive the red component of the fog color, from 0 - 1.0.
  | g | A pointer to a float to receive the green component of the fog color, from 0 - 1.0.
  | b | A pointer to a float to receive the blue component of the fog color, from 0 - 1.0.

double SILVERLINING_API SilverLining::Atmosphere::GetFramerate | ( |  | ) | const`[inline]`

Return the current framerate, based on the rendering time of the previous frame, in frames per second.

double SILVERLINING_API SilverLining::Atmosphere::GetGamma | ( |  | ) | const

Retrieves the value being used for display gamma correction.

See also:
  SetGamma()

void SILVERLINING_API SilverLining::Atmosphere::GetHaze | ( | float & | hazeR,
|  | float & | hazeG,
|  | float & | hazeB,
|  | double & | hazeDepth,
|  | double & | hazeDensity |
| ) |  |  |

Retrieves the haze parameters set previously by SetHaze().

See SetHaze() for a description of the parameters.

static bool SILVERLINING_API SilverLining::Atmosphere::GetHDREnabled | ( |  | ) | `[inline, static]`

Retrieve whether high dynamic range rendering mode is currently enabled.

See also:
  EnableHDR()

void SILVERLINING_API SilverLining::Atmosphere::GetHorizonColor | ( | float | yawDegrees,
|  | float | pitchDegrees,
|  | float * | r,
|  | float * | g,
|  | float * | b |
| ) |  |  | const

Returns the average color of the sky at the horizon.

Based on the specified view direction and field of view, this method will return the average color of the sky in the scene at the horizon. This is often an effective choice of a fog color for your scenes, since it will blend well with the sky in the distance - thereby covering up outdoor scenes that lack sufficient terrain to extend to the horizon. Even for scenes that do render to the horizon, this is a good color for fog just for simulating haze and atmospheric perspective.

Note that during sunrise and sunset when a red glow surround the sun, this color may vary widely depending on the yawDegrees parameter.

Parameters:

  | yawDegrees | The camera's yaw value, in degrees east from north. The horizon color will be calculated by averaging the field of view's horizon color about this direction.
  | pitchDegrees | The number of degrees above the horizon to sample the color from.
  | r | A pointer to a float to receive the red channel of the horizon color, from 0 - 1.0
  | g | A pointer to a float to receive the red channel of the horizon color, from 0 - 1.0
  | b | A pointer to a float to receive the red channel of the horizon color, from 0 - 1.0

void SILVERLINING_API SilverLining::Atmosphere::GetHorizonColor | ( | float | pitchDegrees,
|  | float * | r,
|  | float * | g,
|  | float * | b |
| ) |  |  | const

Returns the average color of the sky at the horizon.

Based on the current camera orientation and field of view, this method will return the average color of the sky in the scene at the horizon. This is often an effective choice of a fog color for your scenes, since it will blend well with the sky in the distance - thereby covering up outdoor scenes that lack sufficient terrain to extend to the horizon. Even for scenes that do render to the horizon, this is a good color for fog just for simulating haze and atmospheric perspective.

Note that during sunrise and sunset when a red glow surround the sun, this color may vary widely depending on the orientation of the camera.

Parameters:

  | pitchDegrees | The number of degrees above the horizon to sample the color from.
  | r | A pointer to a float to receive the red channel of the horizon color, from 0 - 1.0
  | g | A pointer to a float to receive the red channel of the horizon color, from 0 - 1.0
  | b | A pointer to a float to receive the red channel of the horizon color, from 0 - 1.0

bool SILVERLINING_API SilverLining::Atmosphere::GetInfraRedMode | ( |  | ) | const`[inline]`

Gets whether infrared sensor mode is enabled.

bool SILVERLINING_API SilverLining::Atmosphere::GetLensFlareEnabled | ( |  | ) | const`[inline]`

Returns if lens flare is currently enabled.

See also:
  EnableLensFlare()

void SILVERLINING_API SilverLining::Atmosphere::GetMoonColor | ( | float * | r,
|  | float * | g,
|  | float * | b |
| ) |  |  | const

Returns the color of the moon's light source.

This method will return a color suitable for lighting your scene based on the natural lighting conditions. The value is tone-mapped, so the high dynamic range between night and day and they way the human eye perceives it is modeled. For example, at night it may be suprisingly bright if a full moon is out. This scattering is sensitive to the turbidity setting specified in the AtmosphericConditions class.

This method only simulates natural light sources passing through the atmosphere: the sun, moon, starlight, planetary light, airglow, galactic light, and zodiacal light. At night, it may be appropriate to add in a little extra to simulate city lights for urban or suburban scenes.

If your camera position is below a thick, infinite stratus cloud deck with coverage of 1.0, the effects on lighting will be simulated as well.

Parameters:

  | r | A pointer to a float that will be populated with the red directional light color, ranging from 0 - 1.0.
  | g | A pointer to a float that will be populated with the green directional light color, ranging from 0 - 1.0.
  | b | A pointer to a float that will be populated with the blue directional light color, ranging from 0 - 1.0.

void SILVERLINING_API SilverLining::Atmosphere::GetMoonPosition | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  | const

Retrieve the normalized direction of the moon's light source.

This method will return a normalized direction vector pointing to the moon, which may be below the horizon.

void SILVERLINING_API SilverLining::Atmosphere::GetMoonPositionEquatorial | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  | const

Retrieve the direction of the moon in equatorial coordinates; where x points toward the vernal equinox (where the equator and ecliptic intersect), z points through the north pole.

void SILVERLINING_API SilverLining::Atmosphere::GetMoonPositionGeographic | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  | const

Retrieve the direction of the moon, relative to the center of the Earth in a geocentric coordinate system, where the z axis points from the center of the Earth to the North Pole, and x points toward the prime meridian.

float SILVERLINING_API SilverLining::Atmosphere::GetObjectDistance | ( | ObjectHandle | obj,
|  | float | obj2X,
|  | float | obj2Y,
|  | float | obj2Z,
|  | float | sortPosX,
|  | float | sortPosY,
|  | float | sortPosZ |
| ) |  |  |

If you are managing your own cloud drawing, you'll need to sort them from back to front along with the other objects in your scene.

This method will return the distance from a given position you are sorting from to the object in question.

Parameters:

  | obj | An object handle obtained from the list returned by GetObjects(), after calling DrawObjects(false).
  | obj2X | The X coordinate of the object you are currently comparing this one against.
  | obj2Y | The Y coordinate of the object you are currently comparing this one against.
  | obj2Z | The Z coordinate of the object you are currently comparing this one against.
  | sortPosX | The X coordinate of the viewpoint location you are sorting translucent objects against.
  | sortPosY | The Y coordinate of the viewpoint location you are sorting translucent objects against.
  | sortPosZ | The Z coordinate of the viewpoint location you are sorting translucent objects against.

Returns:
  The distance to the object from the sort position specified, taking into account internal depth biases.

See also:
  DrawObjects()
  DrawObject()
  GetObjects()

float SILVERLINING_API SilverLining::Atmosphere::GetObjectDistance | ( | ObjectHandle | obj,
|  | ObjectHandle | obj2,
|  | float | sortPosX,
|  | float | sortPosY,
|  | float | sortPosZ |
| ) |  |  |

If you are managing your own cloud drawing, you'll need to sort them from back to front along with the other objects in your scene.

This method will return the distance from a given position you are sorting from to the object in question.

Parameters:

  | obj | An object handle obtained from the list returned by GetObjects(), after calling DrawObjects(false).
  | obj2 | The object you are comparing this object against.
  | sortPosX | The X coordinate of the viewpoint location you are sorting translucent objects against.
  | sortPosY | The Y coordinate of the viewpoint location you are sorting translucent objects against.
  | sortPosZ | The Z coordinate of the viewpoint location you are sorting translucent objects against.

Returns:
  The distance to the object from the sort position specified, taking into account internal depth biases.

See also:
  DrawObjects()
  DrawObject()
  GetObjects()

void SILVERLINING_API SilverLining::Atmosphere::GetObjectPosition | ( | ObjectHandle | obj,
|  | float & | x,
|  | float & | y,
|  | float & | z |
| ) |  |  |

Obtains the position, in world coordinates, of a given ObjectHandle obtained from the list returned from GetObjects().

static ResourceLoader* SILVERLINING_API SilverLining::Atmosphere::GetResourceLoader | ( |  | ) | `[inline, static]`

Gets the ResourceLoader object being used to load resources, which may be the default FILE * based loader or a customer-supplied loader.

void SILVERLINING_API SilverLining::Atmosphere::GetRightVector | ( | double & | x,
|  | double & | y,
|  | double & | z |
| ) |  |  |

Returns the direction that SilverLining assumes is "right" as a unit vector.

void SILVERLINING_API SilverLining::Atmosphere::GetSunColor | ( | float * | r,
|  | float * | g,
|  | float * | b |
| ) |  |  | const

Returns the color of the sun's light source.

This method will return a color suitable for lighting your scene based on the natural lighting conditions. The value is tone-mapped, so the high dynamic range between night and day and they way the human eye perceives it is modeled. At sunset or sunrise, there may be an orange, pink, or reddish hue due to the scattering of sunlight through the atmosphere - which is also simulated. This scattering is sensitive to the turbidity setting specified in the AtmosphericConditions class.

If your camera position is below a thick, infinite stratus cloud deck with coverage of 1.0, the effects on lighting will be simulated as well.

Parameters:

  | r | A pointer to a float that will be populated with the red directional light color, ranging from 0 - 1.0.
  | g | A pointer to a float that will be populated with the green directional light color, ranging from 0 - 1.0.
  | b | A pointer to a float that will be populated with the blue directional light color, ranging from 0 - 1.0.

float SILVERLINING_API SilverLining::Atmosphere::GetSunOcclusion | ( |  | ) |

Returns the percentage of the sun that is currently visible in the scene, as a float from 0 to 1.0.

This can be used for determining if you're in a shadow, or for implementing your own lens flare effects.

void SILVERLINING_API SilverLining::Atmosphere::GetSunOrMoonColor | ( | float * | r,
|  | float * | g,
|  | float * | b |
| ) |  |  | const

Returns the color of the dominant directional light source.

This method will return a color suitable for lighting your scene based on the natural lighting conditions. The value is tone-mapped, so the high dynamic range between night and day and they way the human eye perceives it is modeled. For example, at noon this value is likely white, but at night it may be suprisingly bright if a full moon is out. At sunset or sunrise, there may be an orange, pink, or reddish hue due to the scattering of sunlight through the atmosphere - which is also simulated. This scattering is sensitive to the turbidity setting specified in the AtmosphericConditions class.

This method only simulates natural light sources passing through the atmosphere: the sun, moon, starlight, planetary light, airglow, galactic light, and zodiacal light. At night, it may be appropriate to add in a little extra to simulate city lights for urban or suburban scenes.

If your camera position is below a thick, infinite stratus cloud deck with coverage of 1.0, the effects on lighting will be simulated as well.

Parameters:

  | r | A pointer to a float that will be populated with the red directional light color, ranging from 0 - 1.0.
  | g | A pointer to a float that will be populated with the green directional light color, ranging from 0 - 1.0.
  | b | A pointer to a float that will be populated with the blue directional light color, ranging from 0 - 1.0.

void SILVERLINING_API SilverLining::Atmosphere::GetSunOrMoonPosition | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  | const

Retrieve the normalized direction of the dominant directional light source.

This method will return a normalized direction vector pointing to the dominant light source, which may be the moon after sunset.

void SILVERLINING_API SilverLining::Atmosphere::GetSunOrMoonPositionEquatorial | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  | const

Retrieve the normalized direction of the dominant directional light source.

This method will return a normalized direction vector pointing to the dominant light source, which may be the moon after sunset. The direction is in equatorial coordinates; where x points toward the vernal equinox (where the equator and ecliptic intersect), z points through the north pole.

void SILVERLINING_API SilverLining::Atmosphere::GetSunOrMoonPositionGeographic | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  | const

Retrieve the normalized direction of the dominant directional light source.

This method will return a normalized direction vector pointing to the dominant light source, which may be the moon after sunset. The direction is relative to the center of the Earth in a geocentric coordinate system, where the z axis points from the center of the Earth to the North Pole, and x points toward the prime meridian.

void SILVERLINING_API SilverLining::Atmosphere::GetSunPosition | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  | const

Retrieve the normalized direction of the sun's light source.

This method will return a normalized direction vector pointing to the sun, which may be below the horizon.

void SILVERLINING_API SilverLining::Atmosphere::GetSunPositionEquatorial | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  | const

Retrieve the direction of the sun in equatorial coordinates; where x points toward the vernal equinox (where the equator and ecliptic intersect), z points through the north pole.

void SILVERLINING_API SilverLining::Atmosphere::GetSunPositionGeographic | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  | const

Retrieve the direction of the sun, relative to the center of the Earth in a geocentric coordinate system, where the z axis points from the center of the Earth to the North Pole, and x points toward the prime meridian.

static double SILVERLINING_API SilverLining::Atmosphere::GetUnitScale | ( |  | ) | `[inline, static]`

Retrieves the scale factor for world units, as set by SetWorldUnits().

Defaults to 1.0.

void SILVERLINING_API SilverLining::Atmosphere::GetUpVector | ( | double & | x,
|  | double & | y,
|  | double & | z |
| ) |  |  |

Returns the direction that SilverLining assumes is "up" as a unit vector.

int SILVERLINING_API SilverLining::Atmosphere::Initialize | ( | int | renderer,
|  | const char * | resourceDirectoryPath,
|  | bool | rightHanded,
|  | void * | environment |
| ) |  |  |

Call this immediately after constructing your scene's Atmosphere and initializing your graphics subsystem (OpenGL, OpenGL32, DirectX9, DirectX10, or DirectX11).

This method will configure SilverLining to use OpenGL or DirectX, and in the case of DirectX, allows you to pass in a required pointer to your IDirect3DDevice9, ID3D10Device, or ID3D11Device object.

If you are tying SilverLining directly into your own rendering engine, pass Atmosphere::CUSTOM_RENDERER as the renderer, provide your own implementation of the functions in SilverLiningDLLCommon.h, and link against the "static" versions of the SilverLining libraries.

Note, DirectX 9 users must create their IDirect3DDevice9 using the D3DPRESENTFLAG_LOCKABLE_BACKBUFFER flag. SilverLining depends on the ability to read back a small number of pixels from the back buffer when it computes its lighting effects. Passing in a device without a lockable back buffer will result in black clouds. You also must NOT create your device with the D3DCREATE_PUREDEVICE flag; SilverLining must be able to read your current render states and transforms in order to restore them to what they were when we finish our own drawing.

The OPENGL32CORE renderer will only initialize successfully on graphics hardware and drivers that support the OpenGL 3.2 specification, with contexts created explicitly for OpenGL 3.2 or newer. It is compatible with forward-compatible OpenGL 3.2 core profile contexts that do not have backward-compatibilty enabled; no deprecated OpenGL functions are used in this renderer.

OpenGL users may pass 0 for the environment parameter. It is ignored for OpenGL.

You must also pass in a path to the Resources directory, which contains the art resources, data files, and shaders required for SilverLining to run. You may name and redistribute this directory however you wish, but SilverLining needs to know where it is and what it's called.

Parameters:

  | renderer | Pass the enumerated constant `SilverLining::OPENGL` or `SilverLining::OPENGL32CORE` or `SilverLining::DIRECTX9` or `SilverLining::DIRECTX10` or `SilverLining::DIRECTX11` or `SilverLining::CUSTOM_RENDERER`
  | resourceDirectoryPath | A null-terminated string that specifies a path to the application's redistributed "Resources" directory, including the directory name itself. For example, "..\\Resources\\". If you pass NULL, the default path is ".\\Resources".
  | rightHanded | Pass true if you're using a right-handed coordinate system, false for a left-handed coordinate system. OpenGL typically uses right-handed; DirectX can use either.
  | environment | Only required for DIRECTX9, DIRECTX10, or DIRECTX11 renderers; a pointer to your IDirect3DDevice9, ID3D10Device, or ID3D11Device.

Returns:
  An error code from the Atmosphere::InitializeErrors enumeration, or E_NOERROR. See the troubleshooting section of the documentation for further guidance if you encounter an error.

void SILVERLINING_API SilverLining::Atmosphere::OverrideCloudLighting | ( | float | ambientR,
|  | float | ambientG,
|  | float | ambientB,
|  | float | diffuseR,
|  | float | diffuseG,
|  | float | diffuseB |
| ) |  |  |

Use this to use specific colors for lighting the clouds, instead of the sun, moon, and sky colors.

See also:
  ClearCloudLightingOverride()

Parameters:

  | ambientR | The red component of the explicit color to use for ambient lighting of the clouds.
  | ambientG | The green component of the explicit color to use for ambient lighting of the clouds.
  | ambientB | The blue component of the explicit color to use for ambient lighting of the clouds.
  | diffuseR | The red component of the explicit color to use for diffuse (directional) lighting of the clouds.
  | diffuseG | The green component of the explicit color to use for diffuse (directional) lighting of the clouds.
  | diffuseB | The blue component of the explicit color to use for diffuse (directional) lighting of the clouds.

void SILVERLINING_API SilverLining::Atmosphere::ReloadConfigFile | ( |  | ) |

Reloads the SilverLining.config file in the resources directory.

This won't immediately affect existing clouds in the scene, but will affect new clouds created going forward. Mostly this is useful for advanced users who want to tweak the default config file settings without having to shut down and restart their application every time. Requires that Atmosphere::Initialize() was called previously.

bool SILVERLINING_API SilverLining::Atmosphere::Serialize | ( | std::ostream & | stream | ) |

Flatten the Atmosphere and everything in it to a stream - useful for capturing the state of everything to save to disk or for recreating the Atmosphere in response to a device reset in DX9.

void SILVERLINING_API SilverLining::Atmosphere::SetCameraMatrix | ( | const double * | cameraMatrix | ) |

Call this at the beginning of each rendering loop, prior to calling DrawSky().

The matrix passed in should represent the transform for your camera, as a 4x4 matrix of doubles. Be sure to also call SetProjectionMatrix()

void SILVERLINING_API SilverLining::Atmosphere::SetConditions | ( | const AtmosphericConditions & | conditions | ) |

Configures the simulated cloud, wind, time, and location.

The cloud, wind, time, and location settings are all contained inside an AtmosphericConditions object. Pass in an AtmosphericConditions class configured the way you like it, after first calling Initialize on the Atmosphere class, and before rendering your scene. Any previous conditions will be overwritten by this call.

Note, this passes in a const reference to your AtmosphericConditions class. It is copied internally, and you're free to dispose of your AtmosphericConditions object once you have passed it into SetConditions.

void SILVERLINING_API SilverLining::Atmosphere::SetConfigOption | ( | const char * | key,
|  | const char * | value |
| ) |  |  |

Sets a specific SilverLining.config value.

Will overwrite whatever was specified. Subject to the same caveats listed for ReloadConfigFile().

void SILVERLINING_API SilverLining::Atmosphere::SetGamma | ( | double | gamma | ) |

Sets the value used for gamma correction of the display.

Defaults to the sky-box-gamma setting. 1.8 works well. Higher values will yield lighter skies and natural light.

void SILVERLINING_API SilverLining::Atmosphere::SetHaze | ( | float | hazeR,
|  | float | hazeG,
|  | float | hazeB,
|  | double | hazeDepth,
|  | double | hazeDensity |
| ) |  |  |

Causes the sky to blend toward a specified "haze color" toward the horizon.

Although it does simulate a layer of colored fog, it's most practical application to allow for exact blending against a fog color used for terrain, in order to obscure the horizon line. For applications that do not render terrain all the way to the horizon, this is a must. GetHorizonColor() may be used for an approximate match in the absence of an artificial layer of haze; it is more physically accurate.

The haze color passed in is not lit; you must pre-multiply the color yourself. The skybox will blend toward the exact color passed in at the horizon, night or day. You could abuse this to create a glow effect at the horizon from city lights, for example.

By default, hazeDepth is set to 0, thereby disabling the haze effects. If the viewpoint is within a cloud, the fog effects from the cloud will drawn in the sky in lieu of haze.

Parameters:

  | hazeR | The red component of the color to blend toward at the horizon.
  | hazeG | The red component of the color to blend toward at the horizon.
  | hazeB | The red component of the color to blend toward at the horizon.
  | hazeDepth | The simulated height of the haze volume at ground level, in world units.
  | hazeDensity | The fog density parameter of the exponential fog equation.

void SILVERLINING_API SilverLining::Atmosphere::SetInfraRedMode | ( | bool | bInfraRed | ) | `[inline]`

Sets infrared sensor simulator mode.

Just renders everything as black except the sun.

void SILVERLINING_API SilverLining::Atmosphere::SetProjectionMatrix | ( | const double * | projectionMatrix | ) |

Call this at the beginning of each rendering loop, prior to calling DrawSky().

The matrix passed in should represent the projection matrix for your scene, as a 4x4 matrix of doubles. Be sure to also call SetCameraMatrix()

void SILVERLINING_API SilverLining::Atmosphere::SetRandomNumberGenerator | ( | const RandomNumberGenerator * | rng | ) |

If you wish to override SilverLining's default random number generator, which is based on the standard library's rand() function, you may do so by extending the RandomNumberGenerator base class, instantiating your extended class, and passing in a pointer to your class here.

You are responsible for deleting the RandomNumberGenerator you passed in at shutdown.

static void SILVERLINING_API SilverLining::Atmosphere::SetResourceLoader | ( | ResourceLoader * | loader | ) | `[inline, static]`

Overrides the default FILE* - based resource loader with a customer-supplied resource loader object.

See the ResourceLoader documentation for more information. This allows you to include SilverLining's textures, models, and shaders within your own resource management scheme. This should be called after initializing your first Atmosphere object, but before calling Atmosphere::Initialize(). You are responsible for deleting the ResourceLoader you passed in at shutdown.

void SILVERLINING_API SilverLining::Atmosphere::SetRightVector | ( | double | x,
|  | double | y,
|  | double | z |
| ) |  |  |

Sets the assumption of what direction is "right".

Defaults to (1, 0, 0) if unset. If the vector (x, y, z) is not a unit vector, it is normalized before being stored. Cannot be called prior to Atmosphere::Initialize(). Must be called in conjunction with SetUpVector().

If you're not using a default right vector, be sure to call this prior to positioning any clouds.

See also:
  SetUpVector()
  GetRightVector()

void SILVERLINING_API SilverLining::Atmosphere::SetUpVector | ( | double | x,
|  | double | y,
|  | double | z |
| ) |  |  |

Sets the assumption of what direction is "up".

Defaults to (0, 1, 0) if unset. If the vector (x, y, z) is not a unit vector, it is normalized before being stored. Cannot be called prior to Atmosphere::Initialize(). Must be called in conjunction with SetRightVector().

If you're not using a default Up vector, be sure to call this prior to positioning any clouds.

See also:
  SetRightVector()
  GetUpVector()

static void SILVERLINING_API SilverLining::Atmosphere::SetWorldUnits | ( | double | meters | ) | `[inline, static]`

By default, SilverLining assumes that one world unit is equal to one meter - that is, all of the dimensions for cloud layers, altitudes, etc.

are in meters. If you are using a different scale, you may specify the size of one unit in meters here. This should be set prior to initializing the Atmosphere object.

SilverLining::Atmosphere::SL_VECTOR | ( | ObjectHandle |  | ) | const

If you called DrawObjects() with the drawClouds parameter set to false, no clouds will actually be drawn.

It's then your responsibility to obtain a list of cloud objects to draw, and draw them yourself. GetObjects() provides you with this list. This list will be empty until DrawObjects() has been called for the current frame. If you call DrawObjects() with the drawClouds parameter set to true, this list will also be empty, since the objects have already been drawn.

See also:
  DrawObjects()
  GetObjectDistance()
  DrawObject()

bool SILVERLINING_API SilverLining::Atmosphere::Unserialize | ( | std::istream & | stream | ) |

Restore the Atmosphere from a stream generated from Atmosphere::Serialize.

The Atmosphere must be constructed and initialized before calling Unserialize().

void SILVERLINING_API SilverLining::Atmosphere::UpdateEphemeris | ( |  | ) |

Forces the ephemeris model to recalculate the position of the sun, moon, and stars for the currently simulated time and location.

This happens automatically when DrawSky() is called; this is provided only if you need to compute the astronomical positions in response to a change in the simulated time and location prior to calling DrawSky().

The documentation for this class was generated from the following file:

- /home/fkane/sl/trunk/Public Headers/Atmosphere.h