DtEnvironmentalStateManager Class Reference

Handles the environmental state of the simulation. More...

Public Member Functions
	DtEnvironmentalStateManager (DtSimManager *simManager)
	constructor
virtual	~DtEnvironmentalStateManager ()
	destructor
virtual bool	init ()
virtual void	tick ()
virtual DtSimManager *	simManager ()
virtual bool	globalEnvironmentSimulatedLocally () const
virtual bool	startEnvironmentSimulationLocally ()
	Starts simulating the global environment locally on this simulation engine.
virtual void	setGlobalWeather (const DtChangeGlobalWeatherCommand &command)
	Calls the appropriate setXXX() functions locally, depending on what is in the command.
virtual void	setTimeOfDay (double secondsPastMidnight)
	The current time of day, specified by the number of seconds passed midnight.
virtual void	setTimeOfDay (const DtChangeTimeOfDayCommand &command)
virtual double	timeOfDay () const
virtual void	setTimeOfDayAdvancementSpeed (double speed)
	The current time of day advancement speed.
virtual void	setTimeOfDayAdvancementSpeed (const DtChangeTimeOfDayCommand &command)
virtual double	timeOfDayAdvancementSpeed () const
virtual void	setAirTurbidity (double factor)
	Individual Environmental effects accessors Air Turbidity.
virtual double	airTurbidity () const
	Individual Environmental effects accessors Air Turbidity.
virtual void	setCloudState (DtVrfWeatherCloudState current)
	Cloud state enumeration.
virtual DtVrfWeatherCloudState	cloudState () const
	Cloud state enumeration.
virtual void	setPrecipitationIntensity (double factor)
	Precipitation Intensity.
virtual double	precipitationIntensity () const
	Precipitation Intensity.
virtual void	setPrecipitationType (DtVrfWeatherPrecipitationType current)
	Weather state enumeration.
virtual DtVrfWeatherPrecipitationType	precipitationType () const
	Weather state enumeration.
virtual void	setWindSpeed (double value)
	Wind speed in m/s.
virtual double	windSpeed () const
	Wind speed in m/s.
virtual void	setWindDirection (double value)
	Wind direction in radians.
virtual double	windDirection () const
	Wind direction in radians.
virtual void	setVisibility (double value)
	Visibility in meters.
virtual double	visibility () const
	Visibility in meters.
virtual double	illumination (const DtVector &localPosition) const
	Illumination in percentage (0 to 1.0) at a particular location.

Protected Member Functions
virtual void	processObjectAdded (DtVrfObject *object)
virtual void	processObjectRemoved (DtVrfObject *object)
virtual void	createGlobalEnvironmentObject ()
	Creates a new locally simulated VRF object with the type returned from glovalEnvironmentObjectType().
virtual DtObjectType	globalEnvironmentObjectType () const
virtual DtEnvironmentalStateSetter *	createLocalEnvironmentalStateSetter ()
virtual DtEnvironmentalStateSetter *	createRemoteEnvironmentalStateSetter ()

Static Protected Member Functions
static void	objectAddedCallback (DtVrfObject *object, void *usr)
static void	objectRemovedCallback (DtVrfObject *object, void *usr)

Protected Attributes
DtSimManager *	mySimManager
DtVrfObject *	myGlobalEnvironmentObject
DtEnvironmentalStateSetter *	myEnvironmentalStateSetter
bool	myFirstTick

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

Detailed Description

Handles the environmental state of the simulation.

Currently there is only one environmental state for the whole simulation. This manager provides access to the environmental state and is responsible for updating the environmental state from the network.

Constructor & Destructor Documentation

DtEnvironmentalStateManager::DtEnvironmentalStateManager ( const DtEnvironmentalStateManager &  orig )

private

Not implemented.

DtEnvironmentalStateManager::DtEnvironmentalStateManager ( )

private

Not implemented.

DtEnvironmentalStateManager::DtEnvironmentalStateManager

(

DtSimManager *

simManager

)

constructor

virtual DtEnvironmentalStateManager::~DtEnvironmentalStateManager ( )

virtual

destructor

Member Function Documentation

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

private

Not implemented.

virtual bool DtEnvironmentalStateManager::init ( )

virtual

virtual void DtEnvironmentalStateManager::tick ( )

virtual

virtual DtSimManager* DtEnvironmentalStateManager::simManager ( )

virtual

virtual bool DtEnvironmentalStateManager::globalEnvironmentSimulatedLocally ( ) const

virtual

Returns

True if the global environment is currently being simulated by this simulation engine.

virtual bool DtEnvironmentalStateManager::startEnvironmentSimulationLocally ( )

virtual

Starts simulating the global environment locally on this simulation engine.

Only starts the local simulation if there is not one (remote or local) already running.

Returns

True if successful.

virtual void DtEnvironmentalStateManager::setAirTurbidity ( double  factor )

virtual

Individual Environmental effects accessors Air Turbidity.

virtual double DtEnvironmentalStateManager::airTurbidity ( ) const

virtual

Individual Environmental effects accessors Air Turbidity.

virtual void DtEnvironmentalStateManager::setCloudState ( DtVrfWeatherCloudState  current )

virtual

Cloud state enumeration.

virtual DtVrfWeatherCloudState DtEnvironmentalStateManager::cloudState ( ) const

virtual

Cloud state enumeration.

virtual void DtEnvironmentalStateManager::setPrecipitationIntensity ( double  factor )

virtual

Precipitation Intensity.

virtual double DtEnvironmentalStateManager::precipitationIntensity ( ) const

virtual

Precipitation Intensity.

virtual void DtEnvironmentalStateManager::setPrecipitationType ( DtVrfWeatherPrecipitationType  current )

virtual

Weather state enumeration.

virtual DtVrfWeatherPrecipitationType DtEnvironmentalStateManager::precipitationType ( ) const

virtual

Weather state enumeration.

virtual void DtEnvironmentalStateManager::setWindSpeed ( double  value )

virtual

Wind speed in m/s.

virtual double DtEnvironmentalStateManager::windSpeed ( ) const

virtual

Wind speed in m/s.

virtual void DtEnvironmentalStateManager::setWindDirection ( double  value )

virtual

Wind direction in radians.

virtual double DtEnvironmentalStateManager::windDirection ( ) const

virtual

Wind direction in radians.

virtual void DtEnvironmentalStateManager::setVisibility ( double  value )

virtual

Visibility in meters.

virtual double DtEnvironmentalStateManager::visibility ( ) const

virtual

Visibility in meters.

virtual double DtEnvironmentalStateManager::illumination ( const DtVector &  localPosition ) const

virtual

Illumination in percentage (0 to 1.0) at a particular location.

Illumination cannot be set directly. It is a function of time of day.

Note

Currently, the location is ignored, and the illumination is the same over the entire simulation.

virtual void DtEnvironmentalStateManager::setGlobalWeather ( const DtChangeGlobalWeatherCommand &  command )

virtual

Calls the appropriate setXXX() functions locally, depending on what is in the command.

virtual void DtEnvironmentalStateManager::setTimeOfDay ( double  secondsPastMidnight )

virtual

The current time of day, specified by the number of seconds passed midnight.

virtual void DtEnvironmentalStateManager::setTimeOfDay ( const DtChangeTimeOfDayCommand &  command )

virtual

virtual double DtEnvironmentalStateManager::timeOfDay ( ) const

virtual

virtual void DtEnvironmentalStateManager::setTimeOfDayAdvancementSpeed ( double  speed )

virtual

The current time of day advancement speed.

virtual void DtEnvironmentalStateManager::setTimeOfDayAdvancementSpeed ( const DtChangeTimeOfDayCommand &  command )

virtual

virtual double DtEnvironmentalStateManager::timeOfDayAdvancementSpeed ( ) const

virtual

static void DtEnvironmentalStateManager::objectAddedCallback ( DtVrfObject *  object, void *  usr  )

staticprotected

virtual void DtEnvironmentalStateManager::processObjectAdded ( DtVrfObject *  object )

protectedvirtual

static void DtEnvironmentalStateManager::objectRemovedCallback ( DtVrfObject *  object, void *  usr  )

staticprotected

virtual void DtEnvironmentalStateManager::processObjectRemoved ( DtVrfObject *  object )

protectedvirtual

virtual void DtEnvironmentalStateManager::createGlobalEnvironmentObject ( )

protectedvirtual

Creates a new locally simulated VRF object with the type returned from glovalEnvironmentObjectType().

Sets this new object to myGlovalEnvironmentObject, and sets up myEnvironmentalStateSetter.

virtual DtObjectType DtEnvironmentalStateManager::globalEnvironmentObjectType ( ) const

protectedvirtual

Returns

The object type that will be used for the global environment object. Returns 1:21:0:0:1:0:0:0

virtual DtEnvironmentalStateSetter* DtEnvironmentalStateManager::createLocalEnvironmentalStateSetter ( )

protectedvirtual

Returns

A new instance of DtLocalEnvironmentalStateSetter().

virtual DtEnvironmentalStateSetter* DtEnvironmentalStateManager::createRemoteEnvironmentalStateSetter ( )

protectedvirtual

Returns

A new instance of DtRemoteEnvironmentalStateSetter().

Member Data Documentation

DtSimManager* DtEnvironmentalStateManager::mySimManager

protected

DtVrfObject* DtEnvironmentalStateManager::myGlobalEnvironmentObject

protected

DtEnvironmentalStateSetter* DtEnvironmentalStateManager::myEnvironmentalStateSetter

protected

bool DtEnvironmentalStateManager::myFirstTick

protected

---

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

• include/vrfobjcore/environmentalStateManager.h