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

The logic for displaying/editing the environment conditions. More...

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

Public Member Functions

 DtEnvironmentConditionsLogic (DtDe &de, DtEnvironmentInterface &environment, DtEnvironmentConditionsInterface &iface, DtPersistenceControlsInterface &persistanceIface)
 CTOR. More...
 
virtual ~DtEnvironmentConditionsLogic ()
 DTOR. More...
 
virtual void connectToInterface ()
 

Static Public Member Functions

static float convertBaseMSLAltitudeWidgetDisplayToNative (float displayAltitude)
 Converts the provided altitude from the unit of measurement used by the Environment Conditions Widget for elevational configurations' base MSL altitude, which is Feet, to Meters. More...
 
static float convertBaseMSLAltitudeNativeToWidgetDisplay (float nativeAltitude)
 Converts the provided altitude from Meters to the unit of measurement used by the Environment Conditions Widget for elevational configurations' base MSL altitude, which is Feet. More...
 
static float convertWindSpeedWidgetDisplayToNative (DtDe &de, float displayWindSpeed)
 Converts the provided wind speed from the unit of measurement used by the Environment Conditions Widget for elevational configurations' wind speed, which is whatever is set for the 'Weather'/'Wind Speed' display unit, to Meters Per Second. More...
 
static float convertWindSpeedNativeToWidgetDisplay (DtDe &de, float nativeWindSpeed)
 Converts the provided wind speed from Meters Per Second to the unit of measurement used by the Environment Conditions Widget for elevational configurations' wind speed, which is whatever is set for the 'Weather'/'Wind Speed' display unit. More...
 
static float convertWindDirectionWidgetDisplayToNative (float displayWindSpeed)
 Converts the provided wind direction from the unit of measurement used by the Environment Conditions Widget for elevational configurations' wind direction, which is degrees, to radians. More...
 
static float convertWindDirectionNativeToWidgetDisplay (float nativeWindSpeed)
 Converts the provided wind direction from radians to the unit of measurement used by the Environment Conditions Widget for elevational configurations' wind direction, which is degrees. More...
 
static float convertVisibilityDistanceWidgetDisplayToNative (DtDe &de, float displayVisibilityDistance)
 Converts the provided visibility distance from the unit of measurement used by the Environment Conditions Widget for elevational configurations' visibility distance, which is whatever is set for the 'Weather'/'Visibility' display unit, to Meters. More...
 
static float convertVisibilityDistanceNativeToWidgetDisplay (DtDe &de, float nativeVisibilityDistance)
 Converts the provided visibility distance from Meters to the unit of measurement used by the Environment Conditions Widget for elevational configurations' visibility distance, which is whatever is set for the 'Weather'/'Visibility' display unit. More...
 
static float convertSkyCoverageWidgetDisplayToNative (float displaySkyCoverage)
 Converts the provided numerical value expressing sky coverage, in non-normalized Oktas (0-8), to normalized Oktas which is what VR-Vantage uses when processing sky coverage. More...
 
static float convertSkyCoverageNativeToWidgetDisplay (float nativeSkyCoverage)
 Converts the provided numerical value expressing sky coverage, in normalized Oktas (0-1), to non-normalized Oktas for display by the Environment Conditions Widget for elevational configurations' sky coverage. More...
 
static
DtEnvironmentConditionsInterface::DtUnicodeList 
globalCloudTypesOnly (DtEnvironmentConditionsInterface::DtUnicodeList listToSubset)
 
static
DtEnvironmentConditionsInterface::DtUnicodeList 
localCloudTypesOnly (DtEnvironmentConditionsInterface::DtUnicodeList listToSubset)
 
static void setNonVrvVisualizableElevationalConfigurationColumnsEditState (DtEnvironmentConditionsInterface *inter, float baseMSLAltitude, bool isEditable)
 Utility function to set the Non-VRV visualizable configurations editable state. More...
 

Static Public Attributes

static const
DtEnvironmentConditionsInterface::DtUnicodeList 
CloudTypeNames
 

Protected Member Functions

virtual void onChangeGroundSnowAccumulation (double depth)
 Handle a change in the ground snow accumulation depth Changes from the environment widget. More...
 
virtual void onChangeRoadSnowAccumulation (double depth)
 Handle a change in the ground snow accumulation depth Changes from the environment widget. More...
 
virtual void onChangeSnowMinimumElevation (double elevation)
 Handle a change in the ground snow elevation transition Changes from the environment widget. More...
 
virtual void onChangeSnowElevationTransition (double elevation)
 Handle a change in the ground snow minimum elevation Changes from the environment widget. More...
 
virtual void onChangeGroundRainAccumulation (double depth)
 Handle a change in the ground rain accumulation depth Changes from the environment widget. More...
 
virtual void sendEnvironmentToGUI (bool initialSettings)
 Populate the widget with current environment settings. More...
 
virtual void sendRemoteWeatherToGUI ()
 Populate the widget with remote weather settings. More...
 
virtual void sendPersistenceToGUI ()
 Populate the widget with persistence settings. More...
 
virtual void blockEnvironmentSignals (bool blocked)
 Dynamically blocks or unblocks signals from DtEnvironmentSignaler. More...
 
Slots for handling reading/writing configuration.
virtual void on_import ()
 Handle a request to import the environment from a configuration file. More...
 
virtual void on_export ()
 Handle a request to export the current environment to a configuration file. More...
 
virtual void importSettings (const std::string &file)
 Import the environment from a configuration file. More...
 
virtual void exportSettings (const std::string &file)
 Export the current environment to a configuration file. More...
 
virtual void restoreDefaultSettings ()
 Handle a request to restore the environment previous settings. More...
 
virtual void restoreFactorySettings ()
 Handle a request to restore the environment to factory settings. More...
 
Slots for handling settings changed driven from the simulation.
virtual void sceneCreated ()
 Handle if the scene (and thus environment) has been created (or re-created) More...
 
virtual void atmosphericParametersChanged ()
 Handle any atmospheric change. More...
 
virtual void precipitationSettingsChanged ()
 Handle any precipitation change. More...
 
virtual void groundSnowAccumulationChanged ()
 Handle a change in the ground snow accumulation depth Changes are driven from the simulation/environment. More...
 
virtual void roadSnowAccumulationChanged ()
 Handle a change in the road snow accumulation depth Changes are driven from the simulation/environment. More...
 
virtual void snowMinimumElevationChanged ()
 Handle a change in the snow minimum elevation Changes are driven from the simulation/environment. More...
 
virtual void snowElevationTransitionChanged ()
 Handle a change in the ground elvation transition Changes are driven from the simulation/environment. More...
 
virtual void groundRainAccumulationChanged ()
 Handle a change in the ground rain accumulation depth Changes are driven from the simulation/environment. More...
 
virtual void fogHeightChanged (float altitude)
 Handle a change to fog ceiling height. More...
 
virtual void fogColorChanged (const DtVector &color)
 Handle a change to fog color. More...
 
virtual void elevationalConfigurationRemoved (float baseMSLAltitude)
 Handle a removal of an elevational configuration. More...
 
virtual void elevationalConfigurationMoved (float oldBaseMSLAltitude, float newBaseMSLAltitude)
 Handle a change in base MSL altitude of an elevational configuration. More...
 
virtual void elevationalConfigurationAdded (DtEnvironmentInterface::DtElevationalConfigurationRecord rec)
 Handle an addition of an elevational configuration. More...
 
virtual void elevationalConfigurationUpdated (DtEnvironmentInterface::DtElevationalConfigurationRecord rec)
 Handle an update to an elevational configuration. More...
 
virtual void seaStateChanged (unsigned int state)
 Handle a change to sea state. More...
 
virtual void seaStateDirectionChanged (float radians)
 Handle a change to sea state direction. More...
 
virtual void windDrivenSeaStateChanged (bool enabled)
 Handle a change to the wind-driven sea state flag. More...
 
virtual void swellStateChanged (unsigned int state)
 Handle a change to swell state. More...
 
virtual void swellStateDirectionChanged (float radians)
 Handle a change to swell state direction. More...
 
virtual void windFetchChanged (float distance)
 Handle a change to wind fetch. More...
 
virtual void seaChoppinessChanged (float chop)
 Handle a change to sea choppiness. More...
 
virtual void underwaterVisibilityEnabledChanged (bool enable)
 Handle a change to whether underwater visibility is used Changes are driven from the simulation/environment. More...
 
virtual void underwaterVisibilityChanged (double distance)
 Handle a change to underwater visibility. More...
 
virtual void waterSurfaceTransparencyChanged (double transparency)
 Handle a change to coastal-water transparency. More...
 
virtual void surgeDepthChanged (double depth)
 Handle a change to surge depth. More...
 
virtual void depthOffsetChanged (double offset)
 Handle a change to the depth offset. More...
 
virtual void tidalCurrentSpeedChanged (double speed)
 Changes are driven from the simulation/environment. More...
 
virtual void tidalCurrentDirectionChanged (double direction)
 Changes are driven from the simulation/environment. More...
 
virtual void displayUnitsChanged ()
 Handle a change to displayed units. More...
 
Slots for handling settings changed driven from the GUI.
virtual void onSelectEnvironmentConditions (const DtUnicode &name)
 
virtual void onAddEnvironmentConditions (const DtUnicode &name)
 Handle when a new environment condition is added. More...
 
virtual void onRemoveEnvironmentConditions (const DtUnicode &name)
 Handle when a environment condition should be removed. More...
 
virtual void onSaveEnvironmentConditions (const DtUnicode &name)
 Handle when the current environment condition should be saved. More...
 
virtual void onSetDefaultEnvironmentConditions (const DtUnicode &name)
 Handle when a default environment condition should be set. More...
 
virtual void onAddElevationalConfiguration ()
 Handle a creation of an elevational configuration. More...
 
virtual void onRemoveElevationalConfiguration (float altitude)
 Handle a deletion of an elevational configuration by its base MSL altitude, in feet. More...
 
virtual void onElevationalConfigurationAltitudeChanged (float newAltitude, float oldAltitude)
 Handle an update to a elevational configuration's base MSL altitude, in feet. More...
 
virtual void onUpdateElevationalConfiguration (float baseMSLAltitude, float windSpeed, float windDirection, float visibilityDistance, DtEnvironmentInterface::VisibilityObscurant obscurant, DtEnvironmentInterface::CloudType cloudType, float cloudDensity, int skyCoverage)
 Handle an update of an elevational configuration. More...
 
virtual void onChangePrecipitationType (int type)
 Handle a change to precipitation type. More...
 
virtual void onChangePrecipitationIntensity (double value)
 Handle a change to precipitation intensity. More...
 
virtual void onChangeLightningPresent (bool lightningPresent)
 Handle a lightning present change. More...
 
virtual void onChangeFogHeight (double height)
 
virtual void onChangeFogColor (double red, double green, double blue)
 Handle a change to fog color. More...
 
virtual void onChangeSwellState (int index)
 
virtual void onChangeSwellStateDirection (double degree)
 Handle a change to swell state direction. More...
 
virtual void onEnableWindDrivenSeaState (bool enabled)
 Handle a change to the wind-driven sea-state flag. More...
 
virtual void onChangeSeaState (int index)
 Handle a change to sea-state. More...
 
virtual void onChangeSeaStateDirection (double degree)
 Handle a change to sea-state direction. More...
 
virtual void onChangeSeaSurfaceTransparency (double alpha)
 
virtual void onChangeUnderWaterVisibilityEnabled (bool enable)
 Handle a change to the underwater visibility enabled state. More...
 
virtual void onChangeUnderWaterVisibility (double distance)
 Handle a change to the underwater visibility distance. More...
 
virtual void onChangeSeaChoppiness (double chop)
 Handle a change to the water surface choppiness. More...
 
virtual void onChangeWindFetch (double distance)
 Handle a change to the ocean fetch. More...
 
virtual void onChangeSurgeDepth (double distance)
 Handle a change to the surge depth. More...
 
virtual void onChangeDepthOffset (double offset)
 Handle a change to the depth offset. More...
 
virtual void onChangeTidalCurrentSpeed (double speed)
 Changes from the environment widget. More...
 
virtual void onChangeTidalCurrentDirection (double direction)
 Changes from the environment widget. More...
 
virtual void onChangeRemoteSettings (bool enable)
 
virtual void onRequestRemoteSettings ()
 Handle a request for remote weather update. More...
 

Protected Attributes

DtDemyDe
 
DtSignalConnectionManager mySignals
 
DtSignalConnectionManager myEnvironmentSignals
 
DtEnvironmentInterfacemyEnvironment
 
DtEnvironmentConditionsInterfacemyInterface
 
DtPersistenceControlsInterfacemyPersistenceInterface
 

Detailed Description

The logic for displaying/editing the environment conditions.

Constructor & Destructor Documentation

makVrv::DtEnvironmentConditionsLogic::DtEnvironmentConditionsLogic ( DtDe de,
DtEnvironmentInterface environment,
DtEnvironmentConditionsInterface iface,
DtPersistenceControlsInterface persistanceIface 
)

CTOR.

virtual makVrv::DtEnvironmentConditionsLogic::~DtEnvironmentConditionsLogic ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEnvironmentConditionsLogic::connectToInterface ( )
virtual
static float makVrv::DtEnvironmentConditionsLogic::convertBaseMSLAltitudeWidgetDisplayToNative ( float  displayAltitude)
static

Converts the provided altitude from the unit of measurement used by the Environment Conditions Widget for elevational configurations' base MSL altitude, which is Feet, to Meters.

static float makVrv::DtEnvironmentConditionsLogic::convertBaseMSLAltitudeNativeToWidgetDisplay ( float  nativeAltitude)
static

Converts the provided altitude from Meters to the unit of measurement used by the Environment Conditions Widget for elevational configurations' base MSL altitude, which is Feet.

static float makVrv::DtEnvironmentConditionsLogic::convertWindSpeedWidgetDisplayToNative ( DtDe de,
float  displayWindSpeed 
)
static

Converts the provided wind speed from the unit of measurement used by the Environment Conditions Widget for elevational configurations' wind speed, which is whatever is set for the 'Weather'/'Wind Speed' display unit, to Meters Per Second.

static float makVrv::DtEnvironmentConditionsLogic::convertWindSpeedNativeToWidgetDisplay ( DtDe de,
float  nativeWindSpeed 
)
static

Converts the provided wind speed from Meters Per Second to the unit of measurement used by the Environment Conditions Widget for elevational configurations' wind speed, which is whatever is set for the 'Weather'/'Wind Speed' display unit.

static float makVrv::DtEnvironmentConditionsLogic::convertWindDirectionWidgetDisplayToNative ( float  displayWindSpeed)
static

Converts the provided wind direction from the unit of measurement used by the Environment Conditions Widget for elevational configurations' wind direction, which is degrees, to radians.

static float makVrv::DtEnvironmentConditionsLogic::convertWindDirectionNativeToWidgetDisplay ( float  nativeWindSpeed)
static

Converts the provided wind direction from radians to the unit of measurement used by the Environment Conditions Widget for elevational configurations' wind direction, which is degrees.

This function will never return 0.0, instead it will return 360.0.

static float makVrv::DtEnvironmentConditionsLogic::convertVisibilityDistanceWidgetDisplayToNative ( DtDe de,
float  displayVisibilityDistance 
)
static

Converts the provided visibility distance from the unit of measurement used by the Environment Conditions Widget for elevational configurations' visibility distance, which is whatever is set for the 'Weather'/'Visibility' display unit, to Meters.

static float makVrv::DtEnvironmentConditionsLogic::convertVisibilityDistanceNativeToWidgetDisplay ( DtDe de,
float  nativeVisibilityDistance 
)
static

Converts the provided visibility distance from Meters to the unit of measurement used by the Environment Conditions Widget for elevational configurations' visibility distance, which is whatever is set for the 'Weather'/'Visibility' display unit.

static float makVrv::DtEnvironmentConditionsLogic::convertSkyCoverageWidgetDisplayToNative ( float  displaySkyCoverage)
static

Converts the provided numerical value expressing sky coverage, in non-normalized Oktas (0-8), to normalized Oktas which is what VR-Vantage uses when processing sky coverage.

static float makVrv::DtEnvironmentConditionsLogic::convertSkyCoverageNativeToWidgetDisplay ( float  nativeSkyCoverage)
static

Converts the provided numerical value expressing sky coverage, in normalized Oktas (0-1), to non-normalized Oktas for display by the Environment Conditions Widget for elevational configurations' sky coverage.

static DtEnvironmentConditionsInterface::DtUnicodeList makVrv::DtEnvironmentConditionsLogic::globalCloudTypesOnly ( DtEnvironmentConditionsInterface::DtUnicodeList  listToSubset)
static
static DtEnvironmentConditionsInterface::DtUnicodeList makVrv::DtEnvironmentConditionsLogic::localCloudTypesOnly ( DtEnvironmentConditionsInterface::DtUnicodeList  listToSubset)
static
static void makVrv::DtEnvironmentConditionsLogic::setNonVrvVisualizableElevationalConfigurationColumnsEditState ( DtEnvironmentConditionsInterface inter,
float  baseMSLAltitude,
bool  isEditable 
)
static

Utility function to set the Non-VRV visualizable configurations editable state.

virtual void makVrv::DtEnvironmentConditionsLogic::on_import ( )
protectedvirtual

Handle a request to import the environment from a configuration file.

virtual void makVrv::DtEnvironmentConditionsLogic::on_export ( )
protectedvirtual

Handle a request to export the current environment to a configuration file.

virtual void makVrv::DtEnvironmentConditionsLogic::importSettings ( const std::string &  file)
protectedvirtual

Import the environment from a configuration file.

Parameters
[in]fileis the name of the configuration file.
virtual void makVrv::DtEnvironmentConditionsLogic::exportSettings ( const std::string &  file)
protectedvirtual

Export the current environment to a configuration file.

Parameters
[in]fileis the name of the configuration file.
virtual void makVrv::DtEnvironmentConditionsLogic::restoreDefaultSettings ( )
protectedvirtual

Handle a request to restore the environment previous settings.

virtual void makVrv::DtEnvironmentConditionsLogic::restoreFactorySettings ( )
protectedvirtual

Handle a request to restore the environment to factory settings.

virtual void makVrv::DtEnvironmentConditionsLogic::sceneCreated ( )
protectedvirtual

Handle if the scene (and thus environment) has been created (or re-created)

virtual void makVrv::DtEnvironmentConditionsLogic::atmosphericParametersChanged ( )
protectedvirtual

Handle any atmospheric change.

Changes are driven from the simulation/environment.

virtual void makVrv::DtEnvironmentConditionsLogic::precipitationSettingsChanged ( )
protectedvirtual

Handle any precipitation change.

Changes are driven from the simulation/environment.

virtual void makVrv::DtEnvironmentConditionsLogic::groundSnowAccumulationChanged ( )
protectedvirtual

Handle a change in the ground snow accumulation depth Changes are driven from the simulation/environment.

virtual void makVrv::DtEnvironmentConditionsLogic::roadSnowAccumulationChanged ( )
protectedvirtual

Handle a change in the road snow accumulation depth Changes are driven from the simulation/environment.

virtual void makVrv::DtEnvironmentConditionsLogic::snowMinimumElevationChanged ( )
protectedvirtual

Handle a change in the snow minimum elevation Changes are driven from the simulation/environment.

virtual void makVrv::DtEnvironmentConditionsLogic::snowElevationTransitionChanged ( )
protectedvirtual

Handle a change in the ground elvation transition Changes are driven from the simulation/environment.

virtual void makVrv::DtEnvironmentConditionsLogic::groundRainAccumulationChanged ( )
protectedvirtual

Handle a change in the ground rain accumulation depth Changes are driven from the simulation/environment.

virtual void makVrv::DtEnvironmentConditionsLogic::fogHeightChanged ( float  altitude)
protectedvirtual

Handle a change to fog ceiling height.

Changes are driven from the simulation/environment.

Parameters
[in]altitudeis the fog ceiling height in meters.
virtual void makVrv::DtEnvironmentConditionsLogic::fogColorChanged ( const DtVector color)
protectedvirtual

Handle a change to fog color.

Changes are driven from the simulation/environment.

Parameters
[in]coloris the fog color in normalized values.
virtual void makVrv::DtEnvironmentConditionsLogic::elevationalConfigurationRemoved ( float  baseMSLAltitude)
protectedvirtual

Handle a removal of an elevational configuration.

Changes are driven from the simulation/environment.

Parameters
[in]baseMSLAltitudeThe MSL altitude, in meters, associated the elevational configuration being updated
virtual void makVrv::DtEnvironmentConditionsLogic::elevationalConfigurationMoved ( float  oldBaseMSLAltitude,
float  newBaseMSLAltitude 
)
protectedvirtual

Handle a change in base MSL altitude of an elevational configuration.

Changes are driven from the simulation/environment.

Parameters
[in]oldBaseMSLAltitudeThe MSL altitude, in meters, associated the elevational configuration being updated
[in]newBaseMSLAltitudeThe new MSL altitude, in meters, for the elevational configuration being updated
virtual void makVrv::DtEnvironmentConditionsLogic::elevationalConfigurationAdded ( DtEnvironmentInterface::DtElevationalConfigurationRecord  rec)
protectedvirtual

Handle an addition of an elevational configuration.

Changes are driven from the simulation/environment.

Parameters
[in]baseMSLAltitudeThe MSL altitude, in meters, associated the elevational configuration being updated
[in]speedis the speed of the wind, in meters per second.
inv]radians is the direction in radians clockwise from true north.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic, and makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::elevationalConfigurationUpdated ( DtEnvironmentInterface::DtElevationalConfigurationRecord  rec)
protectedvirtual

Handle an update to an elevational configuration.

Changes are driven from the simulation/environment.

Parameters
[in]baseMSLAltitudeThe MSL altitude, in meters, associated the elevational configuration being updated
[in]speedis the speed of the wind, in meters per second.
inv]radians is the direction in radians clockwise from true north.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic, and makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::seaStateChanged ( unsigned int  state)
protectedvirtual

Handle a change to sea state.

Changes are driven from the simulation/environment.

Parameters
[in]stateis the Douglas Sea State.
virtual void makVrv::DtEnvironmentConditionsLogic::seaStateDirectionChanged ( float  radians)
protectedvirtual

Handle a change to sea state direction.

Changes are driven from the simulation/environment.

Parameters
inv]radians is the direction in radians clockwise from north.
virtual void makVrv::DtEnvironmentConditionsLogic::windDrivenSeaStateChanged ( bool  enabled)
protectedvirtual

Handle a change to the wind-driven sea state flag.

Changes are driven from the simulation/environment.

Parameters
[in]enabledis the flag for wind-driven sea state.
virtual void makVrv::DtEnvironmentConditionsLogic::swellStateChanged ( unsigned int  state)
protectedvirtual

Handle a change to swell state.

Changes are driven from the simulation/environment.

Parameters
[in]stateis the Douglas Swell State.
virtual void makVrv::DtEnvironmentConditionsLogic::swellStateDirectionChanged ( float  radians)
protectedvirtual

Handle a change to swell state direction.

Changes are driven from the simulation/environment.

Parameters
[in]radiansis the direction in radians clockwise from north.
virtual void makVrv::DtEnvironmentConditionsLogic::windFetchChanged ( float  distance)
protectedvirtual

Handle a change to wind fetch.

Changes are driven from the simulation/environment.

Parameters
[in]distanceis the wind fetch in meters.
virtual void makVrv::DtEnvironmentConditionsLogic::seaChoppinessChanged ( float  chop)
protectedvirtual

Handle a change to sea choppiness.

Changes are driven from the simulation/environment.

Parameters
[in]chopis a normalized value of choppiness.
virtual void makVrv::DtEnvironmentConditionsLogic::underwaterVisibilityEnabledChanged ( bool  enable)
protectedvirtual

Handle a change to whether underwater visibility is used Changes are driven from the simulation/environment.

Parameters
[in]enable(or not)
virtual void makVrv::DtEnvironmentConditionsLogic::underwaterVisibilityChanged ( double  distance)
protectedvirtual

Handle a change to underwater visibility.

Changes are driven from the simulation/environment.

Parameters
[in]distanceis the underwater visibility in meters.
virtual void makVrv::DtEnvironmentConditionsLogic::waterSurfaceTransparencyChanged ( double  transparency)
protectedvirtual

Handle a change to coastal-water transparency.

Changes are driven from the simulation/environment.

Parameters
[in]transparencyis a normalized value of transparency.
virtual void makVrv::DtEnvironmentConditionsLogic::surgeDepthChanged ( double  depth)
protectedvirtual

Handle a change to surge depth.

Changes are driven from the simulation/environment.

Parameters
[in]depthis the surge depth in meters.
virtual void makVrv::DtEnvironmentConditionsLogic::depthOffsetChanged ( double  offset)
protectedvirtual

Handle a change to the depth offset.

Changes are driven from the simulation/environment.

Parameters
[in]offsetis the depth offset in meters.
virtual void makVrv::DtEnvironmentConditionsLogic::tidalCurrentSpeedChanged ( double  speed)
protectedvirtual

Changes are driven from the simulation/environment.

virtual void makVrv::DtEnvironmentConditionsLogic::tidalCurrentDirectionChanged ( double  direction)
protectedvirtual

Changes are driven from the simulation/environment.

virtual void makVrv::DtEnvironmentConditionsLogic::displayUnitsChanged ( )
protectedvirtual

Handle a change to displayed units.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onSelectEnvironmentConditions ( const DtUnicode name)
protectedvirtual

Handle an environment condition selection change.

Parameters
[in]nameis the name of the environment condition to select.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onAddEnvironmentConditions ( const DtUnicode name)
protectedvirtual

Handle when a new environment condition is added.

Parameters
[in]nameis the name of the environment condition to add.
Note
Adding a new condition does not automatically select it.

Reimplemented in makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic, and makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onRemoveEnvironmentConditions ( const DtUnicode name)
protectedvirtual

Handle when a environment condition should be removed.

Parameters
[in]nameis the name of the environment condition to remove.

Reimplemented in makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic, and makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onSaveEnvironmentConditions ( const DtUnicode name)
protectedvirtual

Handle when the current environment condition should be saved.

Parameters
[in]nameis the name to save the current conditions as.

Reimplemented in makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onSetDefaultEnvironmentConditions ( const DtUnicode name)
protectedvirtual

Handle when a default environment condition should be set.

Parameters
[in]nameis the name of the default environment conditions.
virtual void makVrv::DtEnvironmentConditionsLogic::onAddElevationalConfiguration ( )
protectedvirtual

Handle a creation of an elevational configuration.

Reimplemented in makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onRemoveElevationalConfiguration ( float  altitude)
protectedvirtual

Handle a deletion of an elevational configuration by its base MSL altitude, in feet.

Reimplemented in makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onElevationalConfigurationAltitudeChanged ( float  newAltitude,
float  oldAltitude 
)
protectedvirtual

Handle an update to a elevational configuration's base MSL altitude, in feet.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic, and makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onUpdateElevationalConfiguration ( float  baseMSLAltitude,
float  windSpeed,
float  windDirection,
float  visibilityDistance,
DtEnvironmentInterface::VisibilityObscurant  obscurant,
DtEnvironmentInterface::CloudType  cloudType,
float  cloudDensity,
int  skyCoverage 
)
protectedvirtual

Handle an update of an elevational configuration.

The base MSL altitude is in feet. The wind speed is in knots. The wind direction is in degrees from True North (clockwise). The visibility distance is in whatever unit of measurement is specified by the Weather/Visibility display unit. The obscurant is expressed by an enumerated value.

Reimplemented in makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic, and makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangePrecipitationType ( int  type)
protectedvirtual

Handle a change to precipitation type.

Changes from the environment widget

Parameters
[in]typeis the type of precipitation (None, Rain, Snow).

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangePrecipitationIntensity ( double  value)
protectedvirtual

Handle a change to precipitation intensity.

Changes from the environment widget

Parameters
[in]valueis the intensity of precipitation (0.0 - 1.0).

Reimplemented in makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic, and makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeLightningPresent ( bool  lightningPresent)
protectedvirtual

Handle a lightning present change.

Changes from the environment widget

Parameters
[in]whetheror not lightning is present or not

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeGroundSnowAccumulation ( double  depth)
protectedvirtual

Handle a change in the ground snow accumulation depth Changes from the environment widget.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeRoadSnowAccumulation ( double  depth)
protectedvirtual

Handle a change in the ground snow accumulation depth Changes from the environment widget.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeSnowMinimumElevation ( double  elevation)
protectedvirtual

Handle a change in the ground snow elevation transition Changes from the environment widget.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeSnowElevationTransition ( double  elevation)
protectedvirtual

Handle a change in the ground snow minimum elevation Changes from the environment widget.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeGroundRainAccumulation ( double  depth)
protectedvirtual

Handle a change in the ground rain accumulation depth Changes from the environment widget.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeFogHeight ( double  height)
protectedvirtual

Handle a change to fog height. Changes from the environment widget

Parameters
[in]heightis the ceiling height (in commanded units).

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeFogColor ( double  red,
double  green,
double  blue 
)
protectedvirtual

Handle a change to fog color.

Changes from the environment widget

Parameters
[in]redis the normalized color component from 0.0 to 1.0.
[in]greenis the normalized color component from 0.0 to 1.0.
[in]blueis the normalized color component from 0.0 to 1.0.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeSwellState ( int  index)
protectedvirtual

Handle a change to sea-swell state. Changes from the environment widget

Parameters
[in]indexis the index of the sea-swell.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeSwellStateDirection ( double  degree)
protectedvirtual

Handle a change to swell state direction.

Changes from the environment widget

Parameters
[in]degreeis the direction of the swell state.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onEnableWindDrivenSeaState ( bool  enabled)
protectedvirtual

Handle a change to the wind-driven sea-state flag.

Changes from the environment widget

Parameters
[in]enabledis the flag for wind-driven sea-state.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeSeaState ( int  index)
protectedvirtual

Handle a change to sea-state.

Changes from the environment widget

Parameters
[in]indexis the index of the sea-state.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeSeaStateDirection ( double  degree)
protectedvirtual

Handle a change to sea-state direction.

Changes from the environment widget

Parameters
[in]degreeis the direction of the sea-state.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeSeaSurfaceTransparency ( double  alpha)
protectedvirtual

Handle a change to surface transparency. Changes from the environment widget

Parameters
[in]alphais the amount of alpha for the sea-surface (0.0 - 1.0).

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeUnderWaterVisibilityEnabled ( bool  enable)
protectedvirtual

Handle a change to the underwater visibility enabled state.

Changes from the environment widget

Parameters
[in]enable(or not)
virtual void makVrv::DtEnvironmentConditionsLogic::onChangeUnderWaterVisibility ( double  distance)
protectedvirtual

Handle a change to the underwater visibility distance.

Changes from the environment widget

Parameters
[in]distanceis the visible distance underwater.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeSeaChoppiness ( double  chop)
protectedvirtual

Handle a change to the water surface choppiness.

Changes from the environment widget

Parameters
[in]chopis the amount of choppiness (0.0 - 1.0).

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeWindFetch ( double  distance)
protectedvirtual

Handle a change to the ocean fetch.

Changes from the environment widget

Parameters
[in]distanceis the is the distance for sea fetch.
virtual void makVrv::DtEnvironmentConditionsLogic::onChangeSurgeDepth ( double  distance)
protectedvirtual

Handle a change to the surge depth.

Changes from the environment widget

Parameters
[in]distanceis the is the distance for surge depth.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeDepthOffset ( double  offset)
protectedvirtual

Handle a change to the depth offset.

Changes from the environment widget

Parameters
[in]offsetis the is the depth offset distance.
virtual void makVrv::DtEnvironmentConditionsLogic::onChangeTidalCurrentSpeed ( double  speed)
protectedvirtual

Changes from the environment widget.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeTidalCurrentDirection ( double  direction)
protectedvirtual

Changes from the environment widget.

Reimplemented in makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::onChangeRemoteSettings ( bool  enable)
protectedvirtual

Handle a change to remote weather controls.

Parameters
[in]valueis the enabled state for listening to remote weather.
virtual void makVrv::DtEnvironmentConditionsLogic::onRequestRemoteSettings ( )
protectedvirtual

Handle a request for remote weather update.

virtual void makVrv::DtEnvironmentConditionsLogic::sendEnvironmentToGUI ( bool  initialSettings)
protectedvirtual

Populate the widget with current environment settings.

Reimplemented in makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic, and makVrf::DtVrfEnvironmentConditionsWeatherLogic.

virtual void makVrv::DtEnvironmentConditionsLogic::sendRemoteWeatherToGUI ( )
protectedvirtual

Populate the widget with remote weather settings.

virtual void makVrv::DtEnvironmentConditionsLogic::sendPersistenceToGUI ( )
protectedvirtual

Populate the widget with persistence settings.

virtual void makVrv::DtEnvironmentConditionsLogic::blockEnvironmentSignals ( bool  blocked)
protectedvirtual

Dynamically blocks or unblocks signals from DtEnvironmentSignaler.

Parameters
[in]blockedif true, block signals

Reimplemented in makVrf::DtSimulationCommandWidgetEnvironmentConditionsLogic.

Member Data Documentation

const DtEnvironmentConditionsInterface::DtUnicodeList makVrv::DtEnvironmentConditionsLogic::CloudTypeNames
static
DtDe& makVrv::DtEnvironmentConditionsLogic::myDe
protected
DtSignalConnectionManager makVrv::DtEnvironmentConditionsLogic::mySignals
protected
DtSignalConnectionManager makVrv::DtEnvironmentConditionsLogic::myEnvironmentSignals
protected
DtEnvironmentInterface* makVrv::DtEnvironmentConditionsLogic::myEnvironment
protected
DtEnvironmentConditionsInterface& makVrv::DtEnvironmentConditionsLogic::myInterface
protected
DtPersistenceControlsInterface& makVrv::DtEnvironmentConditionsLogic::myPersistenceInterface
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)