VR-Forces 4.6 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
makVrv::DtSceneEnvironmentalsControllerObject Class Reference

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

Public Member Functions

 DtSceneEnvironmentalsControllerObject (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtSceneEnvironmentalsControllerObject ()
 DTOR.
virtual void setAirTurbidity (float turbidity)
 Set the air turbidity/haziness.
virtual void setAmbientAirTemperature (float temperature)
 Set the ambient air temperature.
virtual void setCloudState (unsigned int value)
 Sets the preset cloud state.
virtual void setPrecipitationType (unsigned int type)
 Sets precipitation type.
virtual void setPrecipitationIntensity (float intensity)
 Sets precipitation intensity.
virtual void setTimeOfDay (int hour, int minutes, double seconds)
 Tell the scene to change the time of day.
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 setTimeOfDayAdvancementSpeed (float speed)
 Tell the scene to change the time of day advancement speed.
virtual void setVisibilityDistance (float value)
 Sets the visibility distance.
virtual void setFogHeight (float value)
 Sets the fog ceiling height.
virtual void setFogColor (const DtVector &color)
 Sets the fog color.
virtual void setFogColor (float red, float green, float blue)
virtual void setFogColor (int red, int green, int blue)
virtual void setWindDirection (float value)
 Sets the wind direction.
virtual void setWindSpeed (float value)
 Sets the wind speed.
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.
virtual void setSeaChoppiness (float value)
 Set the sea choppiness.
virtual void setUnderwaterVisibility (float distance)
 Set the maximum visibility under water in meters.
virtual void setSurfaceTransparency (float value)
 Set the surface transparency.
virtual void setSurgeDepth (float value)
 Set the surge depth.
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.
virtual void setThermoclinePermeability (unsigned int layer, float value)
 Set a thermocline permeability.

Protected Attributes

DtDemyDe

Detailed Description

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

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.

virtual void makVrv::DtSceneEnvironmentalsControllerObject::setCloudState ( unsigned int  value)
virtual

Sets the preset cloud state.

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::setVisibilityDistance ( float  value)
virtual

Sets the visibility distance.

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::setWindDirection ( float  value)
virtual

Sets the wind direction.

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

Sets the wind speed.

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

Set the sea state according to the Beaufort Scale.

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

Set the sea state direction in radians from North.

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

Set the sea state according to the Beaufort Scale.

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

Set the sea state direction in radians from 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 Celsius.

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.

Member Data Documentation

DtDe& makVrv::DtSceneEnvironmentalsControllerObject::myDe
protected

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

Document ID: Generated on Thu Apr 12 03:15:37 EDT 2018 from SVN revision 187986
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)