makVrv::DtSkyObject Class Reference

The base sky object.

Inheritance diagram for makVrv::DtSkyObject:

Classes
class	CloudLayer

Public Types
enum	PrecipitationType {   None = 0, Rain = 1, SnowWet = 2, SnowDry = 3,   Sleet = 4, Hail = 5, Drizzle = 6 }

Public Member Functions
	DtSkyObject (DtDe &de, DtUniqueID id)
virtual	~DtSkyObject ()
virtual void	setLocation (const DtVector &location)
virtual void	setDateAndTime (unsigned short year, unsigned char month, unsigned char day, unsigned char hour, unsigned char minutes, double seconds, bool observeDaylightSavings)
virtual void	addCloudLayer (DtCloudLayerId layerId)=0
virtual void	sendCloudLayer (DtCloudLayerId layerId)=0
virtual void	setCloudLayerDeckType (DtCloudLayerId layerId, int deckType)=0
virtual void	setCloudLayerCornerRadius (DtCloudLayerId layerId, float corner)=0
virtual void	setCloudLayerBounds (DtCloudLayerId layerId, const DtVector &bounds)=0
virtual void	setCloudLayerDensity (DtCloudLayerId layerId, double density)=0
virtual void	setCloudLayerInfiniteFlag (DtCloudLayerId layerId, bool infinite)=0
virtual void	setCloudLayerRelativeFlag (DtCloudLayerId layerId, bool relative)=0
virtual void	setCloudLayerFadeAtAltitudeFlag (DtCloudLayerId layerId, bool fadeAtAltitude)=0
virtual void	setCloudLayerAltitudeIsHATFlag (DtCloudLayerId layerId, bool altitudeIsHAT)=0
virtual CloudLayer *	findCloudLayer (DtCloudLayerId layerId)=0
virtual void	setCloudLayerEnabled (DtCloudLayerId layerId, bool enabled)=0
virtual void	removeCloudLayer (DtCloudLayerId layerId)=0
virtual void	removeCloudLayers ()=0
virtual void	setAirTurbidity (float turbidity)=0
virtual void	setAmbientAirTemperature (float temperature)=0
virtual void	setVisibleDistance (float distance)=0
virtual void	setPrecipitationEnabled (bool enabled)=0
virtual void	setPrecipitationType (int type)=0
virtual void	setPrecipitationIntensity (float intensity)=0
virtual void	setCloudLayerPositionAndOrientation (DtCloudLayerId layerId, const DtVector &position, float orientation)=0
virtual void	setFogHeight (float meters)=0
virtual void	setFogColor (const DtVector &color)=0
virtual void	setGroundFogColor (const DtVector &color)=0
virtual void	setWindSpeed (float metersPerSecond)=0
virtual void	setWindDirection (float radians)=0
void	setAmbientLightValue (float ambientLightValue)
float	ambientLightValue () const
bool	isDaylight () const
bool	isSkyCastingShadows () const

Static Public Attributes
static const float	theDefaultDayLightLevel
static const float	theDefaultSkyShadowsLightLevelNoHdr
static const float	theDefaultSkyShadowsLightLevelHdr
static const float	theDefaultFogVisibilityLevel
static const double	theMaximumPrecipitationRate
static const float	theMaximumVisibilityDistance

Protected Attributes
float	myAmbientLightValue
DtSkyObjectSignaler &	mySignaler
DtDe &	myDe

Member Enumeration Documentation

enum makVrv::DtSkyObject::PrecipitationType

Precipitation types.

Enumerator
None
Rain
SnowWet
SnowDry
Sleet
Hail
Drizzle

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 ( DtCloudLayerId  layerId )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::sendCloudLayer ( DtCloudLayerId  layerId )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerDeckType ( DtCloudLayerId  layerId, int  deckType  )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerCornerRadius ( DtCloudLayerId  layerId, float  corner  )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerBounds ( DtCloudLayerId  layerId, const DtVector &  bounds  )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerDensity ( DtCloudLayerId  layerId, double  density  )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerInfiniteFlag ( DtCloudLayerId  layerId, bool  infinite  )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerRelativeFlag ( DtCloudLayerId  layerId, bool  relative  )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerFadeAtAltitudeFlag ( DtCloudLayerId  layerId, bool  fadeAtAltitude  )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerAltitudeIsHATFlag ( DtCloudLayerId  layerId, bool  altitudeIsHAT  )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual CloudLayer* makVrv::DtSkyObject::findCloudLayer ( DtCloudLayerId  layerId )

pure virtual

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerEnabled ( DtCloudLayerId  layerId, bool  enabled  )

pure virtual

Enable/disable a cloud layer.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::removeCloudLayer ( DtCloudLayerId  layerId )

pure virtual

Get the number of cloud decks.

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, 5 = hail

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::setCloudLayerPositionAndOrientation ( DtCloudLayerId  layerId, const DtVector &  position, float  orientation  )

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::setGroundFogColor ( const DtVector &  color )

pure virtual

Set the color of the ground 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

bool makVrv::DtSkyObject::isDaylight

(

)

const

Returns whether or not the light level counts as daylight.

bool makVrv::DtSkyObject::isSkyCastingShadows

(

)

const

Returns whether or not the light level counts as shadow casting, (which could be from sun or moon light sources, but only considers sky based light sources).

Member Data Documentation

const float makVrv::DtSkyObject::theDefaultDayLightLevel

static

Value for daylight visibility.

const float makVrv::DtSkyObject::theDefaultSkyShadowsLightLevelNoHdr

static

Value for shadow visibility without HDR.

const float makVrv::DtSkyObject::theDefaultSkyShadowsLightLevelHdr

static

Value for shadow visibility with HDR.

const float makVrv::DtSkyObject::theDefaultFogVisibilityLevel

static

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

const double makVrv::DtSkyObject::theMaximumPrecipitationRate

static

Maximum precipitation rate in mm/hr. This value will be clamped to the value specified by rain-max-intensity, snow-max-intensity, or sleet-max-intensity in resources/SilverLining.config. The default is 200 mm/hr.

const float makVrv::DtSkyObject::theMaximumVisibilityDistance

static

Maximum Visibility Distance. The default is 20 km.

float makVrv::DtSkyObject::myAmbientLightValue

protected

DtSkyObjectSignaler& makVrv::DtSkyObject::mySignaler

protected

DtDe& makVrv::DtSkyObject::myDe

protected

---

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

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