DtEnvironmentalStateSetter Class Reference

Abstract base class for classes that set new environmental state to the environmental state simulator. More...

Inheritance diagram for DtEnvironmentalStateSetter:

Public Member Functions
	DtEnvironmentalStateSetter (DtEnvironmentalStateManager *manager)
virtual	~DtEnvironmentalStateSetter ()
virtual bool	init ()
virtual void	setGlobalEnvironmentObject (DtVrfObject *vrfObject)
virtual void	setAirTurbidity (double value)=0
virtual void	setAmbientAirTemperature (double value)=0
virtual void	setCloudState (DtVrfWeatherCloudState value)=0
virtual void	setPrecipitationIntensity (double value)=0
virtual void	setPrecipitationType (DtVrfWeatherPrecipitationType current)=0
virtual void	setWindSpeed (double value)=0
virtual void	setWindDirection (double value)=0
virtual void	setVisibility (double value)=0
virtual void	setDateAndTimeOfDay (double secondsPastUTC)=0
virtual void	setTimeOfDayAdvancementSpeed (double speed)=0
virtual void	setUnderwaterVisibility (double underwaterVisibility)=0
virtual void	setSurfaceTransparency (double transparency)=0
virtual void	setWaterCurrentSpeed (double waterCurrentSpeed)=0
virtual void	setWaterCurrentDirection (double waterCurrentDirection)=0
virtual void	setAmbientWaterTemperature (double waterTemperature)=0
virtual void	setTidalOffset (double tidalOffset)=0
virtual void	setTidalDirection (bool tidalDirection)=0
virtual void	setSwellState (unsigned int state)=0
virtual void	setSwellStateDirection (double direction)=0
virtual void	setSeaState (unsigned int state)=0
virtual void	setSeaStateDirection (double direction)=0
virtual void	setWindDrivenSeaStateEnabled (bool b)=0
virtual void	setChoppiness (double choppiness)=0
virtual void	setSurgeDepth (double depth)=0
virtual void	setFogHeight (double depth)=0
virtual void	setFogColor (const DtVector &color)=0
virtual void	setThermoclineLayer1Depth (double depth)=0
virtual void	setThermoclineLayer1Permeability (double depth)=0
virtual void	setThermoclineLayer2Depth (double depth)=0
virtual void	setThermoclineLayer2Permeability (double depth)=0
virtual void	setThermoclineLayer3Depth (double depth)=0
virtual void	setThermoclineLayer3Permeability (double depth)=0
virtual void	setThermoclineLayer4Depth (double depth)=0
virtual void	setThermoclineLayer4Permeability (double depth)=0
virtual void	setThermoclineLayer5Depth (double depth)=0
virtual void	setThermoclineLayer5Permeability (double depth)=0
virtual void	setUseDayNightIlluminationModel (bool)=0

Protected Attributes
DtEnvironmentalStateManager *	myEnvironmentalStateManager
DtVrfObject *	myGlobalEnvironmentObject

Private Member Functions
	DtEnvironmentalStateSetter ()
	Not implemented.
	DtEnvironmentalStateSetter (const DtEnvironmentalStateSetter &orig)
DtEnvironmentalStateSetter &	operator== (const DtEnvironmentalStateSetter &orig)

Detailed Description

Abstract base class for classes that set new environmental state to the environmental state simulator.

The purpose of this class is to abstract the concept of the environment being simulated locally or remotely. This is only used for global weather. Local weather information should be set via the objects vrfState

Constructor & Destructor Documentation

DtEnvironmentalStateSetter::DtEnvironmentalStateSetter ( )

private

Not implemented.

DtEnvironmentalStateSetter::DtEnvironmentalStateSetter ( const DtEnvironmentalStateSetter &  orig )

private

DtEnvironmentalStateSetter::DtEnvironmentalStateSetter

(

DtEnvironmentalStateManager *

manager

)

virtual DtEnvironmentalStateSetter::~DtEnvironmentalStateSetter ( )

virtual

Member Function Documentation

DtEnvironmentalStateSetter& DtEnvironmentalStateSetter::operator== ( const DtEnvironmentalStateSetter &  orig )

private

virtual bool DtEnvironmentalStateSetter::init ( )

virtual

Reimplemented in DtRemoteEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setGlobalEnvironmentObject ( DtVrfObject *  vrfObject )

virtual

virtual void DtEnvironmentalStateSetter::setAirTurbidity ( double  value )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setAmbientAirTemperature ( double  value )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setCloudState ( DtVrfWeatherCloudState  value )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setPrecipitationIntensity ( double  value )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setPrecipitationType ( DtVrfWeatherPrecipitationType  current )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setWindSpeed ( double  value )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setWindDirection ( double  value )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setVisibility ( double  value )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setDateAndTimeOfDay ( double  secondsPastUTC )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setTimeOfDayAdvancementSpeed ( double  speed )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setUnderwaterVisibility ( double  underwaterVisibility )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setSurfaceTransparency ( double  transparency )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setWaterCurrentSpeed ( double  waterCurrentSpeed )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setWaterCurrentDirection ( double  waterCurrentDirection )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setAmbientWaterTemperature ( double  waterTemperature )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setTidalOffset ( double  tidalOffset )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setTidalDirection ( bool  tidalDirection )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setSwellState ( unsigned int  state )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setSwellStateDirection ( double  direction )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setSeaState ( unsigned int  state )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setSeaStateDirection ( double  direction )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setWindDrivenSeaStateEnabled ( bool  b )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setChoppiness ( double  choppiness )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setSurgeDepth ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setFogHeight ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setFogColor ( const DtVector &  color )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer1Depth ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer1Permeability ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer2Depth ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer2Permeability ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer3Depth ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer3Permeability ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer4Depth ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer4Permeability ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer5Depth ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setThermoclineLayer5Permeability ( double  depth )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

virtual void DtEnvironmentalStateSetter::setUseDayNightIlluminationModel ( bool  )

pure virtual

Implemented in DtRemoteEnvironmentalStateSetter, and DtLocalEnvironmentalStateSetter.

Member Data Documentation

DtEnvironmentalStateManager* DtEnvironmentalStateSetter::myEnvironmentalStateManager

protected

DtVrfObject* DtEnvironmentalStateSetter::myGlobalEnvironmentObject

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/environmentalStateSetter.h