makVrv::DtEnvironmentConditionsInterface Class Reference

An abstract interface for a weather condition settings widget. More...

Inheritance diagram for makVrv::DtEnvironmentConditionsInterface:

Public Types
typedef std::list< DtUnicode >	StringList

Public Member Functions
	DtEnvironmentConditionsInterface (DtDe &de)
	Initialization CTOR.
virtual	~DtEnvironmentConditionsInterface ()
	Virtual DTOR.
Environment condition field value setters.
Sets the values of the widget's corresponding environment fields.
virtual void	setEnvironmentConditionsNames (const StringList &names)=0
	Set the list of environment condition names.
virtual StringList	environmentConditionNames () const =0
	Get the list of environment conditions names.
virtual void	setDefaultConditionName (const DtUnicode &name)=0
	Set the name of the default environment condition.
virtual void	setAdvanceConditionsVisible (bool show)=0
	Show or hide the sections for advanced conditions.
Weather field value setters.
Sets the values of the widget's corresponding weather fields.
virtual void	setWindSpeed (double speed)=0
	Set the wind speed.
virtual void	setWindSpeedDecimals (int decimals)=0
	Set the wind speed decimal places.
virtual void	setWindSpeedUnits (const DtUnicode &units)=0
	Set the wind speed units.
virtual void	setWindSpeedRange (double step, double max, double min=0.0)=0
	Set the maximum and minimum range for wind speed.
virtual void	setWindDirection (double degrees)=0
	Set the wind direction.
virtual void	setPrecipitationType (unsigned int type)=0
	Set the precipitation type.
virtual void	setPrecipitationIntensity (double intensity)=0
	Set the precipitation intensity.
virtual void	setVisibleDistance (double distance)=0
	Set the visible distance.
virtual void	setVisibleDistanceDecimals (int decimals)=0
	Set the visible distance decimal places.
virtual void	setVisibleDistanceUnits (const DtUnicode &units)=0
	Set the visible distance units.
virtual void	setVisibleDistanceRange (double step, double max, double min=0.0)=0
	Set the maximum and minimum range for visible distance.
Advanced weather field value setters.
Sets the values of the widget's corresponding weather fields.
virtual void	addCloudLayer (const DtUnicode &type, const DtUnicode &xLocation, const DtUnicode &yLocation, const DtUnicode &altitude, bool enabled, bool infinite)=0
	Add a cloud layer to the weather condition.
virtual void	setCloudLayer (unsigned int index, const DtUnicode &type, const DtUnicode &xLocation, const DtUnicode &yLocation, const DtUnicode &altitude, bool enabled, bool infinite)=0
	Modify a cloud layer in the weather condition.
virtual void	removeAllCloudLayers ()=0
	Remove all cloud layers from the weather condition.
virtual void	removeCloudLayer (unsigned int index)=0
	Remove a cloud layer from the by index.
virtual void	setCloudLayerEnabled (unsigned int index, bool enabled)=0
	Set whether a cloud layer is enabled for or disable from display.
virtual void	setCloudCover (DtVrfWeatherCloudState cloudCover)=0
	Set the NOAA cloud cover type.
virtual void	setAxisLabels (const DtUnicode &x, const DtUnicode &y, const DtUnicode &z)=0
	Set the cloud type and axis header-labels for the cloud layers.
virtual void	queryUserForNewCloudLayer ()=0
	Query the user for a new cloud layer.
virtual void	queryUserToEditCloudLayer (unsigned int index)=0
	Query the user to edit the currently selected cloud layer.
virtual void	setFogHeight (double height)=0
	Set the height (or ceiling) of the fog layer.
virtual void	setFogHeightDecimals (int decimals)=0
	Set the fog height decimal places.
virtual void	setFogHeightUnits (const DtUnicode &units)=0
	Set the fog height units.
virtual void	setFogHeightRange (double step, double max, double min=0.0)=0
	Set the maximum and minimum range for fog height.
virtual void	setFogColor (double red, double green, double blue)=0
	Set the color of the fog layer.
virtual void	setAirTurbidity (double turbidity)=0
	Set the turbidity of the air.
Marine field value setters.
Sets the values of the widget's corresponding marine fields.
virtual void	setSwellStateNames (const StringList &names)=0
	Set the list of swell state names.
virtual StringList	swellStateNames () const =0
	Get the list of swell state names.
virtual void	setSwellState (unsigned int index)=0
	Set the current swell state by index.
virtual void	setSwellState (const DtUnicode &name)=0
	Set the current sea-swell state by name.
virtual void	setSwellStateDirection (double degrees)=0
	Set the current sea-swell direction.
virtual void	enableWindDrivenSeaState (bool enable)=0
	Set the enabled state of wind-driven sea-state.
virtual void	setSeaStateNames (const StringList &names)=0
	Set the list of sea-state names.
virtual StringList	seaStateNames () const =0
	Get the list of sea-state names.
virtual void	setSeaState (unsigned int index)=0
	Set the current sea-state by index.
virtual void	setSeaState (const DtUnicode &name)=0
	Set the current sea-state by name.
virtual void	setSeaStateDirection (double degrees)=0
	Set the current sea-state direction.
Advanced marine field value setters.
Sets the values of the widget's corresponding advanced marine fields.
virtual void	setSurfaceTransparency (double alpha)=0
	Set the surface transparency of the water.
virtual void	setUnderwaterVisibility (double distance)=0
	Set the underwater visibility distance.
virtual void	setUnderwaterVisibilityDecimals (int decimals)=0
	Set the underwater visible distance decimal places.
virtual void	setUnderwaterVisibilityUnits (const DtUnicode &units)=0
	Set the underwater visible distance units.
virtual void	setUnderwaterVisibilityRange (double step, double max, double min=0.0)=0
	Set the maximum and minimum range for underwater visibility.
virtual void	setWaterChoppiness (double chop)=0
	Set the surface choppiness of the water.
virtual void	setWindFetch (double distance)=0
	Set the sea wave fetch.
virtual void	setWindFetchDecimals (int decimals)=0
	Set the sea wave fetch decimal places.
virtual void	setWindFetchUnits (const DtUnicode &units)=0
	Set the sea wave fetch units.
virtual void	setWindFetchRange (double step, double max, double min=0.0)=0
	Set the maximum and minimum range for sea fetch.
virtual void	setSurgeDepth (double depth)=0
	Set the surge depth.
virtual void	setDepthOffset (double offset)=0
	Set the depth offset.
virtual void	setTidalCurrentSpeedDecimals (int decimals)=0
	Set the tidal stream current speed decimal places.
virtual void	setTidalCurrentSpeedUnits (const DtUnicode &units)=0
	Set the tidal stream current speed units.
virtual void	setTidalCurrentSpeedRange (double step, double max, double min=0.0)=0
	Set the maximum and minimum range for tidal stream current speed.
virtual void	setTidalCurrentSpeed (double speed)=0
	Set the tidal stream current speed.
virtual void	setTidalCurrentDirectionDecimals (int decimals)=0
	Set the tidal stream current direction decimal places.
virtual void	setTidalCurrentDirectionUnits (const DtUnicode &units)=0
	Set the tidal stream current direction units.
virtual void	setTidalCurrentDirectionRange (double step, double max, double min=0.0)=0
	Set the maximum and minimum range for tidal stream current direction.
virtual void	setTidalCurrentDirection (double direction)=0
	Set the tidal stream current direction.
Field value setters for a listening to remote weather.
virtual void	setListenToRemoteWeather (bool enable)=0
	Sets whether or not to list to simulated weather messages.

Public Attributes
Field value update signals.
Signals emitted when widget has updated values.
boost::signal< void(const DtUnicode &)>	signal_selectEnvironmentConditions
boost::signal< void(const DtUnicode &)>	signal_addEnvironmentConditions
boost::signal< void(const DtUnicode &)>	signal_removeEnvironmentConditions
boost::signal< void(const DtUnicode &)>	signal_saveEnvironmentConditions
boost::signal< void(const DtUnicode &)>	signal_setDefaultEnvironmentConditions
boost::signal< void(double)>	signal_changeWindSpeed
boost::signal< void(double)>	signal_changeWindDirection
boost::signal< void(int)>	signal_changePrecipitationType
boost::signal< void(double)>	signal_changePrecipitationIntensity
boost::signal< void(double)>	signal_changeVisibility
boost::signal< void(DtVrfWeatherCloudState)>	signal_cloudCoverChanged
boost::signal< void()>	signal_requestNewCloudLayer
boost::signal< void(const DtCloudLayer &)>	signal_addNewCloudLayer
boost::signal< void(unsigned int)>	signal_requestedEditCloudLayer
boost::signal< void(unsigned int, const DtCloudLayer &)>	signal_changeCloudLayer
boost::signal< void(unsigned int)>	signal_deleteCloudLayer
boost::signal< void(unsigned int, bool)>	signal_enableCloudLayer
boost::signal< void(double)>	signal_changeFogHeight
boost::signal< void(double, double, double)>	signal_changeFogColor
boost::signal< void(double)>	signal_changeAirTurbidity
boost::signal< void(unsigned int)>	signal_changeSwellState
boost::signal< void(double)>	signal_changeSwellStateDirection
boost::signal< void(bool)>	signal_enableWindDrivenSeaState
boost::signal< void(unsigned int)>	signal_changeSeaState
boost::signal< void(double)>	signal_changeSeaStateDirection
boost::signal< void(double)>	signal_changeSeaSurfaceTransparency
boost::signal< void(double)>	signal_changeUnderWaterVisibility
boost::signal< void(double)>	signal_changeSeaChoppiness
boost::signal< void(double)>	signal_changeWindFetch
boost::signal< void(double)>	signal_changeSurgeDepth
boost::signal< void(double)>	signal_changeDepthOffset
boost::signal< void(double)>	signal_changeTidalCurrentSpeed
boost::signal< void(double)>	signal_changeTidalCurrentDirection
boost::signal< void(bool)>	signal_changeRemoteSettings
boost::signal< void()>	signal_requestRemoteSettings

Protected Attributes
DtDe &	myDe

Detailed Description

An abstract interface for a weather condition settings widget.

Member Typedef Documentation

typedef std::list<DtUnicode> makVrv::DtEnvironmentConditionsInterface::StringList

Constructor & Destructor Documentation

makVrv::DtEnvironmentConditionsInterface::DtEnvironmentConditionsInterface

(

DtDe &

de

)

Initialization CTOR.

Parameters

[in]

de

is the display engine.

virtual makVrv::DtEnvironmentConditionsInterface::~DtEnvironmentConditionsInterface ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtEnvironmentConditionsInterface::setEnvironmentConditionsNames ( const StringList &  names )

pure virtual

Set the list of environment condition names.

Parameters

[in]

names

is the list of environment condition names.

virtual StringList makVrv::DtEnvironmentConditionsInterface::environmentConditionNames ( ) const

pure virtual

Get the list of environment conditions names.

Returns

the list of environment condition names.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setDefaultConditionName ( const DtUnicode &  name )

pure virtual

Set the name of the default environment condition.

Parameters

[in]

name

is the name of the default condition.

Implemented in makVrv::DtEnvironmentConditionsWidget, and makVrf::DtVrfEnvironmentConditionsWeatherWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setAdvanceConditionsVisible ( bool  show )

pure virtual

Show or hide the sections for advanced conditions.

Parameters

[in]

show

is the flag to show or hide advanced conditions.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWindSpeed ( double  speed )

pure virtual

Set the wind speed.

Parameters

[in]

speed

is the wind speed to set.

See Also

setWindSpeedDecimals(int)

setWindSpeedUnits(const DtUnicode&)

setWindSpeed(double, double, double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWindSpeedDecimals ( int  decimals )

pure virtual

Set the wind speed decimal places.

Parameters

[in]

decimals

is the number of decimals to display.

See Also

setWindSpeed(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWindSpeedUnits ( const DtUnicode &  units )

pure virtual

Set the wind speed units.

Parameters

[in]

units

is the unit type to display.

See Also

setWindSpeed(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWindSpeedRange ( double  step, double  max, double  min = 0.0  )

pure virtual

Set the maximum and minimum range for wind speed.

Parameters

[in]	step	is the default step through the range.
[in]	max	is the maximum range boundary.
[in]	min	is the minimum range boundary.

See Also

setWindSpeed(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWindDirection ( double  degrees )

pure virtual

Set the wind direction.

Parameters

[in]

degrees

is the wind direction in degrees.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setPrecipitationType ( unsigned int  type )

pure virtual

Set the precipitation type.

Parameters

[in]

type

is the type of precipitation type.

Note

None, Rain or Snow defined in DtEnvironmentRecord.

Implemented in makVrv::DtEnvironmentConditionsWidget, and makVrf::DtVrfEnvironmentConditionsWeatherWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setPrecipitationIntensity ( double  intensity )

pure virtual

Set the precipitation intensity.

Parameters

[in]

intensity

is the precipitation intensity from zero to one.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setVisibleDistance ( double  distance )

pure virtual

Set the visible distance.

Parameters

[in]

distance

is the visible distance.

See Also

setVisibleDistanceDecimals(int)

setVisibleDistanceUnits(const DtUnicode&)

setVisibleDistanceRange(double, double, double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setVisibleDistanceDecimals ( int  decimals )

pure virtual

Set the visible distance decimal places.

Parameters

[in]

decimals

is the number of decimals to display.

See Also

setVisibleDistance(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setVisibleDistanceUnits ( const DtUnicode &  units )

pure virtual

Set the visible distance units.

Parameters

[in]

units

is the unit type to display.

See Also

setVisibleDistance(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setVisibleDistanceRange ( double  step, double  max, double  min = 0.0  )

pure virtual

Set the maximum and minimum range for visible distance.

Parameters

[in]	step	is the default step through the range.
[in]	max	is the maximum range boundary.
[in]	min	is the minimum range boundary.

See Also

setVisibleDistance(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::addCloudLayer ( const DtUnicode &  type, const DtUnicode &  xLocation, const DtUnicode &  yLocation, const DtUnicode &  altitude, bool  enabled, bool  infinite  )

pure virtual

Add a cloud layer to the weather condition.

Parameters

[in]	type	is the type of clouds.
[in]	xLocation	is the x coordinate of the cloud layer.
[in]	yLocation	is the y coordinate of the cloud layer.
[in]	altitude	is the altitude of the cloud layer.
[in]	enabled	is the flag to display or hide the cloud layer.
[in]	infinite	is the flag to extend the limits cloud layer.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setCloudLayer ( unsigned int  index, const DtUnicode &  type, const DtUnicode &  xLocation, const DtUnicode &  yLocation, const DtUnicode &  altitude, bool  enabled, bool  infinite  )

pure virtual

Modify a cloud layer in the weather condition.

Parameters

[in]	index	is the index of the cloud layer.
[in]	type	is the type of clouds.
[in]	xLocation	is the x coordinate of the cloud layer.
[in]	yLocation	is the y coordinate of the cloud layer.
[in]	altitude	is the altitude of the cloud layer.
[in]	enabled	is the flag to display or hide the cloud layer.
[in]	infinite	is the flag to extend the limits cloud layer.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::removeAllCloudLayers ( )

pure virtual

Remove all cloud layers from the weather condition.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::removeCloudLayer ( unsigned int  index )

pure virtual

Remove a cloud layer from the by index.

Parameters

[in]

index

is the index of the cloud layer.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setCloudLayerEnabled ( unsigned int  index, bool  enabled  )

pure virtual

Set whether a cloud layer is enabled for or disable from display.

Parameters

[in]	index	is the index of the cloud layer.
[in]	enabled	is the flag to display or hide the cloud layer.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setCloudCover ( DtVrfWeatherCloudState  cloudCover )

pure virtual

Set the NOAA cloud cover type.

Parameters

[in]

The

NOAA cloud cover to use

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setAxisLabels ( const DtUnicode &  x, const DtUnicode &  y, const DtUnicode &  z  )

pure virtual

Set the cloud type and axis header-labels for the cloud layers.

Parameters

[in]	x	is the x coordinate header-label.
[in]	y	is the y coordinate header-label.
[in]	z	is the z coordinate header-label.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::queryUserForNewCloudLayer ( )

pure virtual

Query the user for a new cloud layer.

Note

Pops up a dialog for filling out a new cloud layer.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::queryUserToEditCloudLayer ( unsigned int  index )

pure virtual

Query the user to edit the currently selected cloud layer.

Note

Pops up a pre-filled dialog for editing the cloud layer.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setFogHeight ( double  height )

pure virtual

Set the height (or ceiling) of the fog layer.

Parameters

[in]

height

is the height of the fog layer.

See Also

setFogHeightDecimals(int)

setFogHeightUnits(const DtUnicode&)

setFogHeightRange(double, double, double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setFogHeightDecimals ( int  decimals )

pure virtual

Set the fog height decimal places.

Parameters

[in]

decimals

is the number of decimals to display.

See Also

setFogHeight(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setFogHeightUnits ( const DtUnicode &  units )

pure virtual

Set the fog height units.

Parameters

[in]

units

is the unit type to display.

See Also

setFogHeight(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setFogHeightRange ( double  step, double  max, double  min = 0.0  )

pure virtual

Set the maximum and minimum range for fog height.

Parameters

[in]	step	is the default step through the range.
[in]	max	is the maximum range boundary.
[in]	min	is the minimum range boundary.

See Also

setFogHeight(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setFogColor ( double  red, double  green, double  blue  )

pure virtual

Set the color of the fog layer.

Parameters

[in]	red	is a normalized color component from 0.0 to 1.0.
[in]	green	is a normalized color component from 0.0 to 1.0.
[in]	blue	is a normalized color component from 0.0 to 1.0.

See Also

setFogColor(int, int, int)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setAirTurbidity ( double  turbidity )

pure virtual

Set the turbidity of the air.

Parameters

[in]

turbidity

is the intensity of air turbidity (0.0 to 1.0).

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSwellStateNames ( const StringList &  names )

pure virtual

Set the list of swell state names.

Parameters

[in]

names

is the list of sea-swell names.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual StringList makVrv::DtEnvironmentConditionsInterface::swellStateNames ( ) const

pure virtual

Get the list of swell state names.

Returns

the list of swell state names.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSwellState ( unsigned int  index )

pure virtual

Set the current swell state by index.

Parameters

[in]

index

is the swell state in swell state names.

See Also

void setSwellStateNames(const StringList&)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSwellState ( const DtUnicode &  name )

pure virtual

Set the current sea-swell state by name.

Parameters

[in]

name

is the name of the sea-swell state.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSwellStateDirection ( double  degrees )

pure virtual

Set the current sea-swell direction.

Parameters

[in]

degrees

is the sea-swell direction

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::enableWindDrivenSeaState ( bool  enable )

pure virtual

Set the enabled state of wind-driven sea-state.

Parameters

[in]

enable

is the enable flag for wind-driven sea-state.

Note

Setting to true should cause sea-state to be wind driven, while resetting to false should cause sea-state to be manual driven.

Implemented in makVrv::DtEnvironmentConditionsWidget, and makVrf::DtVrfEnvironmentConditionsWeatherWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSeaStateNames ( const StringList &  names )

pure virtual

Set the list of sea-state names.

Parameters

[in]

names

is the list of sea-state names.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual StringList makVrv::DtEnvironmentConditionsInterface::seaStateNames ( ) const

pure virtual

Get the list of sea-state names.

Returns

the list of sea-state names.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSeaState ( unsigned int  index )

pure virtual

Set the current sea-state by index.

Parameters

[in]

index

is the index of the sea-state in sea-state names.

See Also

void setSeaStateNames(const StringList&).

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSeaState ( const DtUnicode &  name )

pure virtual

Set the current sea-state by name.

Parameters

[in]

name

is the name of the sea-state.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSeaStateDirection ( double  degrees )

pure virtual

Set the current sea-state direction.

Parameters

[in]

degrees

is the sea-state direction

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSurfaceTransparency ( double  alpha )

pure virtual

Set the surface transparency of the water.

Parameters

[in]

alpha

is the transparency value (0.0 to 1.0).

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setUnderwaterVisibility ( double  distance )

pure virtual

Set the underwater visibility distance.

Parameters

[in]

distance

is the visible distance underwater.

See Also

setUnderwaterVisibilityDecimals(int)

setUnderwaterVisibilityUnits(const DtUnicode&)

setUnderwaterVisibilityRange(double, double, double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setUnderwaterVisibilityDecimals ( int  decimals )

pure virtual

Set the underwater visible distance decimal places.

Parameters

[in]

decimals

is the number of decimals to display.

See Also

setUnderwaterVisibility(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setUnderwaterVisibilityUnits ( const DtUnicode &  units )

pure virtual

Set the underwater visible distance units.

Parameters

[in]

units

is the unit type to display.

See Also

setUnderwaterVisibility(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setUnderwaterVisibilityRange ( double  step, double  max, double  min = 0.0  )

pure virtual

Set the maximum and minimum range for underwater visibility.

Parameters

[in]	step	is the default step through the range.
[in]	max	is the maximum range boundary.
[in]	min	is the minimum range boundary.

See Also

setUnderwaterVisibility(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWaterChoppiness ( double  chop )

pure virtual

Set the surface choppiness of the water.

Parameters

[in]

chop

is the intensity of choppiness (0.0 to 1.0).

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWindFetch ( double  distance )

pure virtual

Set the sea wave fetch.

Parameters

[in]

distance

is the distance of fetch.

See Also

setWindFetchDecimals(int)

setWindFetchUnits(const DtUnicode&)

setWindFetchRange(double, double, double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWindFetchDecimals ( int  decimals )

pure virtual

Set the sea wave fetch decimal places.

Parameters

[in]

decimals

is the number of decimals to display.

See Also

setWindFetch(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWindFetchUnits ( const DtUnicode &  units )

pure virtual

Set the sea wave fetch units.

Parameters

[in]

units

is the unit type to display.

See Also

setWindFetch(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setWindFetchRange ( double  step, double  max, double  min = 0.0  )

pure virtual

Set the maximum and minimum range for sea fetch.

Parameters

[in]	step	is the default step through the range.
[in]	max	is the maximum range boundary.
[in]	min	is the minimum range boundary.

See Also

setWindFetch(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setSurgeDepth ( double  depth )

pure virtual

Set the surge depth.

Parameters

[in]

depth

is the surge depth in meters (0.0 - 20.0).

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setDepthOffset ( double  offset )

pure virtual

Set the depth offset.

Parameters

[in]

offset

is the distance for depth offset (0.0 - 1.0).

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setTidalCurrentSpeedDecimals ( int  decimals )

pure virtual

Set the tidal stream current speed decimal places.

Parameters

[in]

decimals

is the number of decimals to display.

See Also

setTidalCurrentSpeed(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setTidalCurrentSpeedUnits ( const DtUnicode &  units )

pure virtual

Set the tidal stream current speed units.

Parameters

[in]

units

is the unit type to display.

See Also

setTidalCurrentSpeed(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setTidalCurrentSpeedRange ( double  step, double  max, double  min = 0.0  )

pure virtual

Set the maximum and minimum range for tidal stream current speed.

Parameters

[in]	step	is the default step through the range.
[in]	max	is the maximum range boundary.
[in]	min	is the minimum range boundary.

See Also

setTidalCurrentSpeed(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setTidalCurrentSpeed ( double  speed )

pure virtual

Set the tidal stream current speed.

Parameters

[in]

speed

is the tidal stream current in meters/second (0.0 - 10.0).

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setTidalCurrentDirectionDecimals ( int  decimals )

pure virtual

Set the tidal stream current direction decimal places.

Parameters

[in]

decimals

is the number of decimals to display.

See Also

setTidalCurrentDirection(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setTidalCurrentDirectionUnits ( const DtUnicode &  units )

pure virtual

Set the tidal stream current direction units.

Parameters

[in]

units

is the unit type to display.

See Also

setTidalCurrentDirection(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setTidalCurrentDirectionRange ( double  step, double  max, double  min = 0.0  )

pure virtual

Set the maximum and minimum range for tidal stream current direction.

Parameters

[in]	step	is the default step through the range.
[in]	max	is the maximum range boundary.
[in]	min	is the minimum range boundary.

See Also

setTidalCurrentDirection(double)

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setTidalCurrentDirection ( double  direction )

pure virtual

Set the tidal stream current direction.

Implemented in makVrv::DtEnvironmentConditionsWidget.

virtual void makVrv::DtEnvironmentConditionsInterface::setListenToRemoteWeather ( bool  enable )

pure virtual

Sets whether or not to list to simulated weather messages.

Parameters

[in]

enable

is the flag to enable/disable listening.

Implemented in makVrv::DtEnvironmentConditionsWidget.

Member Data Documentation

boost::signal<void (const DtUnicode&)> makVrv::DtEnvironmentConditionsInterface::signal_selectEnvironmentConditions

boost::signal<void (const DtUnicode&)> makVrv::DtEnvironmentConditionsInterface::signal_addEnvironmentConditions

boost::signal<void (const DtUnicode&)> makVrv::DtEnvironmentConditionsInterface::signal_removeEnvironmentConditions

boost::signal<void (const DtUnicode&)> makVrv::DtEnvironmentConditionsInterface::signal_saveEnvironmentConditions

boost::signal<void (const DtUnicode&)> makVrv::DtEnvironmentConditionsInterface::signal_setDefaultEnvironmentConditions

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeWindSpeed

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeWindDirection

boost::signal<void (int)> makVrv::DtEnvironmentConditionsInterface::signal_changePrecipitationType

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changePrecipitationIntensity

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeVisibility

boost::signal<void (DtVrfWeatherCloudState)> makVrv::DtEnvironmentConditionsInterface::signal_cloudCoverChanged

boost::signal<void ()> makVrv::DtEnvironmentConditionsInterface::signal_requestNewCloudLayer

boost::signal<void (const DtCloudLayer&)> makVrv::DtEnvironmentConditionsInterface::signal_addNewCloudLayer

boost::signal<void (unsigned int)> makVrv::DtEnvironmentConditionsInterface::signal_requestedEditCloudLayer

boost::signal<void (unsigned int, const DtCloudLayer&)> makVrv::DtEnvironmentConditionsInterface::signal_changeCloudLayer

boost::signal<void (unsigned int)> makVrv::DtEnvironmentConditionsInterface::signal_deleteCloudLayer

boost::signal<void (unsigned int, bool)> makVrv::DtEnvironmentConditionsInterface::signal_enableCloudLayer

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeFogHeight

boost::signal<void (double, double, double)> makVrv::DtEnvironmentConditionsInterface::signal_changeFogColor

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeAirTurbidity

boost::signal<void (unsigned int)> makVrv::DtEnvironmentConditionsInterface::signal_changeSwellState

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeSwellStateDirection

boost::signal<void (bool)> makVrv::DtEnvironmentConditionsInterface::signal_enableWindDrivenSeaState

boost::signal<void (unsigned int)> makVrv::DtEnvironmentConditionsInterface::signal_changeSeaState

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeSeaStateDirection

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeSeaSurfaceTransparency

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeUnderWaterVisibility

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeSeaChoppiness

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeWindFetch

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeSurgeDepth

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeDepthOffset

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeTidalCurrentSpeed

boost::signal<void (double)> makVrv::DtEnvironmentConditionsInterface::signal_changeTidalCurrentDirection

boost::signal<void (bool)> makVrv::DtEnvironmentConditionsInterface::signal_changeRemoteSettings

boost::signal<void ()> makVrv::DtEnvironmentConditionsInterface::signal_requestRemoteSettings

DtDe& makVrv::DtEnvironmentConditionsInterface::myDe

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCoreQt/DtEnvironmentConditionsInterface.h