makVrv::DtEnvironmentInfo Class Reference

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

Inheritance diagram for makVrv::DtEnvironmentInfo:

Public Member Functions
virtual osg::Vec3	lightPosition () const
virtual osg::Vec4	ambientColor () const
virtual osg::Vec4	diffuseColor () const
virtual Vector4_32	fogColor () const
virtual float	fogDensity () const
virtual bool	heightFogEnable () const
virtual float	heightFogAltitude () const
virtual float	heightFogDensity () const
virtual float	heightFogDistance () const
virtual Vector4_32	heightFogColor () const
virtual void	setFogColor (const Vector4_32 &color)
virtual void	setFogDensity (float density)
virtual void	setHeightFogEnable (bool enable)
virtual void	setHeightFogAltitude (float altitude)
virtual void	setHeightFogDensity (float density)
virtual void	setHeightFogDistance (float distance)
virtual void	setHeightFogColor (const Vector4_32 &color)
virtual void	setLightPosition (const osg::Vec3 &pos)
virtual void	setAmbientColor (const osg::Vec4 &color)
virtual void	setDiffuseColor (const osg::Vec4 &color)
virtual	~DtEnvironmentInfo ()
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtEnvironmentInfo &	instance (DtDe &de)

Protected Attributes
osg::Vec3	myLightPosition
osg::Vec4	myAmbientColor
osg::Vec4	myDiffuseColor
float	myFogDensity
bool	myHeightFogEnable
float	myHeightFogAltitude
float	myHeightFogDensity
float	myHeightFogDistance
Vector4_32	myHeightFogColor
Vector4_32	myFogColor

Private Member Functions
	DtEnvironmentInfo ()
	DtEnvironmentInfo (const DtEnvironmentInfo &)
DtEnvironmentInfo &	operator= (const DtEnvironmentInfo &)

Constructor & Destructor Documentation

virtual makVrv::DtEnvironmentInfo::~DtEnvironmentInfo ( )

virtual

DTOR.

makVrv::DtEnvironmentInfo::DtEnvironmentInfo ( )

private

Default constructor.

makVrv::DtEnvironmentInfo::DtEnvironmentInfo ( const DtEnvironmentInfo &  )

private

Copy constructor.

Member Function Documentation

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

static

Get an instance of the DtEnvironmentInfo object.

Parameters

de	The 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 Vector4_32 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 float makVrv::DtEnvironmentInfo::heightFogDistance ( ) const

virtual

Returns the height fog distance.

virtual Vector4_32 makVrv::DtEnvironmentInfo::heightFogColor ( ) const

virtual

Returns the height fog color.

virtual void makVrv::DtEnvironmentInfo::setFogColor ( const Vector4_32 &  color )

virtual

Sets the distance fog color.

Parameters

color

The fog color.

virtual void makVrv::DtEnvironmentInfo::setFogDensity ( float  density )

virtual

Sets the distance fog density.

Parameters

density

The fog density value.

virtual void makVrv::DtEnvironmentInfo::setHeightFogEnable ( bool  enable )

virtual

Sets the height fog enable state.

Parameters

enable

Set to true to enable the height fog.

virtual void makVrv::DtEnvironmentInfo::setHeightFogAltitude ( float  altitude )

virtual

Sets the height fog altitude.

Parameters

altitude

The altitude (above sea level) to use.

virtual void makVrv::DtEnvironmentInfo::setHeightFogDensity ( float  density )

virtual

Sets the height fog density.

Parameters

density

The density to use for exp() falloff.

virtual void makVrv::DtEnvironmentInfo::setHeightFogDistance ( float  distance )

virtual

Sets the height fog distance. This is the maximum distance that the view would look through the fog.

Parameters

density

The distance.

virtual void makVrv::DtEnvironmentInfo::setHeightFogColor ( const Vector4_32 &  color )

virtual

Sets the height fog color.

Parameters

color

The base color used for height fog.

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

virtual

Sets the sky light position.

Parameters

pos	The light position.

virtual void makVrv::DtEnvironmentInfo::setAmbientColor ( const osg::Vec4 &  color )

virtual

Sets the sky light ambient color.

Parameters

color

The ambient color.

virtual void makVrv::DtEnvironmentInfo::setDiffuseColor ( const osg::Vec4 &  color )

virtual

Sets the sky light diffuse color.

Parameters

color

The diffuse color.

DtEnvironmentInfo& makVrv::DtEnvironmentInfo::operator= ( const DtEnvironmentInfo &  )

private

Assignment Operator.

Member Data Documentation

osg::Vec3 makVrv::DtEnvironmentInfo::myLightPosition

protected

osg::Vec4 makVrv::DtEnvironmentInfo::myAmbientColor

protected

osg::Vec4 makVrv::DtEnvironmentInfo::myDiffuseColor

protected

float makVrv::DtEnvironmentInfo::myFogDensity

protected

bool makVrv::DtEnvironmentInfo::myHeightFogEnable

protected

float makVrv::DtEnvironmentInfo::myHeightFogAltitude

protected

float makVrv::DtEnvironmentInfo::myHeightFogDensity

protected

float makVrv::DtEnvironmentInfo::myHeightFogDistance

protected

Vector4_32 makVrv::DtEnvironmentInfo::myHeightFogColor

protected

Vector4_32 makVrv::DtEnvironmentInfo::myFogColor

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvOsg/DtEnvironmentInfo.h