VR-Forces 4.3.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions
makVrf::DtVrfEnvironmentConditionsWeatherLogic Class Reference

Logic class for the DtVrfEnvironmentConditionsWeatherWidget. More...

Inheritance diagram for makVrf::DtVrfEnvironmentConditionsWeatherLogic:
Inheritance graph
[legend]

Public Member Functions

 DtVrfEnvironmentConditionsWeatherLogic (makVrv::DtDe &de, makVrv::DtEnvironmentInterface &environment, makVrv::DtEnvironmentConditionsInterface &iface, makVrv::DtPersistenceControlsInterface &persistanceIface)
 CTOR.
 ~DtVrfEnvironmentConditionsWeatherLogic ()
 DTOR.
- Public Member Functions inherited from makVrv::DtEnvironmentConditionsLogic
 DtEnvironmentConditionsLogic (DtDe &de, DtEnvironmentInterface &environment, DtEnvironmentConditionsInterface &iface, DtPersistenceControlsInterface &persistanceIface)
 CTOR.
virtual ~DtEnvironmentConditionsLogic ()
 DTOR.

Protected Member Functions

virtual void onChangeCloudCover (DtVrfWeatherCloudState cloudCover)
 Handle a change to the cloud cover combo box.
virtual void onChangeWindSpeed (double speed)
 Handle a change to wind speed.
virtual void onChangeWindDirection (double degree)
 Handle a change to wind direction.
virtual void onChangePrecipitationType (int type)
 Handle a change to precipitation type.
virtual void onChangePrecipitationIntensity (double value)
 Handle a change to precipitation intensity.
virtual void onChangeVisibility (double distance)
 Handle a change to visibility.
virtual void onChangeSwellState (int index)
 Handle a change to swell state.
virtual void onChangeSwellStateDirection (double degree)
 Handle a change to swell state direction.
virtual void onEnableWindDrivenSeaState (bool enabled)
 Handle a change to the wind-driven sea-state flag.
virtual void onChangeSeaState (int index)
 Handle a change to sea-state.
virtual void onChangeSeaStateDirection (double degree)
 Handle a change to sea-state direction.
virtual void onChangeSeaSurfaceTransparency (double alpha)
 Handle a change to surface transparency.
virtual void onChangeUnderWaterVisibility (double distance)
 Handle a change to the underwater visibility distance.
virtual void onChangeSeaChoppiness (double chop)
 Handle a change to the water surface choppiness.
virtual void onChangeSurgeDepth (double distance)
 Handle a change to the surge depth.
virtual void onSelectEnvironmentConditions (const makVrv::DtUnicode &name)
 Handle an environment condition selection change.
virtual void sendChangeGlobalWeatherCommandForCurrentValues ()
 Sends a DtChangeGlobalWeatherCommand for all the current values.
virtual void sendEnvironmentToGUI ()
 Populate the widget with current environment settings.
virtual void onAddEnvironmentConditions (const makVrv::DtUnicode &name)
 Handle when a new environment condition is added.
virtual void onRemoveEnvironmentConditions (const makVrv::DtUnicode &name)
 Handle when a environment condition should be removed.
virtual void sendEnvironmentConditionsToGUI ()
virtual void updateWeatherConditions ()
- Protected Member Functions inherited from makVrv::DtEnvironmentConditionsLogic
virtual void sendRemoteWeatherToGUI ()
 Populate the widget with remote weather settings.
virtual void sendPersistenceToGUI ()
 Populate the widget with persistence settings.
virtual void on_import ()
 Handle a request to import the environment from a configuration file.
virtual void on_export ()
 Handle a request to export the current environment to a configuration file.
virtual void importSettings (const std::string &file)
 Import the environment from a configuration file.
virtual void exportSettings (const std::string &file)
 Export the current environment to a configuration file.
virtual void restoreDefaultSettings ()
 Handle a request to restore the environment previous settings.
virtual void restoreFactorySettings ()
 Handle a request to restore the environment to factory settings.
virtual void sceneCreated ()
 Handle if the scene (and thus environment) has been created (or re-created)
virtual void atmosphericParametersChanged ()
 Handle any atmospheric change.
virtual void precipitationSettingsChanged ()
 Handle any precipitation change.
virtual void cloudCoverChanged (DtVrfWeatherCloudState cloudCover)
 Handle a change to cloud cover.
virtual void cloudLayerAdded (int index, const DtCloudLayer &clouds)
 Handle when a cloud layer is added.
virtual void addCloudLayer (const DtCloudLayer &clouds)
 Utility to convert the coordinates of the cloud layer then add the cloud layer to the GUI.
virtual void cloudLayerDestroyed (int index)
 Handle when a cloud layer is destroyed.
virtual void cloudLayerChanged (int index, const DtCloudLayer &clouds)
 Handle when a cloud layer is changed.
virtual void fogHeightChanged (float altitude)
 Handle a change to fog ceiling height.
virtual void fogColorChanged (const DtVector &color)
 Handle a change to fog color.
virtual void windSpeedChanged (float speed)
 Handle a change to wind speed.
virtual void windDirectionChanged (float radians)
 Handle a change to wind direction.
virtual void seaStateChanged (unsigned int state)
 Handle a change to sea state.
virtual void seaStateDirectionChanged (float radians)
 Handle a change to sea state direction.
virtual void windDrivenSeaStateChanged (bool enabled)
 Handle a change to the wind-driven sea state flag.
virtual void swellStateChanged (unsigned int state)
 Handle a change to swell state.
virtual void swellStateDirectionChanged (float radians)
 Handle a change to swell state direction.
virtual void windFetchChanged (float distance)
 Handle a change to wind fetch.
virtual void seaChoppinessChanged (float chop)
 Handle a change to sea choppiness.
virtual void underwaterVisibilityEnabledChanged (bool enable)
 Handle a change to whether underwater visibility is used.
virtual void underwaterVisibilityChanged (double distance)
 Handle a change to underwater visibility.
virtual void waterSurfaceTransparencyChanged (double transparency)
 Handle a change to coastal-water transparency.
virtual void surgeDepthChanged (double depth)
 Handle a change to surge depth.
virtual void depthOffsetChanged (double offset)
 Handle a change to the depth offset.
virtual void tidalCurrentSpeedChanged (double speed)
 Handle if the scene (and thus environment) has been created (or re-created)
virtual void tidalCurrentDirectionChanged (double direction)
 Handle if the scene (and thus environment) has been created (or re-created)
virtual void displayUnitsChanged (int type, int unit)
 Handle a change to displayed units.
virtual void onSaveEnvironmentConditions (const DtUnicode &name)
 Handle when the current environment condition should be saved.
virtual void onSetDefaultEnvironmentConditions (const DtUnicode &name)
 Handle when a default environment condition should be set.
virtual void onRequestNewCloudLayer ()
 Handle a request to add a new cloud layer.
virtual void onAddNewCloudLayer (const DtCloudLayer &clouds)
 Handle a request to add a new cloud layer.
virtual void onRequestedEditCloudLayer (int index)
 Handle a request to edit cloud layer.
virtual void onChangeCloudLayer (int index, const DtCloudLayer &clouds)
 Handle a change to an existing cloud layer.
virtual void onDeleteCloudLayer (int index)
 Handle a request to delete cloud layer.
virtual void onEnableCloudLayer (unsigned int index, bool enabled)
 Handle a change to enable/disable a cloud layer.
virtual void onChangeFogHeight (double height)
virtual void onChangeFogColor (double red, double green, double blue)
 Handle a change to fog color.
virtual void onChangeUnderWaterVisibilityEnabled (bool enable)
 Handle a change to the underwater visibility enabled state.
virtual void onChangeWindFetch (double distance)
 Handle a change to the ocean fetch.
virtual void onChangeDepthOffset (double offset)
 Handle a change to the depth offset.
virtual void onChangeTidalCurrentSpeed (double speed)
virtual void onChangeTidalCurrentDirection (double direction)
virtual void onChangeRemoteSettings (bool enable)
virtual void onRequestRemoteSettings ()
 Handle a request for remote weather update.

Additional Inherited Members

- Protected Attributes inherited from makVrv::DtEnvironmentConditionsLogic
DtDemyDe
DtSignalConnectionManager mySignals
DtEnvironmentInterfacemyEnvironment
DtEnvironmentConditionsInterfacemyInterface
DtPersistenceControlsInterfacemyPersistenceInterface

Detailed Description

Logic class for the DtVrfEnvironmentConditionsWeatherWidget.

Constructor & Destructor Documentation

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

CTOR.

makVrf::DtVrfEnvironmentConditionsWeatherLogic::~DtVrfEnvironmentConditionsWeatherLogic ( )

DTOR.

Member Function Documentation

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeCloudCover ( DtVrfWeatherCloudState  cloudCover)
protectedvirtual

Handle a change to the cloud cover combo box.

Parameters
[in]enumerationof the cloud state

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeWindSpeed ( double  speed)
protectedvirtual

Handle a change to wind speed.

Parameters
[in]nameis the name of the environment condition.
[in]speedis the speed of the wind (in commanded units).

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeWindDirection ( double  degree)
protectedvirtual

Handle a change to wind direction.

Parameters
[in]nameis the name of the environment condition.
[in]degreeis the direction of the wind.

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangePrecipitationType ( int  type)
protectedvirtual

Handle a change to precipitation type.

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

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangePrecipitationIntensity ( double  value)
protectedvirtual

Handle a change to precipitation intensity.

Parameters
[in]nameis the name of the environment condition.
[in]valueis the intensity of precipitation (0.0 - 100.0).

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeVisibility ( double  distance)
protectedvirtual

Handle a change to visibility.

Parameters
[in]nameis the name of the environment condition.
[in]distanceis the visible distance (in commanded units).

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeSwellState ( int  index)
protectedvirtual

Handle a change to swell state.

Parameters
[in]nameis the name of the environment condition.
[in]indexis the index of the sea-swell.

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeSwellStateDirection ( double  degree)
protectedvirtual

Handle a change to swell state direction.

Parameters
[in]nameis the name of the environment condition.
[in]degreeis the direction of the sea-swell.

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onEnableWindDrivenSeaState ( bool  enabled)
protectedvirtual

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

Parameters
[in]nameis the name of the environment condition.
[in]enabledis the flag for wind-driven sea-state.

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeSeaState ( int  index)
protectedvirtual

Handle a change to sea-state.

Parameters
[in]nameis the name of the environment condition.
[in]indexis the index of the sea-state.

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeSeaStateDirection ( double  degree)
protectedvirtual

Handle a change to sea-state direction.

Parameters
[in]nameis the name of the environment condition.
[in]degreeis the direction of the sea-state.

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeSeaSurfaceTransparency ( double  alpha)
protectedvirtual

Handle a change to surface transparency.

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

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeUnderWaterVisibility ( double  distance)
protectedvirtual

Handle a change to the underwater visibility distance.

Parameters
[in]nameis the name of the environment condition.
[in]distanceis the visible distance underwater.

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeSeaChoppiness ( double  chop)
protectedvirtual

Handle a change to the water surface choppiness.

Parameters
[in]nameis the name of the environment condition.
[in]chopis the amount of choppiness (0.0 - 1.0).

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onChangeSurgeDepth ( double  distance)
protectedvirtual

Handle a change to the surge depth.

Parameters
[in]nameis the name of the environment condition.
[in]distanceis the is the distance for surge depth.

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onSelectEnvironmentConditions ( const makVrv::DtUnicode name)
protectedvirtual

Handle an environment condition selection change.

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

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::sendChangeGlobalWeatherCommandForCurrentValues ( )
protectedvirtual

Sends a DtChangeGlobalWeatherCommand for all the current values.

Called by onSelectEnvironmentConditions.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::sendEnvironmentToGUI ( )
protectedvirtual

Populate the widget with current environment settings.

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onAddEnvironmentConditions ( const makVrv::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 from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::onRemoveEnvironmentConditions ( const makVrv::DtUnicode name)
protectedvirtual

Handle when a environment condition should be removed.

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

Reimplemented from makVrv::DtEnvironmentConditionsLogic.

virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::sendEnvironmentConditionsToGUI ( )
protectedvirtual
virtual void makVrf::DtVrfEnvironmentConditionsWeatherLogic::updateWeatherConditions ( )
protectedvirtual

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

Document ID: Generated on Wed Jul 29 00:55:00 EDT 2015 from SVN revision 155257
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)