makVrv::DtLocalLayeredEnvironmentData Class Reference

DtLocalLayeredEnvironmentData 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 DtLocalEnvironmentalsControllerObjectAgent provided to update the the render (main) thread with the change; and then calls down to DtLayeredEnvironmentDataBase to store the new value. It also adds methods for setting the origin and dimensions of the local weather area, since that data is not part of DtLayeredEnvironmentDataBase (which is used for both local and global weather areas.

Inheritance diagram for makVrv::DtLocalLayeredEnvironmentData:

Public Member Functions
	DtLocalLayeredEnvironmentData (DtLocalEnvironmentalsControllerObjectAgent *weatherAgent)
	DtLocalLayeredEnvironmentData ()=delete
	DtLocalLayeredEnvironmentData (const DtLocalLayeredEnvironmentData &orig)
DtLocalLayeredEnvironmentData &	operator= (const DtLocalLayeredEnvironmentData &rhs)
virtual	~DtLocalLayeredEnvironmentData ()
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 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	setLocalZoneOrigin (const DtVector &origin)
virtual const DtVector &	localZoneOrigin () const
virtual void	setLocalZoneShape (double width, double length, double height, double cornerRadius)
virtual void	getLocalZoneShape (double &width, double &length, double &height, double &cornerRadius) const
Public Member Functions inherited from makVrv::DtLayeredEnvironmentDataBase
	DtLayeredEnvironmentDataBase ()
	DtLayeredEnvironmentDataBase (const DtLayeredEnvironmentDataBase &orig)
DtLayeredEnvironmentDataBase &	operator= (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	setDateAndTimeOfDay (int year, int month, int day, int hour, int minutes, double seconds)
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 void	setTimeOfDayAdvancementSpeed (float speed)
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	updateOrAddLocalElevationLayer (makArchives::DtEnvironmentRecord::DtEnvironmentRecord::DtElevationalConfigurationRecord &rec)

Protected Attributes
DtVector	myZoneOrigin
double	myZoneWidth
double	myZoneLength
double	myZoneHeight
double	myZoneCornerRadius
DtLocalEnvironmentalsControllerObjectAgent *	myLocalWeatherAgent
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::DtLocalLayeredEnvironmentData::DtLocalLayeredEnvironmentData

(

DtLocalEnvironmentalsControllerObjectAgent *

weatherAgent

)

CTOR.

makVrv::DtLocalLayeredEnvironmentData::DtLocalLayeredEnvironmentData ( )

delete

Default CTOR (not allowed)

makVrv::DtLocalLayeredEnvironmentData::DtLocalLayeredEnvironmentData

(

const DtLocalLayeredEnvironmentData &

orig

)

Copy CTOR.

virtual makVrv::DtLocalLayeredEnvironmentData::~DtLocalLayeredEnvironmentData ( )

virtual

Virtual DTOR.

Member Function Documentation

DtLocalLayeredEnvironmentData& makVrv::DtLocalLayeredEnvironmentData::operator=

(

const DtLocalLayeredEnvironmentData &

rhs

)

Assignment operator.

virtual void makVrv::DtLocalLayeredEnvironmentData::setLocalZoneOrigin ( const DtVector &  origin )

virtual

Set / get the a local weather zone origin.

virtual const DtVector& makVrv::DtLocalLayeredEnvironmentData::localZoneOrigin ( ) const

virtual

Set / get the a local weather zone origin.

virtual void makVrv::DtLocalLayeredEnvironmentData::setLocalZoneShape ( double  width, double  length, double  height, double  cornerRadius  )

virtual

Set / get the shape of a local weather zone. The bounds is a rounded rect with height. Note that currently height is not acutally used but it is here for future expansion with the concept of layers.

virtual void makVrv::DtLocalLayeredEnvironmentData::getLocalZoneShape ( double &  width, double &  length, double &  height, double &  cornerRadius  ) const

virtual

Set / get the shape of a local weather zone. The bounds is a rounded rect with height. Note that currently height is not acutally used but it is here for future expansion with the concept of layers.

virtual float makVrv::DtLocalLayeredEnvironmentData::removeElevationalConfiguration ( DtUniqueID  layerId )

overridevirtual

Remove an elevation configuration with the specified layerId.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setAirPressure ( float  pressure )

overridevirtual

Set the air pressure.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setAirTemperature ( float  temp )

overridevirtual

Set the air temperature.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setPrecipitationType ( DtEnvironment::PrecipitationType  precipType )

overridevirtual

Set the precipitation type.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::setLightningPresent ( bool  present )

overridevirtual

Set whether lightning is present.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setRoadSnowAccumulation ( float  accumulation )

overridevirtual

Set the amount of snow accumulation on roads.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setGroundRainAccumulation ( float  accumulation )

overridevirtual

Set the amount of rain accumulation on the ground.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setGroundSnowAccumulation ( float  accumulation )

overridevirtual

Set the amount of snow accumulation on the ground.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setFogColor ( const makArchives::DtEnvironmentRecord::DtColorRecord &  color )

overridevirtual

Set the current fog color.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setFogHeight ( float  meters )

overridevirtual

Set the current fog height.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setAirTemperatureAltitude ( float  value )

overridevirtual

Set the altitude for which temperature has been specified.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::setAirPressureAltitude ( float  value )

overridevirtual

Set the altitude for which air pressure has been specified.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual void makVrv::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::setWindFetch ( float  value )

overridevirtual

Set the ocean wind fetch.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

Set the sea choppiness.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

Set the maximum visibility under water in meters.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

Set the surface transparency.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

Set the surge depth.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

Set the ambient water temperature, in Kelvins.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

Set the speed of water currents in meters per second.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

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

overridevirtual

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

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::setObscurant ( DtUniqueID  layerId, makArchives::VisibilityObscurant  obscurantEnumerationValue  )

overridevirtual

Set the visibility obscurant for this elevational configuration.

Reimplemented from makVrv::DtLayeredEnvironmentDataBase.

virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* makVrv::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::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::DtLocalLayeredEnvironmentData::updateOrAddLocalElevationLayer ( makArchives::DtEnvironmentRecord::DtEnvironmentRecord::DtElevationalConfigurationRecord &  rec )

protectedvirtual

Send an elevational configuration update. The local weather area object (render side) will automatically add a new layer if needed.

Member Data Documentation

DtVector makVrv::DtLocalLayeredEnvironmentData::myZoneOrigin

protected

double makVrv::DtLocalLayeredEnvironmentData::myZoneWidth

protected

double makVrv::DtLocalLayeredEnvironmentData::myZoneLength

protected

double makVrv::DtLocalLayeredEnvironmentData::myZoneHeight

protected

double makVrv::DtLocalLayeredEnvironmentData::myZoneCornerRadius

protected

DtLocalEnvironmentalsControllerObjectAgent* makVrv::DtLocalLayeredEnvironmentData::myLocalWeatherAgent

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtLocalLayeredEnvironmentData.h