makVrv::DtEnvironmentSettingsManager Class Reference

A DtEnvironmentSettingsManager tells the DtSimData about new simulation objects and events. More...

Inheritance diagram for makVrv::DtEnvironmentSettingsManager:

Public Member Functions
virtual	~DtEnvironmentSettingsManager ()
	DTOR.
Setting Setters
virtual void	setAirTurbidity (float turbidity)
	Set the air turbidity/haziness (if listening to weather controls).
virtual void	setAmbientAirTemperature (float temperature)
	Set the ambient air temperature (if listening to weather controls).
virtual void	setCloudState (DtVrfWeatherCloudState value)
	Sets the preset cloud state (if listening to weather controls).
virtual void	setPrecipitationType (unsigned int type)
	Sets precipitation type (if listening to weather controls).
virtual void	setPrecipitationIntensity (float intensity)
	Sets precipitation intensity (if listening to weather controls).
virtual void	setDateAndTimeOfDay (int year, int month, int day, int hour, int minutes, double seconds)
	Tell the scene to change the date and time of day.
virtual void	setUseGlobalTimeZone (bool)
	Tell the system to use GMT time as the means to position the sun/moon rather than always moving with the observer.
virtual void	setTimeOfDay (int hour, int minutes, double seconds)
	Tell the scene to change the time of day.
virtual void	setTimeOfDayAdvancementSpeed (float speed)
	Tell the scene to change the time of day advancement speed.
virtual void	setVisibilityDistance (float value)
	Sets the visibility distance (if listening to weather controls).
virtual void	setFogHeight (float value)
	Sets the fog ceiling height (if listening to weather controls).
virtual void	setFogColor (const DtVector &color)
	Sets the fog color (if listening to weather controls).
virtual void	setFogColor (float red, float green, float blue)
	Set the air turbidity/haziness (if listening to weather controls).
virtual void	setFogColor (int red, int green, int blue)
	Set the air turbidity/haziness (if listening to weather controls).
virtual void	setWindDirection (float value)
	Sets the wind direction (if listening to weather controls).
virtual void	setWindSpeed (float value)
	Sets the wind speed (if listening to weather controls).
virtual void	setSwellState (int state)
	Set the sea state according to the Beaufort Scale.
virtual void	setSwellStateDirection (float value)
	Set the sea state direction in radians from North.
virtual void	setSeaState (int state)
	Set the sea state according to the Beaufort Scale.
virtual void	setSeaStateDirection (float value)
	Set the sea state direction in radians from North.
virtual void	setWindDrivenSeaStateEnabled (bool value)
	Set the wind driven seas enabled parameter to allow the wind to determine the sea state.
virtual void	setWindFetch (float value)
	Set the ocean wind fetch (if listening to weather controls).
virtual void	setSeaChoppiness (float value)
	Set the sea choppiness (if listening to weather controls).
virtual void	setUnderwaterVisibility (float distance)
	Set the maximum visibility under water in meters.
virtual void	setSurfaceTransparency (float value)
	Set the surface transparency (if listening to weather controls).
virtual void	setSurgeDepth (float value)
	Set the surge depth (if listening to weather controls).
virtual void	setAmbientWaterTemperature (float temperature)
	Set the ambient water temperature in Celsius.
virtual void	setWaterCurrentSpeed (float speed)
	Set the speed of water currents in meters per second.
virtual void	setWaterCurrentDirection (float direction)
	Set the direction of water currents in radians from north (clockwise).
virtual void	setTidalOffset (float meters)
	Set the current tidal offset from mean-sea-level in meters.
virtual void	setTidalDirection (bool inOut)
	Set the current direction of tidal flow (0=out, 1=in).
virtual void	setThermoclineDepth (unsigned int layer, float value)
	Set a thermocline depth (if listening to weather controls).
virtual void	setThermoclinePermeability (unsigned int layer, float value)
	Set a thermocline permeability (if listening to weather controls).
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtEnvironmentSettingsManager &	instance (DtDe &de)
	Get an instance of the settings manager.

Public Attributes
Setting Change Signals
boost::signal< void(float)>	signal_airTurbidityChanged
	Emitted when the air turbidity factor changes.
boost::signal< void(float)>	signal_ambientAirTemperatureChanged
	Emitted when the ambient air temperature factor changes.
boost::signal< void(DtVrfWeatherCloudState)>	signal_cloudStateChanged
	Emitted when the cloud state factor changes.
boost::signal< void(bool)>	signal_precipipationEnabled
	Emitted when the precipitation is enabled/disabled.
boost::signal< void(float)>	signal_precitipationIntensityChanged
	Emitted when the precipitation intensity factor changes.
boost::signal< void(unsigned int)>	signal_precipitationTypeChanged
	Emitted when the precipitation type changes.
boost::signal< void(int, int, int)>	signal_timeOfDayChanged
	Emitted when the time of day changes.
boost::signal< void(int, int, int, int, int, int)>	signal_dateAndTimeOfDayChanged
	Emitted when the date and time of day changes.
boost::signal< void(bool)>	signal_useGlobalTimeZoneChanged
	Emitted when positioning with the sun with GMT time changes.
boost::signal< void(float)>	signal_timeOfDayAdvancementSpeedChanged
	Emitted when the time of day advancement speed changes.
boost::signal< void(float)>	signal_visibilityChanged
	Emitted when the visibility factor changes.
boost::signal< void(float)>	signal_fogHeightChanged
	Emitted when the fog ceiling height changes.
boost::signal< void(const DtVector &)>	signal_fogColorChanged
	Emitted when the fog color changes.
boost::signal< void(float)>	signal_windDirectionChanged
	Emitted when the wind direction changes.
boost::signal< void(float)>	signal_windSpeedChanged
	Emitted when the wind speed changes.
boost::signal< void(int)>	signal_swellStateChanged
	Emitted when the swell state changes.
boost::signal< void(int)>	signal_swellStateDirectionChanged
	Emitted when the swell state direction changes.
boost::signal< void(int)>	signal_seaStateChanged
	Emitted when the sea state changes.
boost::signal< void(int)>	signal_seaStateDirectionChanged
	Emitted when the sea state direction changes.
boost::signal< void(int)>	signal_windDrivenSeaStateEnabledChanged
	Emitted when the wind driven seas state enabled changes.
boost::signal< void(float)>	signal_windFetchChanged
	Emitted when the ocean wind fetch changes.
boost::signal< void(float)>	signal_seaChoppinessChanged
	Emitted when the sea choppiness changes.
boost::signal< void(float)>	signal_underWaterVisibilityChanged
	Emitted when the underwater visibility changes.
boost::signal< void(float)>	signal_surfaceTransparencyChanged
	Emitted when the surface transparency changes.
boost::signal< void(float)>	signal_surgeDepthChanged
	Emitted when the surge depth changes.
boost::signal< void(float)>	signal_ambientWaterTemperatureChanged
	Emitted when the ambient water temperature changes.
boost::signal< void(float)>	signal_waterCurrentSpeedChanged
	Emitted when the water current speed changes.
boost::signal< void(float)>	signal_waterCurrentDirectionChanged
	Emitted when the water current direction changes.
boost::signal< void(float)>	signal_tidalOffsetChanged
	Emitted when the tidal offset changes.
boost::signal< void(bool)>	signal_tidalDirectionChanged
	Emitted when the tidal direction changes.
boost::signal< void(unsigned int, float)>	signal_thermoclineDepthChanged
	Emitted when the thermocline depth changes.
boost::signal< void(unsigned int, float)>	signal_thermoclinePermeabilityChanged
	Emitted when the thermocline permeability changes.

Protected Member Functions
	DtEnvironmentSettingsManager (DtDe &de)
	CTOR.

Protected Attributes
DtDistributedEnvironmentSettingsManager &	myDistEnvSettingsManager
DtDe &	myDe

Detailed Description

A DtEnvironmentSettingsManager tells the DtSimData about new simulation objects and events.

Constructor & Destructor Documentation

virtual makVrv::DtEnvironmentSettingsManager::~DtEnvironmentSettingsManager ( )

virtual

DTOR.

makVrv::DtEnvironmentSettingsManager::DtEnvironmentSettingsManager ( DtDe &  de )

protected

CTOR.

Member Function Documentation

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

static

Get an instance of the settings manager.

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

virtual

Set the air turbidity/haziness (if listening to weather controls).

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

virtual

Set the ambient air temperature (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setCloudState ( DtVrfWeatherCloudState  value )

virtual

Sets the preset cloud state (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setPrecipitationType ( unsigned int  type )

virtual

Sets precipitation type (if listening to weather controls).

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

virtual

Sets precipitation intensity (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setDateAndTimeOfDay ( int  year, int  month, int  day, int  hour, int  minutes, double  seconds  )

virtual

Tell the scene to change the date and time of day.

virtual void makVrv::DtEnvironmentSettingsManager::setUseGlobalTimeZone ( bool  )

virtual

Tell the system to use GMT time as the means to position the sun/moon rather than always moving with the observer.

virtual void makVrv::DtEnvironmentSettingsManager::setTimeOfDay ( int  hour, int  minutes, double  seconds  )

virtual

Tell the scene to change the time of day.

virtual void makVrv::DtEnvironmentSettingsManager::setTimeOfDayAdvancementSpeed ( float  speed )

virtual

Tell the scene to change the time of day advancement speed.

virtual void makVrv::DtEnvironmentSettingsManager::setVisibilityDistance ( float  value )

virtual

Sets the visibility distance (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setFogHeight ( float  value )

virtual

Sets the fog ceiling height (if listening to weather controls).

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

virtual

Sets the fog color (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setFogColor ( float  red, float  green, float  blue  )

virtual

Set the air turbidity/haziness (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setFogColor ( int  red, int  green, int  blue  )

virtual

Set the air turbidity/haziness (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setWindDirection ( float  value )

virtual

Sets the wind direction (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setWindSpeed ( float  value )

virtual

Sets the wind speed (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setSwellState ( int  state )

virtual

Set the sea state according to the Beaufort Scale.

virtual void makVrv::DtEnvironmentSettingsManager::setSwellStateDirection ( float  value )

virtual

Set the sea state direction in radians from North.

virtual void makVrv::DtEnvironmentSettingsManager::setSeaState ( int  state )

virtual

Set the sea state according to the Beaufort Scale.

virtual void makVrv::DtEnvironmentSettingsManager::setSeaStateDirection ( float  value )

virtual

Set the sea state direction in radians from North.

virtual void makVrv::DtEnvironmentSettingsManager::setWindDrivenSeaStateEnabled ( bool  value )

virtual

Set the wind driven seas enabled parameter to allow the wind to determine the sea state.

virtual void makVrv::DtEnvironmentSettingsManager::setWindFetch ( float  value )

virtual

Set the ocean wind fetch (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setSeaChoppiness ( float  value )

virtual

Set the sea choppiness (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setUnderwaterVisibility ( float  distance )

virtual

Set the maximum visibility under water in meters.

virtual void makVrv::DtEnvironmentSettingsManager::setSurfaceTransparency ( float  value )

virtual

Set the surface transparency (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setSurgeDepth ( float  value )

virtual

Set the surge depth (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setAmbientWaterTemperature ( float  temperature )

virtual

Set the ambient water temperature in Celsius.

virtual void makVrv::DtEnvironmentSettingsManager::setWaterCurrentSpeed ( float  speed )

virtual

Set the speed of water currents in meters per second.

virtual void makVrv::DtEnvironmentSettingsManager::setWaterCurrentDirection ( float  direction )

virtual

Set the direction of water currents in radians from north (clockwise).

virtual void makVrv::DtEnvironmentSettingsManager::setTidalOffset ( float  meters )

virtual

Set the current tidal offset from mean-sea-level in meters.

virtual void makVrv::DtEnvironmentSettingsManager::setTidalDirection ( bool  inOut )

virtual

Set the current direction of tidal flow (0=out, 1=in).

virtual void makVrv::DtEnvironmentSettingsManager::setThermoclineDepth ( unsigned int  layer, float  value  )

virtual

Set a thermocline depth (if listening to weather controls).

virtual void makVrv::DtEnvironmentSettingsManager::setThermoclinePermeability ( unsigned int  layer, float  value  )

virtual

Set a thermocline permeability (if listening to weather controls).

Member Data Documentation

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_airTurbidityChanged

Emitted when the air turbidity factor changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_ambientAirTemperatureChanged

Emitted when the ambient air temperature factor changes.

boost::signal<void (DtVrfWeatherCloudState)> makVrv::DtEnvironmentSettingsManager::signal_cloudStateChanged

Emitted when the cloud state factor changes.

boost::signal<void (bool)> makVrv::DtEnvironmentSettingsManager::signal_precipipationEnabled

Emitted when the precipitation is enabled/disabled.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_precitipationIntensityChanged

Emitted when the precipitation intensity factor changes.

boost::signal<void (unsigned int)> makVrv::DtEnvironmentSettingsManager::signal_precipitationTypeChanged

Emitted when the precipitation type changes.

boost::signal<void (int, int, int)> makVrv::DtEnvironmentSettingsManager::signal_timeOfDayChanged

Emitted when the time of day changes.

boost::signal<void (int, int, int, int, int, int)> makVrv::DtEnvironmentSettingsManager::signal_dateAndTimeOfDayChanged

Emitted when the date and time of day changes.

boost::signal<void (bool)> makVrv::DtEnvironmentSettingsManager::signal_useGlobalTimeZoneChanged

Emitted when positioning with the sun with GMT time changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_timeOfDayAdvancementSpeedChanged

Emitted when the time of day advancement speed changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_visibilityChanged

Emitted when the visibility factor changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_fogHeightChanged

Emitted when the fog ceiling height changes.

boost::signal<void (const DtVector&)> makVrv::DtEnvironmentSettingsManager::signal_fogColorChanged

Emitted when the fog color changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_windDirectionChanged

Emitted when the wind direction changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_windSpeedChanged

Emitted when the wind speed changes.

boost::signal<void (int)> makVrv::DtEnvironmentSettingsManager::signal_swellStateChanged

Emitted when the swell state changes.

boost::signal<void (int)> makVrv::DtEnvironmentSettingsManager::signal_swellStateDirectionChanged

Emitted when the swell state direction changes.

boost::signal<void (int)> makVrv::DtEnvironmentSettingsManager::signal_seaStateChanged

Emitted when the sea state changes.

boost::signal<void (int)> makVrv::DtEnvironmentSettingsManager::signal_seaStateDirectionChanged

Emitted when the sea state direction changes.

boost::signal<void (int)> makVrv::DtEnvironmentSettingsManager::signal_windDrivenSeaStateEnabledChanged

Emitted when the wind driven seas state enabled changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_windFetchChanged

Emitted when the ocean wind fetch changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_seaChoppinessChanged

Emitted when the sea choppiness changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_underWaterVisibilityChanged

Emitted when the underwater visibility changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_surfaceTransparencyChanged

Emitted when the surface transparency changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_surgeDepthChanged

Emitted when the surge depth changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_ambientWaterTemperatureChanged

Emitted when the ambient water temperature changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_waterCurrentSpeedChanged

Emitted when the water current speed changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_waterCurrentDirectionChanged

Emitted when the water current direction changes.

boost::signal<void (float)> makVrv::DtEnvironmentSettingsManager::signal_tidalOffsetChanged

Emitted when the tidal offset changes.

boost::signal<void (bool)> makVrv::DtEnvironmentSettingsManager::signal_tidalDirectionChanged

Emitted when the tidal direction changes.

boost::signal<void (unsigned int, float)> makVrv::DtEnvironmentSettingsManager::signal_thermoclineDepthChanged

Emitted when the thermocline depth changes.

boost::signal<void (unsigned int, float)> makVrv::DtEnvironmentSettingsManager::signal_thermoclinePermeabilityChanged

Emitted when the thermocline permeability changes.

DtDistributedEnvironmentSettingsManager& makVrv::DtEnvironmentSettingsManager::myDistEnvSettingsManager

protected

DtDe& makVrv::DtEnvironmentSettingsManager::myDe

protected

---

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

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