VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtGlobalLayeredEnvironmentData Class Reference

DtGlobalLayeredEnvironmentData extends DtLayeredEnvironmentDataBase by overriding its data 'mutator' methods. It checks (using the DtLayeredEnvironmentDataBase accssors) to see if the value is changed. If it is, it uses the DtSceneEnvironmentalsControllerObjectAgent provided to update the the render (main) thread with the change; and then calls down to DtLayeredEnvironmentDataBase to store the new value.

Inheritance diagram for makVrv::DtGlobalLayeredEnvironmentData:
Inheritance graph
[legend]

Public Member Functions

 DtGlobalLayeredEnvironmentData (DtSceneEnvironmentalsControllerObjectAgent *weatherAgent)
 
 DtGlobalLayeredEnvironmentData ()=delete
 
 DtGlobalLayeredEnvironmentData (const DtGlobalLayeredEnvironmentData &orig)
 
DtGlobalLayeredEnvironmentDataoperator= (const DtGlobalLayeredEnvironmentData &rhs)
 
virtual ~DtGlobalLayeredEnvironmentData ()
 
virtual float removeElevationalConfiguration (DtUniqueID layerId) override
 
virtual void setAirPressure (float pressure) override
 
virtual void setAirTemperature (float temp) override
 
virtual void setPrecipitationType (DtEnvironment::PrecipitationType precipType) override
 
virtual void setPrecipitationIntensity (float intensity) override
 
virtual void setSeaLevelWaterConcentration (float concentration) override
 
virtual void setLightningPresent (bool present) override
 
virtual void setSnowMinimumElevation (float elevation) override
 
virtual void setRoadSnowAccumulation (float accumulation) override
 
virtual void setGroundRainAccumulation (float accumulation) override
 
virtual void setGroundSnowAccumulation (float accumulation) override
 
virtual void setFogColor (const makArchives::DtEnvironmentRecord::DtColorRecord &color) override
 
virtual void setFogHeight (float meters) override
 
virtual void setAirTemperatureAltitude (float value) override
 
virtual void setAirPressureAltitude (float value) override
 
virtual void setSwellState (DtDouglasSwellState::Scale state) override
 
virtual void setSwellStateDirection (float value) override
 
virtual void setSeaState (DtDouglasSeaState::Scale state) override
 
virtual void setSeaStateDirection (float value) override
 
virtual void setWindDrivenSeaStateEnabled (bool value, bool force)
 
virtual void setWindFetch (float value) override
 
virtual void setSeaChoppiness (float value) override
 
virtual void setUnderwaterVisibility (float distance) override
 
virtual void setSurfaceTransparency (float value) override
 
virtual void setSurgeDepth (float value) override
 
virtual void setAmbientWaterTemperature (float temperature) override
 
virtual void setWaterCurrentSpeed (float speed) override
 
virtual void setWaterCurrentDirection (float direction) override
 
virtual void setTidalOffset (float meters) override
 
virtual void setDateAndTimeOfDay (int year, int month, int day, int hour, int minutes, double seconds) override
 
virtual void setUseGlobalTimeZone (bool useGlobal, bool force)
 
virtual void setTimeOfDayAdvancementSpeed (float speed) override
 
virtual
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
setBaseMSLAltitude (DtUniqueID layerId, float mslAltitudeInMeters) override
 
virtual
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
setWindSpeed (DtUniqueID layerId, float speedInMetersPerSecond) override
 
virtual
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
setWindDirection (DtUniqueID layerId, float offsetInRadiansFromTrueNorth) override
 
virtual
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
setVisibilityDistance (DtUniqueID layerId, float visibilityInMeters) override
 
virtual
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
setObscurant (DtUniqueID layerId, makArchives::VisibilityObscurant obscurantEnumerationValue) override
 
virtual
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
setCloudType (DtUniqueID layerId, const std::string &cloudTypeName) override
 
virtual
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
setCloudDensity (DtUniqueID layerId, float cloudDensity) override
 
virtual
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
setSkyCoverage (DtUniqueID layerId, float skyCoverage) override
 
virtual void setThermoclineDepth (int index, float depth)
 
virtual float thermoclineDepth (int index)
 
virtual void setThermoclinePermeability (int index, float permeability)
 
virtual float thermoclinePermeability (int index)
 
- Public Member Functions inherited from makVrv::DtLayeredEnvironmentDataBase
 DtLayeredEnvironmentDataBase ()
 
 DtLayeredEnvironmentDataBase (const DtLayeredEnvironmentDataBase &orig)
 
DtLayeredEnvironmentDataBaseoperator= (const DtLayeredEnvironmentDataBase &rhs)
 
virtual ~DtLayeredEnvironmentDataBase ()
 
virtual void addElevationalConfiguration (DtUniqueID layerId)
 
virtual DtDouglasSwellState::Scale swellState () const
 
virtual
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
findElevationRecord (DtUniqueID layerId)
 
virtual const
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
findElevationRecord (DtUniqueID layerId) const
 
virtual float airPressure () const
 
virtual float airTemperature () const
 
virtual
DtEnvironment::PrecipitationType 
precipitationType () const
 
virtual float precipitationIntensity () const
 
virtual float seaLevelWaterConcentration () const
 
virtual bool lightningPresent () const
 
virtual float snowMinimumElevation () const
 
virtual float roadSnowAccumulation () const
 
virtual float groundRainAccumulation () const
 
virtual float groundSnowAccumulation () const
 
virtual const
makArchives::DtEnvironmentRecord::DtColorRecord
fogColor () const
 
virtual float fogHeight () const
 
virtual float airTemperatureAltitude () const
 
virtual float airPressureAltitude () const
 
virtual float swellStateDirection () const
 
virtual DtDouglasSeaState::Scale seaState () const
 
virtual float seaStateDirection () const
 
virtual void setWindDrivenSeaStateEnabled (bool value)
 
virtual bool windDrivenSeaStateEnabled () const
 
virtual float windFetch () const
 
virtual float seaChoppiness () const
 
virtual float underwaterVisibility () const
 
virtual float surfaceTransparency () const
 
virtual float surgeDepth () const
 
virtual float ambientWaterTemperature () const
 
virtual float waterCurrentSpeed () const
 
virtual float waterCurrentDirection () const
 
virtual float tidalOffset () const
 
virtual void getDateAndTimeOfDay (int &year, int &month, int &day, int &hour, int &minutes, double &seconds) const
 
virtual void setUseGlobalTimeZone (bool useOrNot)
 
virtual bool useGlobalTimeZone () const
 
virtual float timeOfDayAdvancementSpeed () const
 
virtual float baseMSLAltitude (DtUniqueID layerId) const
 
virtual float windSpeed (DtUniqueID layerId) const
 
virtual float windDirection (DtUniqueID layerId) const
 
virtual float visibilityDistance (DtUniqueID layerId) const
 
virtual
makArchives::VisibilityObscurant 
obscurant (DtUniqueID layerId) const
 
virtual std::string cloudType (DtUniqueID layerId) const
 
virtual float cloudDensity (DtUniqueID layerId) const
 
virtual float skyCoverage (DtUniqueID layerId) const
 

Protected Member Functions

virtual void updateGlobalElevationLayer (makArchives::DtEnvironmentRecord::DtEnvironmentRecord::DtElevationalConfigurationRecord &rec)
 

Protected Attributes

DtSceneEnvironmentalsControllerObjectAgent * myGlobalWeatherAgent
 
- Protected Attributes inherited from makVrv::DtLayeredEnvironmentDataBase
makArchives::DtEnvironmentRecord myEnvironmentRecord
 
std::unordered_map< DtUniqueID,
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
myElevationRecords
 
makArchives::DtDateTimeRecord myDateAndTimeRecord
 
bool myUseGlobalTimeZone
 

Constructor & Destructor Documentation

makVrv::DtGlobalLayeredEnvironmentData::DtGlobalLayeredEnvironmentData ( DtSceneEnvironmentalsControllerObjectAgent *  weatherAgent)

CTOR.

makVrv::DtGlobalLayeredEnvironmentData::DtGlobalLayeredEnvironmentData ( )
delete

Default CTOR (not allowed)

makVrv::DtGlobalLayeredEnvironmentData::DtGlobalLayeredEnvironmentData ( const DtGlobalLayeredEnvironmentData orig)

Copy CTOR.

virtual makVrv::DtGlobalLayeredEnvironmentData::~DtGlobalLayeredEnvironmentData ( )
virtual

Virtual DTOR.

Member Function Documentation

DtGlobalLayeredEnvironmentData& makVrv::DtGlobalLayeredEnvironmentData::operator= ( const DtGlobalLayeredEnvironmentData rhs)

Assignment operator.

virtual float makVrv::DtGlobalLayeredEnvironmentData::removeElevationalConfiguration ( DtUniqueID  layerId)
overridevirtual

Remove an elevation configuration with the specified layerId.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setAirPressure ( float  pressure)
overridevirtual

Set the air pressure.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setAirTemperature ( float  temp)
overridevirtual

Set the air temperature.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setPrecipitationType ( DtEnvironment::PrecipitationType  precipType)
overridevirtual

Set the precipitation type.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setPrecipitationIntensity ( float  intensity)
overridevirtual

Set the precipitation intensity. intensity is a normalized value (0.0 to 1.0)

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setSeaLevelWaterConcentration ( float  concentration)
overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setLightningPresent ( bool  present)
overridevirtual

Set whether lightning is present.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setSnowMinimumElevation ( float  elevation)
overridevirtual

Set the minimum elevation (meters) at which snow is on the ground.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setRoadSnowAccumulation ( float  accumulation)
overridevirtual

Set the amount of snow accumulation on roads.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setGroundRainAccumulation ( float  accumulation)
overridevirtual

Set the amount of rain accumulation on the ground.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setGroundSnowAccumulation ( float  accumulation)
overridevirtual

Set the amount of snow accumulation on the ground.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setFogColor ( const makArchives::DtEnvironmentRecord::DtColorRecord color)
overridevirtual

Set the current fog color.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setFogHeight ( float  meters)
overridevirtual

Set the current fog height.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setAirTemperatureAltitude ( float  value)
overridevirtual

Set the altitude for which temperature has been specified.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setAirPressureAltitude ( float  value)
overridevirtual

Set the altitude for which air pressure has been specified.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setSwellState ( DtDouglasSwellState::Scale  state)
overridevirtual

Set the sea swell conditions based on the Douglas sea scale.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setSwellStateDirection ( float  value)
overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setSeaState ( DtDouglasSeaState::Scale  state)
overridevirtual

Set the sea state conditions based on the Douglas sea scale.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setSeaStateDirection ( float  value)
overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setWindDrivenSeaStateEnabled ( bool  value,
bool  force 
)
virtual

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

virtual void makVrv::DtGlobalLayeredEnvironmentData::setWindFetch ( float  value)
overridevirtual

Set the ocean wind fetch.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setSeaChoppiness ( float  value)
overridevirtual

Set the sea choppiness.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setUnderwaterVisibility ( float  distance)
overridevirtual

Set the maximum visibility under water in meters.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setSurfaceTransparency ( float  value)
overridevirtual

Set the surface transparency.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setSurgeDepth ( float  value)
overridevirtual

Set the surge depth.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setAmbientWaterTemperature ( float  temperature)
overridevirtual

Set the ambient water temperature, in Kelvins.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setWaterCurrentSpeed ( float  speed)
overridevirtual

Set the speed of water currents in meters per second.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setWaterCurrentDirection ( float  direction)
overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setTidalOffset ( float  meters)
overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

Set / get the date and time of day.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setUseGlobalTimeZone ( bool  useGlobal,
bool  force 
)
virtual

Set whether to use GMT time as the means to position the sun/moon. Force is used to set the value the first time it is set regardless of its previous value.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setTimeOfDayAdvancementSpeed ( float  speed)
overridevirtual

Set the time of day advancement speed.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setThermoclineDepth ( int  index,
float  depth 
)
virtual

Set / get the depth for the specified thermocline index.

virtual float makVrv::DtGlobalLayeredEnvironmentData::thermoclineDepth ( int  index)
virtual

Set / get the depth for the specified thermocline index.

virtual void makVrv::DtGlobalLayeredEnvironmentData::setThermoclinePermeability ( int  index,
float  permeability 
)
virtual

Set / get the permeability for the specified thermocline index.

virtual float makVrv::DtGlobalLayeredEnvironmentData::thermoclinePermeability ( int  index)
virtual

Set / get the permeability for the specified thermocline index.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtGlobalLayeredEnvironmentData::setBaseMSLAltitude ( DtUniqueID  layerId,
float  mslAltitudeInMeters 
)
overridevirtual

Set the base MSL Altitude, in meters, for this elevational configuration.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtGlobalLayeredEnvironmentData::setWindSpeed ( DtUniqueID  layerId,
float  speedInMetersPerSecond 
)
overridevirtual

Set the speed, in meters per second, for this elevational configuration.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtGlobalLayeredEnvironmentData::setWindDirection ( DtUniqueID  layerId,
float  offsetInRadiansFromTrueNorth 
)
overridevirtual

Set the angular offset (clockwise) from True North, in radians, for this elevational configuration.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtGlobalLayeredEnvironmentData::setVisibilityDistance ( DtUniqueID  layerId,
float  visibilityInMeters 
)
overridevirtual

Set the visibility distance, in meters, for this elevational configuration.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtGlobalLayeredEnvironmentData::setObscurant ( DtUniqueID  layerId,
makArchives::VisibilityObscurant  obscurantEnumerationValue 
)
overridevirtual

Set the visibility obscurant for this elevational configuration.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtGlobalLayeredEnvironmentData::setCloudType ( DtUniqueID  layerId,
const std::string &  cloudTypeName 
)
overridevirtual

Set the cloud type, by name, for this elevational configuration.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtGlobalLayeredEnvironmentData::setCloudDensity ( DtUniqueID  layerId,
float  cloudDensity 
)
overridevirtual

Set the cloud density, in kg/m^3, for this elevational configuration As of VRV2.8, this property is not used. It is only used by VR-Forces.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtGlobalLayeredEnvironmentData::setSkyCoverage ( DtUniqueID  layerId,
float  skyCoverage 
)
overridevirtual

Set the sky coverage, in normalized Oktas [0-1] (which is what SilverLining expects), for this elevational configuration.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtGlobalLayeredEnvironmentData::updateGlobalElevationLayer ( makArchives::DtEnvironmentRecord::DtEnvironmentRecord::DtElevationalConfigurationRecord &  rec)
protectedvirtual

Send an update for a global elevational layer to the render (main) thread.

Member Data Documentation

DtSceneEnvironmentalsControllerObjectAgent* makVrv::DtGlobalLayeredEnvironmentData::myGlobalWeatherAgent
protected

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

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)