![]() |
VR-Forces 5.0.2 Developer's Guide
|
The distributed environment settings manager only maintains one persistent application setting - and that is 'Listen to Remote Environment Settings'. In addition, this manager also maintains the settings for VR-Vantage's 'remote environment'. This 'remote environment' is visualized when 'Listen to Remote Environment Settings' is enabled and contains the environment settings sent over the network.
The weather state listener and the (protocol specific) weather processors handle the network-side processing of remote environment updates and passes it to this manager via an agent/object that is only created in the master display engine.

Public Member Functions | |
| virtual | ~DtDistributedEnvironmentSettingsManager () |
| virtual void | remoteGlobalEnvironmentDiscovered () |
Setters/getters for settings | |
| virtual void | setListenToRemoteEnvironmentSettingsEnabled (bool val) |
| virtual bool | listenToRemoteEnvironmentSettingsEnabled () const |
Setting persistence methods | |
| virtual void | setFromRecord (const makArchives::DtDistributedEnvironmentSettingsRecord &rec) |
| virtual void | getRecord (makArchives::DtDistributedEnvironmentSettingsRecord &rec) const |
Remote Day/Time Setting Setters (Not Serialized) | |
Tell the scene to change the date and time of day. This function does nothing if 'Listen to Remote Environment Settings' is disabled. | |
| virtual void | setDateAndTimeOfDay (int year, int month, int day, int hour, int minutes, double seconds) |
| virtual void | setUseGlobalTimeZone (bool) |
| virtual void | setTimeOfDay (int hour, int minutes, double seconds) |
| virtual void | setTimeOfDayAdvancementSpeed (float speed) |
Remote Environment Setting Setters (Not Serialized) | |
| 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 | 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 (DtEnvironmentInterface::DtElevationalConfigurationRecord rec) |
| 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 (double depth) |
| virtual void | setRoadSnowAccumulation (double depth) |
| virtual void | setSnowMinimumElevation (double elevation) |
| virtual void | setSnowElevationTransition (double elevation) |
| virtual void | setGroundRainAccumulation (double depth) |
Public Member Functions inherited from makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord > | |
| DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext) | |
| virtual | ~DtBaseSettingsManager () |
| virtual void | initializeBackup () |
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord > | |
| DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext) | |
| virtual | ~DtCommonBaseSettingsManager () |
| virtual void | autoSaveIfNecessary () |
| virtual void | setAutoSave (bool doit) |
| virtual bool | autoSave () const |
| virtual void | setUseDefaultSettingsRecord (bool useit) |
| virtual bool | useDefaultSettingsRecord () const |
| virtual DtDeSettings * | settings () |
| virtual const DtDeSettings * | settings () const |
| virtual DtSettingsBackup * | settingsBackup () |
| virtual const DtSettingsBackup * | settingsBackup () const |
| virtual void | loadDefaults () |
| virtual void | saveDefaultSettings () |
| virtual void | loadDefaultSettings (bool loadOnlyFactorySettings) |
| virtual void | importSettings (const std::string &filePath) |
| virtual void | exportSettings (const std::string &filePath) const |
| virtual void | getSplitRecord (std::vector< makArchives::DtDistributedEnvironmentSettingsRecord > &rec, std::vector< std::string > &fileNames) |
| virtual void | addRecords (makArchives::DtDistributedEnvironmentSettingsRecord &rec, makArchives::DtDistributedEnvironmentSettingsRecord &combinedRec) |
Public Member Functions inherited from makVrv::DtVirtualBaseClass | |
| DtVirtualBaseClass () | |
| virtual | ~DtVirtualBaseClass () |
Static Public Member Functions | |
| static DtDistributedEnvironmentSettingsManager & | instance (DtDe &de) |
Protected Member Functions | |
| DtDistributedEnvironmentSettingsManager (DtDe &) | |
Protected Attributes | |
| bool | myListenToRemoteEnvironmentSettingsEnabled |
Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord > | |
| DtSignalConnectionManager | myConnections |
| std::string | myName |
| std::string | myExtension |
| std::string | myDisplayName |
| bool | myUseDefaultSettingsRecordFlag |
| bool | myAutoSaveFlag |
| DtSettingsBackup * | mySettingsBackup |
| DtDe & | myDe |
Friends | |
| template<typename ManagerClass > | |
| ManagerClass & | defaultManagerInstanceFunction (DtDe &, bool) |
| template<typename ManagerClass > | |
| void | defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *) |
Additional Inherited Members | |
Protected Types inherited from makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord > | |
| typedef DtRecordSettingsBackup < DtBaseSettingsManager < makArchives::DtDistributedEnvironmentSettingsRecord > , makArchives::DtDistributedEnvironmentSettingsRecord > | RecordBackupType |
|
virtual |
DTOR.
|
protected |
Protected CTOR ( use instance(..) )
|
static |
Get an instance of the settings manager.
|
virtual |
Sets whether or not to listen to remote environment settings.
|
virtual |
Gets whether or not to listen to remote environment settings.
Reimplemented in makVrf::DtVrfDistributedEnvironmentSettingsManager.
|
virtual |
Use the settings from the given settings record.
Implements makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >.
|
virtual |
Populate the given record with the current settings.
Implements makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >.
|
virtual |
Tell the system to use GMT time as the means to position the sun/moon rather than always moving with the observer. This function does nothing if 'Listen to Remote Environment Settings' is disabled.
|
virtual |
Tell the system to use GMT time as the means to position the sun/moon rather than always moving with the observer. This function does nothing if 'Listen to Remote Environment Settings' is disabled.
|
virtual |
Tell the scene to change the time of day. This function does nothing if 'Listen to Remote Environment Settings' is disabled.
|
virtual |
Tell the scene to change the time of day advancement speed. This function does nothing if 'Listen to Remote Environment Settings' is disabled.
|
virtual |
Set the air turbidity/haziness.
|
virtual |
Set the ambient air temperature, in Kelvins.
|
virtual |
Set the ambient air pressure, in Pascals.
|
virtual |
Set the air temperature altitude, in meters.
|
virtual |
Set the air pressure altitude, in meters.
|
virtual |
Set the air temperature altitude is sea level flag.
|
virtual |
Set the air pressure altitude is sea level flag.
|
virtual |
Set the sea level water concentration, in PPMV (parts per million by volume).
|
virtual |
Sets whether or not lightning is present.
|
virtual |
Sets precipitation type.
|
virtual |
Sets precipitation intensity.
|
virtual |
Sets the fog ceiling height.
|
virtual |
Sets the fog color.
|
virtual |
Set the air turbidity/haziness.
|
virtual |
Set the air turbidity/haziness.
|
virtual |
Removes an elevational configuration record by its base MSL altitude, in meters.
|
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 |
Set the sea swell conditions based on the Douglas sea scale. (http://en.wikipedia.org/wiki/Douglas_Sea_Scale)
|
virtual |
Set the direction, in radians from True North, of sea swells.
|
virtual |
Set the sea state conditions based on the Douglas sea scale. (http://en.wikipedia.org/wiki/Douglas_Sea_Scale)
|
virtual |
Set the sea state direction in radians from True North.
|
virtual |
Set the wind driven seas enabled parameter to allow the wind to determine the sea state.
|
virtual |
Set the ocean wind fetch.
|
virtual |
Set the sea choppiness.
|
virtual |
Set the maximum visibility under water in meters.
|
virtual |
Set the surface transparency.
|
virtual |
Set the surge depth.
|
virtual |
Set the ambient water temperature, in Kelvins.
|
virtual |
Set the speed of water currents in meters per second.
|
virtual |
Set the direction of water currents in radians from north (clockwise).
|
virtual |
Set the current tidal offset from mean-sea-level in meters.
|
virtual |
Set the current direction of tidal flow (0=out, 1=in).
|
virtual |
Set a thermocline depth.
|
virtual |
Set a thermocline permeability.
|
virtual |
Set the ground snow accumulation depth.
|
virtual |
Set the road snow accumulation depth.
|
virtual |
Set the snow minimum elevation.
|
virtual |
Set the snow elevation transition which specifies how long it takes to go from no snow to the full snow depth.
|
virtual |
Set the ground rain accumulation depth.
|
virtual |
Let DtEnviroment know that we have connected to a simulation with global weather being sent on it, if we have remote listening enabled. This is needed to get the local environment cleaned out.
|
friend |
Befriend the manager instance functions for instance retreival/creation.
Befriend the manager instance functions for instance retreival/creation.
Befriend the manager instance functions for instance retrieval/creation.
Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.
|
friend |
Befriend the manager instance functions for instance retreival/creation.
Befriend the manager instance functions for instance retreival/creation.
Befriend the manager instance functions for instance retrieval/creation.
| boost::signalslib::signal<void (bool)> makVrv::DtDistributedEnvironmentSettingsManager::signal_listenToRemoteEnvironmentSettingsChanged |
Boost signals for changed settings.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentAirTurbidityChanged |
Emitted when the air turbidity factor changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentAmbientAirTemperatureChanged |
Emitted when the ambient air temperature, in Kelvins, changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentAmbientAirPressureChanged |
Emitted when the ambient air pressure, in Pascals, changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentAirTemperatureAltitudeChanged |
Emitted when the air temperature altitude, in meters, changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentAirPressureAltitudeChanged |
Emitted when the air pressure altitude, in meters, changes.
| boost::signalslib::signal<void(bool)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentAirTemperatureAltitudeIsSeaLevelChanged |
Emitted when the air temperature altitude is sea level flag changes.
| boost::signalslib::signal<void(bool)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentAirPressureAltitudeIsSeaLevelChanged |
Emitted when the air pressure altitude is sea level flag changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSeaLevelWaterConcentrationChanged |
Emitted when the the sea level water concentration, in PPMV (parts per million by volume), changes.
| boost::signalslib::signal<void(bool)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentLightningPresentChanged |
Emitted when the lightning is present state has changed.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentPrecitipationIntensityChanged |
Emitted when the precipitation intensity factor changes.
| boost::signalslib::signal<void(DtEnvironmentInterface::PrecipitationType)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentPrecipitationTypeChanged |
Emitted when the precipitation type changes.
| boost::signalslib::signal<void(int, int, int)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentTimeOfDayChanged |
Emitted when the time of day changes.
| boost::signalslib::signal<void(int, int, int, int, int, int)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentDateAndTimeOfDayChanged |
Emitted when the date and time of day changes.
| boost::signalslib::signal<void(bool)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentUseGlobalTimeZoneChanged |
Emitted when positioning with the sun with GMT time changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentTimeOfDayAdvancementSpeedChanged |
Emitted when the time of day advancement speed changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentVisibilityChanged |
Emitted when the visibility factor changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentFogHeightChanged |
Emitted when the fog ceiling height changes.
| boost::signalslib::signal<void(const DtVector&)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentFogColorChanged |
Emitted when the fog color changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentElevationalConfigurationRemoved |
Emitted when an elevational configuration is removed.
| boost::signalslib::signal<void(DtEnvironmentInterface::DtElevationalConfigurationRecord)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentElevationalConfigurationUpdatedOrAdded |
Emitted when an elevational configuration is updated or added.
| boost::signalslib::signal<void(DtDouglasSwellState::Scale)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSwellStateChanged |
Emitted when the swell state changes.
| boost::signalslib::signal<void(int)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSwellStateDirectionChanged |
Emitted when the swell state direction changes.
| boost::signalslib::signal<void(DtDouglasSeaState::Scale)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSeaStateChanged |
Emitted when the sea state changes.
| boost::signalslib::signal<void(int)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSeaStateDirectionChanged |
Emitted when the sea state direction changes.
| boost::signalslib::signal<void(int)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentWindDrivenSeaStateEnabledChanged |
Emitted when the wind driven seas state enabled changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentWindFetchChanged |
Emitted when the ocean wind fetch changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSeaChoppinessChanged |
Emitted when the sea choppiness changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentUnderWaterVisibilityChanged |
Emitted when the underwater visibility changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSurfaceTransparencyChanged |
Emitted when the surface transparency changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSurgeDepthChanged |
Emitted when the surge depth changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentAmbientWaterTemperatureChanged |
Emitted when the ambient water temperature, in Kelvins, changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentWaterCurrentSpeedChanged |
Emitted when the water current speed changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentWaterCurrentDirectionChanged |
Emitted when the water current direction changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentTidalOffsetChanged |
Emitted when the tidal offset changes.
| boost::signalslib::signal<void(bool)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentTidalDirectionChanged |
Emitted when the tidal direction changes.
| boost::signalslib::signal<void(unsigned int, float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentThermoclineDepthChanged |
Emitted when the thermocline depth changes.
| boost::signalslib::signal<void(unsigned int, float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentThermoclinePermeabilityChanged |
Emitted when the thermocline permeability changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentGroundSnowAccumulationChanged |
Emitted when the ground snow accumulation depth changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentRoadSnowAccumulationChanged |
Emitted when the road snow accumulation depth changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSnowMinimumElevationChanged |
Emitted when the snow minimum elevation changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentSnowElevationTransitionChanged |
Emitted when the snow elevation transition changes.
| boost::signalslib::signal<void(float)> makVrv::DtDistributedEnvironmentSettingsManager::signal_remoteEnvironmentGroundRainAccumulationChanged |
Emitted when the ground rain accumulation depth changes.
|
protected |