A DtSceneEnvironmentalsControllerObject is a distributable object that moves environment data from the weather processor, which runs in the network thread, to the scene's global environment, which runs in the main (render) thread, using the environment settings manager.

See Also: DtWeatherProcessor; DtEnvironment

Public Member Functions
	DtSceneEnvironmentalsControllerObject (DtDe &de, DtUniqueID id)

virtual	~DtSceneEnvironmentalsControllerObject ()

virtual void	setAirTurbidity (float turbidity)

virtual void	setAmbientAirTemperature (float temperature)

virtual void	setAmbientAirPressure (float pressure)

virtual void	setAirTemperatureAltitude (float altitude)

virtual void	setAirPressureAltitude (float altitude)

virtual void	setAirTemperatureAltitudeIsSeaLevel (bool seaLevel)

virtual void	setAirPressureAltitudeIsSeaLevel (bool seaLevel)

virtual void	setSeaLevelWaterConcentration (float water)

virtual void	setLightningPresent (bool lightningPresent)

virtual void	setPrecipitationType (unsigned int type)

virtual void	setPrecipitationIntensity (float intensity)

virtual void	setTimeOfDay (int hour, int minutes, double seconds)

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

virtual void	setUseGlobalTimeZone (bool)

virtual void	setTimeOfDayAdvancementSpeed (float speed)

virtual void	setFogHeight (float value)

virtual void	setFogColor (const DtVector &color)

virtual void	setFogColor (float red, float green, float blue)

virtual void	setFogColor (int red, int green, int blue)

virtual void	removeElevationalConfiguration (float baseMSLAltitude)

virtual void	updateOrAddElevationalConfiguration (float baseMSLAltitude, float windSpeed, float windDirection, float visibilityDistance, unsigned int obscurant, int cloudType, float cloudDensity, float skyCoverage)

virtual void	setSwellState (DtDouglasSwellState::Scale state)

virtual void	setSwellStateDirection (float value)

virtual void	setSeaState (DtDouglasSeaState::Scale state)

virtual void	setSeaStateDirection (float value)

virtual void	setWindDrivenSeaStateEnabled (bool value)

virtual void	setWindFetch (float value)

virtual void	setSeaChoppiness (float value)

virtual void	setUnderwaterVisibility (float distance)

virtual void	setSurfaceTransparency (float value)

virtual void	setSurgeDepth (float value)

virtual void	setAmbientWaterTemperature (float temperature)

virtual void	setWaterCurrentSpeed (float speed)

virtual void	setWaterCurrentDirection (float direction)

virtual void	setTidalOffset (float meters)

virtual void	setTidalDirection (bool inOut)

virtual void	setThermoclineDepth (unsigned int layer, float value)

virtual void	setThermoclinePermeability (unsigned int layer, float value)

virtual void	setGroundSnowAccumulation (float depth)

virtual void	setRoadSnowAccumulation (float depth)

virtual void	setSnowMinimumElevation (float elevation)

virtual void	setSnowElevationTransition (float elevation)

virtual void	setGroundRainAccumulation (float depth)

virtual void	remoteGlobalEnvironmentDiscovered ()

Protected Attributes
DtDe &	myDe

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtSceneEnvironmentalsControllerObject::~DtSceneEnvironmentalsControllerObject ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Set the air turbidity/haziness.

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

virtual

Set the ambient air temperature, in Kelvins.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setAmbientAirPressure ( float pressure )

virtual

Set the ambient air pressure, in Pascals.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setAirTemperatureAltitude ( float altitude )

virtual

Set the air temperature altitude, in meters.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setAirPressureAltitude ( float altitude )

virtual

Set the air pressure altitude, in meters.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setAirTemperatureAltitudeIsSeaLevel ( bool seaLevel )

virtual

Set the air temperature altitude is sea level flag.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setAirPressureAltitudeIsSeaLevel ( bool seaLevel )

virtual

Set the air pressure altitude is sea level flag.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setSeaLevelWaterConcentration ( float water )

virtual

Set the sea level water concentration, in PPMV (parts per million by volume).

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setLightningPresent ( bool lightningPresent )

virtual

Sets whether or not lightning is present.

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

virtual

Sets precipitation type.

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

virtual

Sets precipitation intensity.

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

virtual

Tell the scene to change the time of day.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::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::DtSceneEnvironmentalsControllerObject::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. This will set the value in the environment settings manager.

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

virtual

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

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

virtual

Sets the fog ceiling height.

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

virtual

Sets the fog color.

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

virtual

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

virtual

virtual void makVrv::DtSceneEnvironmentalsControllerObject::removeElevationalConfiguration ( float baseMSLAltitude )

virtual

Removes an elevational configuration record by its base MSL altitude, in meters.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::updateOrAddElevationalConfiguration	(	float	baseMSLAltitude,
		float	windSpeed,
		float	windDirection,
		float	visibilityDistance,
		unsigned int	obscurant,
		int	cloudType,
		float	cloudDensity,
		float	skyCoverage
	)

virtual

Update an elevational configuration record which consists of 1) a base MSL altitude, in meters, 2) a wind speed, in meters per second, 3) a wind direction, in radians from True North (clockwise), 4) a visibility distance, in meters, 5) an enumerated visibility obscurant value, 6) the type of cloud present, by name, and 7) the sky coverage of the cloud, in normalized Oktas [0-1]. If the elevational configuration record doesn't exist, add a new one with the passed in attributes.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setSwellState ( DtDouglasSwellState::Scale state )

virtual

Set / get the sea swell conditions based on the Douglas sea scale. (http://en.wikipedia.org/wiki/Douglas_Sea_Scale)

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

virtual

Set the direction, in radians from True North, of sea swells.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setSeaState ( DtDouglasSeaState::Scale state )

virtual

Set / get the sea state conditions based on the Douglas sea scale. (http://en.wikipedia.org/wiki/Douglas_Sea_Scale)

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

virtual

Set the sea state direction, in radians from True North.

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

virtual

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

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

virtual

Set the ocean wind fetch.

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

virtual

Set the sea choppiness.

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

virtual

Set the maximum visibility under water in meters.

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

virtual

Set the surface transparency.

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

virtual

Set the surge depth.

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

virtual

Set the ambient water temperature, in Kelvins.

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

virtual

Set the speed of water currents in meters per second.

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

virtual

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

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

virtual

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

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

virtual

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

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

virtual

Set a thermocline depth.

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

virtual

Set a thermocline permeability.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setGroundSnowAccumulation ( float depth )

virtual

Set the ground snow accumulation percentage.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setRoadSnowAccumulation ( float depth )

virtual

Set the road snow accumulation percentage.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setSnowMinimumElevation ( float elevation )

virtual

Set the snow minimum elevation.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setSnowElevationTransition ( float elevation )

virtual

Set the snow elevation transition which specifies how long it takes to go from no snow to the full snow depth.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setGroundRainAccumulation ( float depth )

virtual

Set the ground snow accumulation percentage.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::remoteGlobalEnvironmentDiscovered ( )

virtual

Let DtEnviromentSettingsManager know that we have connected to a simulation with global weather being sent on it. This is needed to get the local environment cleaned out.

Member Data Documentation

DtDe& makVrv::DtSceneEnvironmentalsControllerObject::myDe

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtSceneEnvironmentalsControllerObject.h

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation