VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions
makVrv::DtEnvironmentInfo Class Reference

The DtEnvironmentInfo class is responsible for holding data related to the environment such as sky lighting and fog. More...

Inheritance diagram for makVrv::DtEnvironmentInfo:
Inheritance graph
[legend]

Public Member Functions

virtual osg::Vec3 lightPosition () const
 Returns the sky light position. More...
 
virtual osg::Vec4 ambientColor () const
 Returns the sky light ambient color. More...
 
virtual osg::Vec4 diffuseColor () const
 Returns the sky light diffuse color. More...
 
virtual osg::Vec4 fogColor () const
 Returns the distance fog color. More...
 
virtual float fogDensity () const
 Returns the distance fog density. More...
 
virtual bool heightFogEnable () const
 Returns the height fog enabled state. More...
 
virtual float heightFogAltitude () const
 Returns the height fog altitude. More...
 
virtual float heightFogDensity () const
 Returns the height fog density. More...
 
virtual osg::Vec4 heightFogColor () const
 Returns the height fog color. More...
 
virtual void setLightPosition (const osg::Vec3 &pos)
 Sets the sky light position. More...
 
virtual void setAmbientColor (const osg::Vec4 &color)
 Sets the sky light ambient color. More...
 
virtual void setDiffuseColor (const osg::Vec4 &color)
 Sets the sky light diffuse color. More...
 
virtual void setFogColor (const osg::Vec4 &color)
 Sets the distance fog color. More...
 
virtual void setFogDensity (float density)
 Sets the distance fog density. More...
 
virtual void setHeightFogEnable (bool enable)
 Sets the height fog enable state. More...
 
virtual void setHeightFogAltitude (float altitude)
 Sets the height fog altitude. More...
 
virtual void setHeightFogDensity (float density)
 Sets the height fog density. More...
 
virtual void setHeightFogColor (const osg::Vec4 &color)
 Sets the height fog color. More...
 
virtual ~DtEnvironmentInfo ()
 DTOR. More...
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor. More...
 
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor. More...
 

Static Public Member Functions

static DtEnvironmentInfoinstance (DtDe &de)
 Get an instance of the DtEnvironmentInfo object. More...
 

Protected Attributes

osg::Vec3 myLightPosition
 
osg::Vec4 myAmbientColor
 
osg::Vec4 myDiffuseColor
 
osg::Vec4 myFogColor
 
float myFogDensity
 
bool myHeightFogEnable
 
float myHeightFogAltitude
 
float myHeightFogDensity
 
osg::Vec4 myHeightFogColor
 

Private Member Functions

 DtEnvironmentInfo ()
 Default constructor. More...
 
 DtEnvironmentInfo (const DtEnvironmentInfo &)
 Copy constructor. More...
 
DtEnvironmentInfooperator= (const DtEnvironmentInfo &)
 Assignment Operator. More...
 

Detailed Description

The DtEnvironmentInfo class is responsible for holding data related to the environment such as sky lighting and fog.

Constructor & Destructor Documentation

virtual makVrv::DtEnvironmentInfo::~DtEnvironmentInfo ( )
virtual

DTOR.

makVrv::DtEnvironmentInfo::DtEnvironmentInfo ( )
private

Default constructor.

Note
Not implemented
makVrv::DtEnvironmentInfo::DtEnvironmentInfo ( const DtEnvironmentInfo )
private

Copy constructor.

Note
Not implemented

Member Function Documentation

static DtEnvironmentInfo& makVrv::DtEnvironmentInfo::instance ( DtDe de)
static

Get an instance of the DtEnvironmentInfo object.

Parameters
deThe display engine root for the singleton.
virtual osg::Vec3 makVrv::DtEnvironmentInfo::lightPosition ( ) const
virtual

Returns the sky light position.

virtual osg::Vec4 makVrv::DtEnvironmentInfo::ambientColor ( ) const
virtual

Returns the sky light ambient color.

virtual osg::Vec4 makVrv::DtEnvironmentInfo::diffuseColor ( ) const
virtual

Returns the sky light diffuse color.

virtual osg::Vec4 makVrv::DtEnvironmentInfo::fogColor ( ) const
virtual

Returns the distance fog color.

virtual float makVrv::DtEnvironmentInfo::fogDensity ( ) const
virtual

Returns the distance fog density.

virtual bool makVrv::DtEnvironmentInfo::heightFogEnable ( ) const
virtual

Returns the height fog enabled state.

virtual float makVrv::DtEnvironmentInfo::heightFogAltitude ( ) const
virtual

Returns the height fog altitude.

virtual float makVrv::DtEnvironmentInfo::heightFogDensity ( ) const
virtual

Returns the height fog density.

virtual osg::Vec4 makVrv::DtEnvironmentInfo::heightFogColor ( ) const
virtual

Returns the height fog color.

virtual void makVrv::DtEnvironmentInfo::setLightPosition ( const osg::Vec3 &  pos)
virtual

Sets the sky light position.

Parameters
posThe light position.
virtual void makVrv::DtEnvironmentInfo::setAmbientColor ( const osg::Vec4 &  color)
virtual

Sets the sky light ambient color.

Parameters
colorThe ambient color.
virtual void makVrv::DtEnvironmentInfo::setDiffuseColor ( const osg::Vec4 &  color)
virtual

Sets the sky light diffuse color.

Parameters
colorThe diffuse color.
virtual void makVrv::DtEnvironmentInfo::setFogColor ( const osg::Vec4 &  color)
virtual

Sets the distance fog color.

Parameters
colorThe fog color.
virtual void makVrv::DtEnvironmentInfo::setFogDensity ( float  density)
virtual

Sets the distance fog density.

Parameters
densityThe fog density value.
virtual void makVrv::DtEnvironmentInfo::setHeightFogEnable ( bool  enable)
virtual

Sets the height fog enable state.

Parameters
enableSet to true to enable the height fog.
virtual void makVrv::DtEnvironmentInfo::setHeightFogAltitude ( float  altitude)
virtual

Sets the height fog altitude.

Parameters
altitudeThe altitude (above sea level) to use.
virtual void makVrv::DtEnvironmentInfo::setHeightFogDensity ( float  density)
virtual

Sets the height fog density.

Parameters
densityThe density to use for exp() falloff.
virtual void makVrv::DtEnvironmentInfo::setHeightFogColor ( const osg::Vec4 &  color)
virtual

Sets the height fog color.

Parameters
colorThe base color used for height fog.
DtEnvironmentInfo& makVrv::DtEnvironmentInfo::operator= ( const DtEnvironmentInfo )
private

Assignment Operator.

Note
Not implemented

Member Data Documentation

osg::Vec3 makVrv::DtEnvironmentInfo::myLightPosition
protected
osg::Vec4 makVrv::DtEnvironmentInfo::myAmbientColor
protected
osg::Vec4 makVrv::DtEnvironmentInfo::myDiffuseColor
protected
osg::Vec4 makVrv::DtEnvironmentInfo::myFogColor
protected
float makVrv::DtEnvironmentInfo::myFogDensity
protected
bool makVrv::DtEnvironmentInfo::myHeightFogEnable
protected
float makVrv::DtEnvironmentInfo::myHeightFogAltitude
protected
float makVrv::DtEnvironmentInfo::myHeightFogDensity
protected
osg::Vec4 makVrv::DtEnvironmentInfo::myHeightFogColor
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)