makVrv::DtSkyObject Class Reference

The base sky object. More...

Inheritance diagram for makVrv::DtSkyObject:

Public Types
enum	PrecipitationType {   None = 0, Rain = 1, SnowWet = 2, SnowDry = 3,   Sleet = 4 }
	Precipitation types. More...

Public Member Functions
	DtSkyObject (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtSkyObject ()
	DTOR.
virtual void	setLocation (const DtVector &location)
	Set the initial sky location.
virtual void	setDateAndTime (unsigned short year, unsigned char month, unsigned char day, unsigned char hour, unsigned char minutes, double seconds, bool observeDaylightSavings)
	Set the date and time to show the sky.
virtual void	addCloudLayer (int deckType, const DtVector &location, const DtVector &bounds, double density, bool infinite, bool relative)
	Add new cloud deck.
virtual void	setCloudLayerEnabled (int index, bool enabled)=0
	Enable/disable a cloud layer.
virtual int	cloudLayerCount () const
	Get the number of cloud decks.
virtual void	removeCloudLayer (int index)=0
	Remove a cloud deck.
virtual void	removeCloudLayers ()=0
	Remove all the cloud decks.
virtual void	setAirTurbidity (float turbidity)=0
	Set the air turbidity (haziness)
virtual void	setAmbientAirTemperature (float temperature)=0
	Set the visible distance.
virtual void	setVisibleDistance (float distance)=0
	Set the visible distance.
virtual void	setPrecipitationEnabled (bool enabled)=0
	Set whether precipitation is enabled.
virtual void	setPrecipitationType (int type)=0
	Set the precipitation type.
virtual void	setPrecipitationIntensity (float intensity)=0
	Set the precipitation intensity.
virtual void	setCloudLayerPosition (int index, double xCoord, double yCoord)=0
	Move a cloud layer to a new position.
virtual void	setFogHeight (float meters)=0
	Set the ceiling height of the fog layer.
virtual void	setFogColor (const DtVector &color)=0
	Set the color of the fog layer.
virtual void	setWindSpeed (float metersPerSecond)=0
	Set the wind speed in meters per second.
virtual void	setWindDirection (float radians)=0
	Set the wind direction blowing from in radians from north.
void	setAmbientLightValue (float ambientLightValue)
	This is set by the SilverLining group; it can be accessed only by getting the skyObject through the skyObjectAgent.
float	ambientLightValue () const
void	setIsDay (bool isDay)
	This is set by the SilverLining group; it can be accessed only by getting the skyObject through the skyObjectAgent.
bool	isDay () const

Static Public Attributes
static const float	DefaultDayLightLevel
	Value for daylight visibility.
static const float	DefaultFogVisibilityLevel
	Value for fog visibility - standard definition (1000 m.)

Protected Attributes
float	myAmbientLightValue
bool	myIsDay
DtSkyObjectSignaler &	mySignaler

Detailed Description

The base sky object.

Member Enumeration Documentation

enum makVrv::DtSkyObject::PrecipitationType

Precipitation types.

Enumerator:

None
Rain
SnowWet
SnowDry
Sleet

Constructor & Destructor Documentation

makVrv::DtSkyObject::DtSkyObject	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtSkyObject::~DtSkyObject ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtSkyObject::setLocation ( const DtVector &  location )

virtual

Set the initial sky location.

Reimplemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setDateAndTime ( unsigned short  year, unsigned char  month, unsigned char  day, unsigned char  hour, unsigned char  minutes, double  seconds, bool  observeDaylightSavings  )

virtual

Set the date and time to show the sky.

virtual void makVrv::DtSkyObject::addCloudLayer ( int  deckType, const DtVector &  location, const DtVector &  bounds, double  density, bool  infinite, bool  relative  )

virtual

Add new cloud deck.

Reimplemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerEnabled ( int  index, bool  enabled  )

pure virtual

Enable/disable a cloud layer.

Implemented in makVrv::DtOsgSkyObject.

virtual int makVrv::DtSkyObject::cloudLayerCount ( ) const

virtual

Get the number of cloud decks.

Reimplemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::removeCloudLayer ( int  index )

pure virtual

Remove a cloud deck.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::removeCloudLayers ( )

pure virtual

Remove all the cloud decks.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setAirTurbidity ( float  turbidity )

pure virtual

Set the air turbidity (haziness)

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setAmbientAirTemperature ( float  temperature )

pure virtual

Set the visible distance.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setVisibleDistance ( float  distance )

pure virtual

Set the visible distance.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setPrecipitationEnabled ( bool  enabled )

pure virtual

Set whether precipitation is enabled.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setPrecipitationType ( int  type )

pure virtual

Set the precipitation type.

Parameters

input

0 = none, 1 = rain, 2 = wet snow, 3 = dry snow, 4 = sleet

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setPrecipitationIntensity ( float  intensity )

pure virtual

Set the precipitation intensity.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerPosition ( int  index, double  xCoord, double  yCoord  )

pure virtual

Move a cloud layer to a new position.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setFogHeight ( float  meters )

pure virtual

Set the ceiling height of the fog layer.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setFogColor ( const DtVector &  color )

pure virtual

Set the color of the fog layer.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setWindSpeed ( float  metersPerSecond )

pure virtual

Set the wind speed in meters per second.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setWindDirection ( float  radians )

pure virtual

Set the wind direction blowing from in radians from north.

Implemented in makVrv::DtOsgSkyObject.

void makVrv::DtSkyObject::setAmbientLightValue

(

float

ambientLightValue

)

This is set by the SilverLining group; it can be accessed only by getting the skyObject through the skyObjectAgent.

float makVrv::DtSkyObject::ambientLightValue

(

)

const

void makVrv::DtSkyObject::setIsDay

(

bool

isDay

)

This is set by the SilverLining group; it can be accessed only by getting the skyObject through the skyObjectAgent.

bool makVrv::DtSkyObject::isDay

(

)

const

Member Data Documentation

const float makVrv::DtSkyObject::DefaultDayLightLevel

static

Value for daylight visibility.

const float makVrv::DtSkyObject::DefaultFogVisibilityLevel

static

Value for fog visibility - standard definition (1000 m.)

float makVrv::DtSkyObject::myAmbientLightValue

protected

bool makVrv::DtSkyObject::myIsDay

protected

DtSkyObjectSignaler& makVrv::DtSkyObject::mySignaler

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtSkyObject.h