VR-Forces Development_Version 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 | Protected Attributes
makVrf::DtDisabledEnvironment Class Reference
Inheritance diagram for makVrf::DtDisabledEnvironment:
Inheritance graph
[legend]

Public Member Functions

 DtDisabledEnvironment (makVrv::DtDe &de)
virtual void clear ()
 Clear all clouds, precipitation.
virtual void getRecord (makArchives::DtEnvironmentRecord &record)
 Get the specified environment by record; used to serialize a scene This method throws the exception DtException if the named environment is not found.
virtual void setFromRecord (const makArchives::DtEnvironmentRecord &record)
 Set the startup (last current) environment from record.
virtual void saveEnvironment (const std::string &envName)
 Save the current environment with the current name.
virtual void removeEnvironment (const std::string &envName)
 Remove an environment entry.
virtual void renameEnvironment (const std::string &oldName, const std::string &newName)
 Rename an environment entry.
virtual void getEnvironmentNames (std::vector< std::string > &names)
 Get the names of all the environment conditions.
virtual void setEnvironment (const std::string &envName)
 The current environment takes on the settings of the named env.
virtual void setDefaultEnvironmentName (const std::string &name)
 Set the name of the default environment conditions.
virtual std::string defaultEnvironmentName () const
 Get the name of the default environment conditions.
virtual void setCloudCover (DtVrfWeatherCloudState cloudCover)
 Set/Get which cloud cover to use.
virtual DtVrfWeatherCloudState cloudCover () const
 Save the current environment with the current name.
virtual int cloudLayerCount () const
 Set / Get cloud additional layers.
virtual const
makVrv::DtCloudLayer
cloudLayer (unsigned int layerId) const
 Get the specified cloud layer.
virtual void setCloudLayer (unsigned int layerId, const makVrv::DtCloudLayer &layer)
 Sets the layer specified by layerId to layer, if it exists.
virtual void addCloudLayer (const makVrv::DtCloudLayer &layer)
 Add a cloud layer. (It is enabled by default).
virtual void removeCloudLayer (unsigned int layerId)
 Remove a cloud layer by index.
virtual void removeCloudLayers ()
 Remove all cloud layers for the current environment condition.
virtual void setCloudLayerEnabled (unsigned int layerId, bool enabled)
 Set whether a cloud layer is enabled (visible).
virtual bool useCustomCloudCover () const
 Set/Get whether custom clouds are used.
virtual void setUseCustomCloudCover (bool enabled)
 Set/Get whether custom clouds are used.
virtual void setAirTurbidity (float turbidity)
 Set/Get the air turbidity (haziness)
virtual float airTurbidity () const
 Set/Get the air turbidity (haziness)
virtual void setVisibleDistance (float distance)
 Set/Get the visible distance in meters.
virtual float visibleDistance () const
 Set/Get the visible distance in meters.
virtual void setPrecipitationIntensity (float intensity)
 Set/Get the precipitation intensity.
virtual float precipitationIntensity () const
 Set/Get the precipitation intensity.
virtual void setWindSpeed (float speed)
 Set/Get the wind speed in meters per second.
virtual float windSpeed () const
 Set/Get the wind speed in meters per second.
virtual void setWindDirection (float direction)
 Set/Get the wind direction in radians from north (clockwise).
virtual float windDirection () const
 Set/Get the wind direction in radians from north (clockwise).
virtual void setAmbientAirTemperature (float temperature)
 Set/Get the ambient air temperature in Celsius.
virtual float ambientAirTemperature () const
 Set/Get the ambient air temperature in Celsius.
virtual void setFogHeight (float height)
 Set/Get the fog ceiling height in meters.
virtual float fogHeight () const
 Set/Get the fog ceiling height in meters.
virtual void setFogColor (const DtVector &color)
 Set/Get the fog color in normalized color components.
virtual DtVector fogColor () const
 Set/Get the fog color in normalized color components.
virtual void setSeaState (int state)
 Set/Get the sea state according to the Beaufort Scale.
virtual int seaState () const
 Set/Get the sea state according to the Beaufort Scale.
virtual void setSeaStateDirection (float dir)
 Set/Get the sea state direction in radians from north.
virtual float seaStateDirection () const
 Set/Get the sea state direction in radians from north.
virtual void setWindDrivenSeaState (bool enabled)
 Set/Get if sea state is wind driven or manually driven.
virtual bool windDrivenSeaState () const
 Set/Get if sea state is wind driven or manually driven.
virtual void setSwellState (int state)
 Set/Get the sea-swell state according to the Douglas Scale.
virtual int swellState () const
 Set/Get the sea-swell state according to the Douglas Scale.
virtual void setSwellStateDirection (float dir)
 Set/Get the sea-swell state direction in radians from north.
virtual float swellStateDirection () const
 Set/Get the sea-swell state direction in radians from north.
virtual void setWindFetch (float distance)
 Set/Get the ocean fetch.
virtual float windFetch () const
 Set/Get the ocean fetch.
virtual void setSeaChoppiness (float chop)
 Set/Get the amount of chop on the sea.
virtual float seaChoppiness () const
 Set/Get the amount of chop on the sea.
virtual void setUnderwaterVisibilityEnabled (bool enabled)
virtual bool underwaterVisibilityEnabled () const
virtual void setUnderwaterVisibility (float distance)
 Set/Get the maximum visibility under water in meters.
virtual float underwaterVisibility () const
 Set/Get the maximum visibility under water in meters.
virtual void setWaterSurfaceTransparency (float normalizedValue)
 Set/Get the transparency value of water surface.
virtual float waterSurfaceTransparency () const
 Set/Get the transparency value of water surface.
virtual void setSurgeDepth (float meters)
 Set / Get the surge depth in distance.
virtual float surgeDepth () const
 Set / Get the surge depth in distance.
virtual void setDepthOffset (float meters)
 Set / Get the depth offset in distance.
virtual float depthOffset () const
 Set / Get the depth offset in distance.
virtual void setAmbientWaterTemperature (float temperature)
 Set/Get the ambient water temperature in Celsius.
virtual float ambientWaterTemperature () const
 Set/Get the ambient water temperature in Celsius.
virtual void setWaterCurrentSpeed (float speed)
 Set/Get the speed of water currents in meters per second.
virtual float waterCurrentSpeed () const
 Set/Get the speed of water currents in meters per second.
virtual void setWaterCurrentDirection (float direction)
 Set/Get the direction of water currents in radians from north (clockwise).
virtual float waterCurrentDirection () const
 Set/Get the direction of water currents in radians from north (clockwise).
virtual void setTidalOffset (float meters)
 Set/Get the current tidal offset from mean-sea-level in meters.
virtual float tidalOffset () const
 Set/Get the current tidal offset from mean-sea-level in meters.
virtual void setTidalDirection (bool inOut)
 Set/Get the current direction of tidal flow (0=out, 1=in).
virtual bool tidalDirection () const
 Set/Get the current direction of tidal flow (0=out, 1=in).
virtual void setThermoclineDepth (unsigned int layer, float depth)
 Set/Get the thermocline depths.
virtual float thermoclineDepth (unsigned int layer) const
 Set/Get the thermocline depths.
virtual void setThermoclinePermeability (unsigned int layer, float permeability)
 Set/Get the thermocline permeability.
virtual float thermoclinePermeability (unsigned int layer) const
 Set/Get the thermocline permeability.
virtual void loadDefaults (bool loadOnlyFactorySettings=false)
virtual void restore ()
virtual void saveAsDefaults ()
virtual void exportSettings (const std::string &filename)
 Import / export the list of named conditions.
virtual void importSettings (const std::string &filename)
 Import / export the list of named conditions.
virtual void setPrecipitationType (PrecipitationType type)
 These are implemented because they're required by DtEnvironmentConditionsLogic::onChangePrecipitationType.
virtual PrecipitationType precipitationType () const
 These are implemented because they're required by DtEnvironmentConditionsLogic::onChangePrecipitationType.
- Public Member Functions inherited from makVrv::DtEnvironmentInterface
 DtEnvironmentInterface ()
 CTOR.
virtual ~DtEnvironmentInterface ()
 Virtual DTOR.

Protected Member Functions

virtual void slot_coordinateSystemChanged ()
 \name Slots for handling changes in the simulation.
virtual void slot_oceanLayerAdded (const makVrv::DtOceanLayer &layer)
 Handle an ocean layer being added.
virtual void slot_oceanLayerToBeDeleted (const makVrv::DtOceanLayer &layer)
 Handle an ocean layer being removed.
virtual void slot_oceanLayerSeaLevelChanged (const makVrv::DtOceanLayer &layer, double seaLevel)
 Handle a change to an ocean layer's sea level.
virtual void slot_oceanLayerLodRangeChanged (const makVrv::DtOceanLayer &layer, int range)
 Handle a change to an ocean layer's lod range.
virtual void slot_surgeDepthChanged (double depth)
 Handle a change to surge depth.
virtual void slot_depthOffsetChanged (double offset)
 Handle a change to depth offset.

Protected Attributes

makVrv::DtCloudLayer myCloudLayer
makVrv::DtEnvironmentInterface::PrecipitationType myPrecipitationType
makVrv::DtDemyDe
makArchives::DtEnvironmentRecord myCurrentSettings
 This is an env record that reflects our current settings.
makVrv::DtEnvironmentList myEnvironmentList

Additional Inherited Members

- Public Types inherited from makVrv::DtEnvironmentInterface
enum  PrecipitationType { None = DtSkyObject::None, Rain = DtSkyObject::Rain, Snow = DtSkyObject::SnowWet }

Constructor & Destructor Documentation

makVrf::DtDisabledEnvironment::DtDisabledEnvironment ( makVrv::DtDe de)
inline

Member Function Documentation

virtual void makVrf::DtDisabledEnvironment::clear ( )
inlinevirtual

Clear all clouds, precipitation.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::getRecord ( makArchives::DtEnvironmentRecord record)
inlinevirtual

Get the specified environment by record; used to serialize a scene This method throws the exception DtException if the named environment is not found.

Implements makVrv::DtEnvironmentInterface.

References myCurrentSettings.

virtual void makVrf::DtDisabledEnvironment::setFromRecord ( const makArchives::DtEnvironmentRecord record)
inlinevirtual

Set the startup (last current) environment from record.

Implements makVrv::DtEnvironmentInterface.

References myCurrentSettings.

Referenced by setEnvironment().

virtual void makVrf::DtDisabledEnvironment::saveEnvironment ( const std::string &  envName)
inlinevirtual

Save the current environment with the current name.

If an environment with that name does not exist, add a new environment entry.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::removeEnvironment ( const std::string &  envName)
inlinevirtual

Remove an environment entry.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::renameEnvironment ( const std::string &  oldName,
const std::string &  newName 
)
inlinevirtual

Rename an environment entry.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::getEnvironmentNames ( std::vector< std::string > &  names)
inlinevirtual

Get the names of all the environment conditions.

Implements makVrv::DtEnvironmentInterface.

References makVrv::DtScene::environment(), makVrv::DtEnvironment::getEnvironmentNames(), myDe, and makVrv::DtDe::scene().

virtual void makVrf::DtDisabledEnvironment::setEnvironment ( const std::string &  envName)
inlinevirtual

The current environment takes on the settings of the named env.

Implements makVrv::DtEnvironmentInterface.

References makVrv::DtEnvironmentList::getEnvironment(), myEnvironmentList, and setFromRecord().

virtual void makVrf::DtDisabledEnvironment::setDefaultEnvironmentName ( const std::string &  name)
inlinevirtual

Set the name of the default environment conditions.

Parameters
[in]nameis the name of the default environment.

Implements makVrv::DtEnvironmentInterface.

virtual std::string makVrf::DtDisabledEnvironment::defaultEnvironmentName ( ) const
inlinevirtual

Get the name of the default environment conditions.

Returns
The name of the default environment.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setCloudCover ( DtVrfWeatherCloudState  cloudCover)
inlinevirtual

Set/Get which cloud cover to use.

This chooses one of the NOAA-defined cloud conditions. cloudCover is one of: DtVrfWeatherCloudStateClear DtVrfWeatherCloudStateMostlyClear DtVrfWeatherCloudStateCloudy DtVrfWeatherCloudStatePartlyCloudy DtVrfWeatherCloudStateMostlyCloudy DtVrfWeatherCloudStateOvercast DtVrfWeatherCloudStateThunderstorm

Implements makVrv::DtEnvironmentInterface.

virtual DtVrfWeatherCloudState makVrf::DtDisabledEnvironment::cloudCover ( ) const
inlinevirtual

Save the current environment with the current name.

If an environment with that name does not exist, add a new environment entry.

Implements makVrv::DtEnvironmentInterface.

References DtVrfWeatherCloudStateClear.

virtual int makVrf::DtDisabledEnvironment::cloudLayerCount ( ) const
inlinevirtual

Set / Get cloud additional layers.

Get a count of the current cloud layers in the environment

Implements makVrv::DtEnvironmentInterface.

virtual const makVrv::DtCloudLayer& makVrf::DtDisabledEnvironment::cloudLayer ( unsigned int  layerId) const
inlinevirtual

Get the specified cloud layer.

Throws DtException if the layerId >= cloudLayerCount()

Implements makVrv::DtEnvironmentInterface.

References myCloudLayer.

virtual void makVrf::DtDisabledEnvironment::setCloudLayer ( unsigned int  layerId,
const makVrv::DtCloudLayer layer 
)
inlinevirtual

Sets the layer specified by layerId to layer, if it exists.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::addCloudLayer ( const makVrv::DtCloudLayer layer)
inlinevirtual

Add a cloud layer. (It is enabled by default).

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::removeCloudLayer ( unsigned int  layerId)
inlinevirtual

Remove a cloud layer by index.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::removeCloudLayers ( )
inlinevirtual

Remove all cloud layers for the current environment condition.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setCloudLayerEnabled ( unsigned int  layerId,
bool  enabled 
)
inlinevirtual

Set whether a cloud layer is enabled (visible).

This is a wrapper for getting a layer, setting its enabled flag, and then calling setCloudLayer with the modified layer

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtDisabledEnvironment::useCustomCloudCover ( ) const
inlinevirtual

Set/Get whether custom clouds are used.

Note
Not supported in 1.6

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setUseCustomCloudCover ( bool  enabled)
inlinevirtual

Set/Get whether custom clouds are used.

Note
Not supported in 1.6

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setAirTurbidity ( float  turbidity)
inlinevirtual

Set/Get the air turbidity (haziness)

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::airTurbidity ( ) const
inlinevirtual

Set/Get the air turbidity (haziness)

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setVisibleDistance ( float  distance)
inlinevirtual

Set/Get the visible distance in meters.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::visibleDistance ( ) const
inlinevirtual

Set/Get the visible distance in meters.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setPrecipitationType ( PrecipitationType  type)
inlinevirtual

These are implemented because they're required by DtEnvironmentConditionsLogic::onChangePrecipitationType.

Implements makVrv::DtEnvironmentInterface.

References myPrecipitationType.

virtual PrecipitationType makVrf::DtDisabledEnvironment::precipitationType ( ) const
inlinevirtual

These are implemented because they're required by DtEnvironmentConditionsLogic::onChangePrecipitationType.

Implements makVrv::DtEnvironmentInterface.

References myPrecipitationType.

virtual void makVrf::DtDisabledEnvironment::setPrecipitationIntensity ( float  intensity)
inlinevirtual

Set/Get the precipitation intensity.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::precipitationIntensity ( ) const
inlinevirtual

Set/Get the precipitation intensity.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setWindSpeed ( float  speed)
inlinevirtual

Set/Get the wind speed in meters per second.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::windSpeed ( ) const
inlinevirtual

Set/Get the wind speed in meters per second.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setWindDirection ( float  direction)
inlinevirtual

Set/Get the wind direction in radians from north (clockwise).

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::windDirection ( ) const
inlinevirtual

Set/Get the wind direction in radians from north (clockwise).

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setAmbientAirTemperature ( float  temperature)
inlinevirtual

Set/Get the ambient air temperature in Celsius.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::ambientAirTemperature ( ) const
inlinevirtual

Set/Get the ambient air temperature in Celsius.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setFogHeight ( float  height)
inlinevirtual

Set/Get the fog ceiling height in meters.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::fogHeight ( ) const
inlinevirtual

Set/Get the fog ceiling height in meters.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setFogColor ( const DtVector color)
inlinevirtual

Set/Get the fog color in normalized color components.

Implements makVrv::DtEnvironmentInterface.

virtual DtVector makVrf::DtDisabledEnvironment::fogColor ( ) const
inlinevirtual

Set/Get the fog color in normalized color components.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setSeaState ( int  state)
inlinevirtual

Set/Get the sea state according to the Beaufort Scale.

Implements makVrv::DtEnvironmentInterface.

virtual int makVrf::DtDisabledEnvironment::seaState ( ) const
inlinevirtual

Set/Get the sea state according to the Beaufort Scale.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setSeaStateDirection ( float  dir)
inlinevirtual

Set/Get the sea state direction in radians from north.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::seaStateDirection ( ) const
inlinevirtual

Set/Get the sea state direction in radians from north.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setWindDrivenSeaState ( bool  enabled)
inlinevirtual

Set/Get if sea state is wind driven or manually driven.

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtDisabledEnvironment::windDrivenSeaState ( ) const
inlinevirtual

Set/Get if sea state is wind driven or manually driven.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setSwellState ( int  state)
inlinevirtual

Set/Get the sea-swell state according to the Douglas Scale.

Implements makVrv::DtEnvironmentInterface.

virtual int makVrf::DtDisabledEnvironment::swellState ( ) const
inlinevirtual

Set/Get the sea-swell state according to the Douglas Scale.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setSwellStateDirection ( float  dir)
inlinevirtual

Set/Get the sea-swell state direction in radians from north.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::swellStateDirection ( ) const
inlinevirtual

Set/Get the sea-swell state direction in radians from north.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setWindFetch ( float  distance)
inlinevirtual

Set/Get the ocean fetch.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::windFetch ( ) const
inlinevirtual

Set/Get the ocean fetch.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setSeaChoppiness ( float  chop)
inlinevirtual

Set/Get the amount of chop on the sea.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::seaChoppiness ( ) const
inlinevirtual

Set/Get the amount of chop on the sea.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setUnderwaterVisibilityEnabled ( bool  enabled)
inlinevirtual

Set / Get underwater visibility enabled.

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtDisabledEnvironment::underwaterVisibilityEnabled ( ) const
inlinevirtual

Set / Get underwater visibility enabled.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setUnderwaterVisibility ( float  distance)
inlinevirtual

Set/Get the maximum visibility under water in meters.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::underwaterVisibility ( ) const
inlinevirtual

Set/Get the maximum visibility under water in meters.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setWaterSurfaceTransparency ( float  normalizedValue)
inlinevirtual

Set/Get the transparency value of water surface.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::waterSurfaceTransparency ( ) const
inlinevirtual

Set/Get the transparency value of water surface.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setSurgeDepth ( float  meters)
inlinevirtual

Set / Get the surge depth in distance.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::surgeDepth ( ) const
inlinevirtual

Set / Get the surge depth in distance.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setDepthOffset ( float  meters)
inlinevirtual

Set / Get the depth offset in distance.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::depthOffset ( ) const
inlinevirtual

Set / Get the depth offset in distance.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setAmbientWaterTemperature ( float  temperature)
inlinevirtual

Set/Get the ambient water temperature in Celsius.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::ambientWaterTemperature ( ) const
inlinevirtual

Set/Get the ambient water temperature in Celsius.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setWaterCurrentSpeed ( float  speed)
inlinevirtual

Set/Get the speed of water currents in meters per second.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::waterCurrentSpeed ( ) const
inlinevirtual

Set/Get the speed of water currents in meters per second.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setWaterCurrentDirection ( float  direction)
inlinevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::waterCurrentDirection ( ) const
inlinevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setTidalOffset ( float  meters)
inlinevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::tidalOffset ( ) const
inlinevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setTidalDirection ( bool  inOut)
inlinevirtual

Set/Get the current direction of tidal flow (0=out, 1=in).

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtDisabledEnvironment::tidalDirection ( ) const
inlinevirtual

Set/Get the current direction of tidal flow (0=out, 1=in).

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setThermoclineDepth ( unsigned int  layer,
float  depth 
)
inlinevirtual

Set/Get the thermocline depths.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::thermoclineDepth ( unsigned int  layer) const
inlinevirtual

Set/Get the thermocline depths.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::setThermoclinePermeability ( unsigned int  layer,
float  permeability 
)
inlinevirtual

Set/Get the thermocline permeability.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtDisabledEnvironment::thermoclinePermeability ( unsigned int  layer) const
inlinevirtual

Set/Get the thermocline permeability.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::loadDefaults ( bool  loadOnlyFactorySettings = false)
inlinevirtual
virtual void makVrf::DtDisabledEnvironment::restore ( )
inlinevirtual
virtual void makVrf::DtDisabledEnvironment::saveAsDefaults ( )
inlinevirtual
virtual void makVrf::DtDisabledEnvironment::exportSettings ( const std::string &  filename)
inlinevirtual

Import / export the list of named conditions.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::importSettings ( const std::string &  filename)
inlinevirtual

Import / export the list of named conditions.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::slot_coordinateSystemChanged ( )
inlineprotectedvirtual

\name Slots for handling changes in the simulation.

Handle current coordinate system changes

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::slot_oceanLayerAdded ( const makVrv::DtOceanLayer layer)
inlineprotectedvirtual

Handle an ocean layer being added.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::slot_oceanLayerToBeDeleted ( const makVrv::DtOceanLayer layer)
inlineprotectedvirtual

Handle an ocean layer being removed.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::slot_oceanLayerSeaLevelChanged ( const makVrv::DtOceanLayer layer,
double  seaLevel 
)
inlineprotectedvirtual

Handle a change to an ocean layer's sea level.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::slot_oceanLayerLodRangeChanged ( const makVrv::DtOceanLayer layer,
int  range 
)
inlineprotectedvirtual

Handle a change to an ocean layer's lod range.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::slot_surgeDepthChanged ( double  depth)
inlineprotectedvirtual

Handle a change to surge depth.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtDisabledEnvironment::slot_depthOffsetChanged ( double  offset)
inlineprotectedvirtual

Handle a change to depth offset.

Implements makVrv::DtEnvironmentInterface.

Member Data Documentation

makVrv::DtCloudLayer makVrf::DtDisabledEnvironment::myCloudLayer
protected

Referenced by cloudLayer().

makVrv::DtEnvironmentInterface::PrecipitationType makVrf::DtDisabledEnvironment::myPrecipitationType
protected
makVrv::DtDe& makVrf::DtDisabledEnvironment::myDe
protected

Referenced by getEnvironmentNames().

makArchives::DtEnvironmentRecord makVrf::DtDisabledEnvironment::myCurrentSettings
protected

This is an env record that reflects our current settings.

Referenced by getRecord(), and setFromRecord().

makVrv::DtEnvironmentList makVrf::DtDisabledEnvironment::myEnvironmentList
protected

Referenced by setEnvironment().


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

Document ID: Generated on Mon Jul 4 01:00:18 EDT 2016 from SVN revision 166489
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)