The DtEnvironmentInterface is an interface class providing abstraction for different managers of environmental effects for a scene. More...

Inheritance diagram for makVrv::DtEnvironmentInterface:

[legend]

Public Types
enum	PrecipitationType { None = DtSkyObject::None, Rain = DtSkyObject::Rain, Snow = DtSkyObject::SnowWet }

Public Member Functions
	DtEnvironmentInterface ()
	CTOR.
virtual	~DtEnvironmentInterface ()
	Virtual DTOR.
virtual void	clear ()=0
	Clear all clouds, precipitation.
virtual void	getRecord (makArchives::DtEnvironmentRecord &record)=0
	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)=0
	Set the startup (last current) environment from record.
virtual void	addCloudLayer (const DtCloudLayer &layer)=0
	Add a cloud layer. (It is enabled by default).
virtual void	removeCloudLayer (unsigned int layerId)=0
	Remove a cloud layer by index.
virtual void	removeCloudLayers ()=0
	Remove all cloud layers for the current environment condition.
virtual void	setCloudLayerEnabled (unsigned int layerId, bool enabled)=0
	Set whether a cloud layer is enabled (visible).
virtual void	loadDefaults (bool loadOnlyFactorySettings=false)=0
virtual void	restore ()=0
virtual void	saveAsDefaults ()=0

virtual void	saveEnvironment (const std::string &envName)=0
	Save the current environment with the current name.
virtual void	removeEnvironment (const std::string &envName)=0
	Remove an environment entry.
virtual void	renameEnvironment (const std::string &oldName, const std::string &newName)=0
	Rename an environment entry.
virtual void	getEnvironmentNames (std::vector< std::string > &names)=0
	Get the names of all the environment conditions.
virtual void	setEnvironment (const std::string &envName)=0
	The current environment takes on the settings of the named env.
virtual void	setDefaultEnvironmentName (const std::string &name)=0
	Set the name of the default environment conditions.
virtual std::string	defaultEnvironmentName () const =0
	Get the name of the default environment conditions.
virtual void	setCloudCover (DtVrfWeatherCloudState cloudCover, bool autoSave=true)=0
	Set/Get which cloud cover to use.
virtual DtVrfWeatherCloudState	cloudCover () const =0

virtual int	cloudLayerCount () const =0
	Set / Get cloud additional layers.
virtual const DtCloudLayer &	cloudLayer (unsigned int layerId) const =0
	Get the specified cloud layer.
virtual void	setCloudLayer (unsigned int layerId, const DtCloudLayer &layer)=0
	Sets the layer specified by layerId to layer, if it exists.

virtual bool	useCustomCloudCover () const =0
	Set/Get whether custom clouds are used.
virtual void	setUseCustomCloudCover (bool enabled)=0

virtual void	setAirTurbidity (float turbidity, bool autoSave=true)=0
	Set/Get the air turbidity (haziness)
virtual float	airTurbidity () const =0

virtual void	setVisibleDistance (float distance, bool autoSave=true)=0
	Set/Get the visible distance in meters.
virtual float	visibleDistance () const =0

virtual void	setPrecipitationType (PrecipitationType type, bool autoSave=true)=0
	Set/Get the precipitation type.
virtual PrecipitationType	precipitationType () const =0

virtual void	setPrecipitationIntensity (float intensity, bool autoSave=true)=0
	Set/Get the precipitation intensity.
virtual float	precipitationIntensity () const =0

virtual void	setWindSpeed (float speed, bool autoSave=true)=0
	Set/Get the wind speed in meters per second.
virtual float	windSpeed () const =0

virtual void	setWindDirection (float direction, bool autoSave=true)=0
	Set/Get the wind direction in radians from north (clockwise).
virtual float	windDirection () const =0

virtual void	setAmbientAirTemperature (float temperature, bool autoSave=true)=0
	Set/Get the ambient air temperature in Celsius.
virtual float	ambientAirTemperature () const =0

virtual void	setFogHeight (float height, bool autoSave=true)=0
	Set/Get the fog ceiling height in meters.
virtual float	fogHeight () const =0

virtual void	setFogColor (const DtVector &color, bool autoSave=true)=0
	Set/Get the fog color in normalized color components.
virtual DtVector	fogColor () const =0

virtual void	setSeaState (int state, bool autoSave=true)=0
	Set/Get the sea state according to the Beaufort Scale.
virtual int	seaState () const =0

virtual void	setSeaStateDirection (float dir, bool autoSave=true)=0
	Set/Get the sea state direction in radians from north.
virtual float	seaStateDirection () const =0

virtual void	setWindDrivenSeaState (bool enabled, bool autoSave=true)=0
	Set/Get if sea state is wind driven or manually driven.
virtual bool	windDrivenSeaState () const =0

virtual void	setSwellState (int state, bool autoSave=true)=0
	Set/Get the sea-swell state according to the Douglas Scale.
virtual int	swellState () const =0

virtual void	setSwellStateDirection (float dir, bool autoSave=true)=0
	Set/Get the sea-swell state direction in radians from north.
virtual float	swellStateDirection () const =0

virtual void	setWindFetch (float distance, bool autoSave=true)=0
	Set/Get the ocean fetch.
virtual float	windFetch () const =0

virtual void	setSeaChoppiness (float chop, bool autoSave=true)=0
	Set/Get the amount of chop on the sea.
virtual float	seaChoppiness () const =0

virtual void	setUnderwaterVisibilityEnabled (bool enabled, bool autoSave=true)=0
virtual bool	underwaterVisibilityEnabled () const =0

virtual void	setUnderwaterVisibility (float distance, bool autoSave=true)=0
	Set/Get the maximum visibility under water in meters.
virtual float	underwaterVisibility () const =0

virtual void	setWaterSurfaceTransparency (float normalizedValue, bool autoSave=true)=0
	Set/Get the transparency value of water surface.
virtual float	waterSurfaceTransparency () const =0

virtual void	setSurgeDepth (float meters, bool autoSave=true)=0
	Set / Get the surge depth in distance.
virtual float	surgeDepth () const =0

virtual void	setDepthOffset (float meters, bool autoSave=true)=0
	Set / Get the depth offset in distance.
virtual float	depthOffset () const =0

virtual void	setAmbientWaterTemperature (float temperature, bool autoSave=true)=0
	Set/Get the ambient water temperature in Celsius.
virtual float	ambientWaterTemperature () const =0

virtual void	setWaterCurrentSpeed (float speed, bool autoSave=true)=0
	Set/Get the speed of water currents in meters per second.
virtual float	waterCurrentSpeed () const =0

virtual void	setWaterCurrentDirection (float direction, bool autoSave=true)=0
	Set/Get the direction of water currents in radians from north (clockwise).
virtual float	waterCurrentDirection () const =0

virtual void	setTidalOffset (float meters, bool autoSave=true)=0
	Set/Get the current tidal offset from mean-sea-level in meters.
virtual float	tidalOffset () const =0

virtual void	setTidalDirection (bool inOut, bool autoSave=true)=0
	Set/Get the current direction of tidal flow (0=out, 1=in).
virtual bool	tidalDirection () const =0

virtual void	setThermoclineDepth (unsigned int layer, float depth)=0
	Set/Get the thermocline depths.
virtual float	thermoclineDepth (unsigned int layer) const =0

virtual void	setThermoclinePermeability (unsigned int layer, float permeability)=0
	Set/Get the thermocline permeability.
virtual float	thermoclinePermeability (unsigned int layer) const =0

virtual void	exportSettings (const std::string &filename)=0
	Import / export the list of named conditions.
virtual void	importSettings (const std::string &filename)=0

Protected Member Functions

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

Detailed Description

The DtEnvironmentInterface is an interface class providing abstraction for different managers of environmental effects for a scene.

Member Enumeration Documentation

enum makVrv::DtEnvironmentInterface::PrecipitationType

Enumerator:

None
Rain
Snow

Constructor & Destructor Documentation

makVrv::DtEnvironmentInterface::DtEnvironmentInterface ( )

CTOR.

virtual makVrv::DtEnvironmentInterface::~DtEnvironmentInterface ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtEnvironmentInterface::clear ( )

pure virtual

Clear all clouds, precipitation.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::getRecord ( makArchives::DtEnvironmentRecord & record )

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setFromRecord ( const makArchives::DtEnvironmentRecord & record )

pure virtual

Set the startup (last current) environment from record.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::saveEnvironment ( const std::string & envName )

pure virtual

Save the current environment with the current name.

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::removeEnvironment ( const std::string & envName )

pure virtual

Remove an environment entry.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::renameEnvironment	(	const std::string &	oldName,
		const std::string &	newName
	)

pure virtual

Rename an environment entry.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::getEnvironmentNames ( std::vector< std::string > & names )

pure virtual

Get the names of all the environment conditions.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setEnvironment ( const std::string & envName )

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setDefaultEnvironmentName ( const std::string & name )

pure virtual

Set the name of the default environment conditions.

Parameters

[in] name is the name of the default environment.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual std::string makVrv::DtEnvironmentInterface::defaultEnvironmentName ( ) const

pure virtual

Get the name of the default environment conditions.

Returns: The name of the default environment.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setCloudCover	(	DtVrfWeatherCloudState	cloudCover,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual DtVrfWeatherCloudState makVrv::DtEnvironmentInterface::cloudCover ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual int makVrv::DtEnvironmentInterface::cloudLayerCount ( ) const

pure virtual

Set / Get cloud additional layers.

Get a count of the current cloud layers in the environment

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual const DtCloudLayer& makVrv::DtEnvironmentInterface::cloudLayer ( unsigned int layerId ) const

pure virtual

Get the specified cloud layer.

Throws DtException if the layerId >= cloudLayerCount()

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setCloudLayer	(	unsigned int	layerId,
		const DtCloudLayer &	layer
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::addCloudLayer ( const DtCloudLayer & layer )

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::removeCloudLayer ( unsigned int layerId )

pure virtual

Remove a cloud layer by index.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::removeCloudLayers ( )

pure virtual

Remove all cloud layers for the current environment condition.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setCloudLayerEnabled	(	unsigned int	layerId,
		bool	enabled
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual bool makVrv::DtEnvironmentInterface::useCustomCloudCover ( ) const

pure virtual

Set/Get whether custom clouds are used.

Note: Not supported in 1.6

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setUseCustomCloudCover ( bool enabled )

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setAirTurbidity	(	float	turbidity,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the air turbidity (haziness)

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::airTurbidity ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setVisibleDistance	(	float	distance,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the visible distance in meters.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::visibleDistance ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setPrecipitationType	(	PrecipitationType	type,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the precipitation type.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual PrecipitationType makVrv::DtEnvironmentInterface::precipitationType ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setPrecipitationIntensity	(	float	intensity,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the precipitation intensity.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::precipitationIntensity ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setWindSpeed	(	float	speed,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the wind speed in meters per second.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::windSpeed ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setWindDirection	(	float	direction,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::windDirection ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setAmbientAirTemperature	(	float	temperature,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the ambient air temperature in Celsius.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::ambientAirTemperature ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setFogHeight	(	float	height,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the fog ceiling height in meters.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::fogHeight ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setFogColor	(	const DtVector &	color,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the fog color in normalized color components.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual DtVector makVrv::DtEnvironmentInterface::fogColor ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setSeaState	(	int	state,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual int makVrv::DtEnvironmentInterface::seaState ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setSeaStateDirection	(	float	dir,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::seaStateDirection ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setWindDrivenSeaState	(	bool	enabled,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual bool makVrv::DtEnvironmentInterface::windDrivenSeaState ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setSwellState	(	int	state,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual int makVrv::DtEnvironmentInterface::swellState ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setSwellStateDirection	(	float	dir,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::swellStateDirection ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setWindFetch	(	float	distance,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the ocean fetch.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::windFetch ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setSeaChoppiness	(	float	chop,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the amount of chop on the sea.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::seaChoppiness ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setUnderwaterVisibilityEnabled	(	bool	enabled,
		bool	autoSave = `true`
	)

pure virtual

Set / Get underwater visibility enabled.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual bool makVrv::DtEnvironmentInterface::underwaterVisibilityEnabled ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setUnderwaterVisibility	(	float	distance,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the maximum visibility under water in meters.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::underwaterVisibility ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setWaterSurfaceTransparency	(	float	normalizedValue,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the transparency value of water surface.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::waterSurfaceTransparency ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setSurgeDepth	(	float	meters,
		bool	autoSave = `true`
	)

pure virtual

Set / Get the surge depth in distance.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::surgeDepth ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setDepthOffset	(	float	meters,
		bool	autoSave = `true`
	)

pure virtual

Set / Get the depth offset in distance.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::depthOffset ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setAmbientWaterTemperature	(	float	temperature,
		bool	autoSave = `true`
	)

pure virtual

Set/Get the ambient water temperature in Celsius.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::ambientWaterTemperature ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setWaterCurrentSpeed	(	float	speed,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::waterCurrentSpeed ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setWaterCurrentDirection	(	float	direction,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::waterCurrentDirection ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setTidalOffset	(	float	meters,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::tidalOffset ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setTidalDirection	(	bool	inOut,
		bool	autoSave = `true`
	)

pure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual bool makVrv::DtEnvironmentInterface::tidalDirection ( ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setThermoclineDepth	(	unsigned int	layer,
		float	depth
	)

pure virtual

Set/Get the thermocline depths.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::thermoclineDepth ( unsigned int layer ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::setThermoclinePermeability	(	unsigned int	layer,
		float	permeability
	)

pure virtual

Set/Get the thermocline permeability.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual float makVrv::DtEnvironmentInterface::thermoclinePermeability ( unsigned int layer ) const

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::loadDefaults ( bool loadOnlyFactorySettings = false )

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::restore ( )

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::saveAsDefaults ( )

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::exportSettings ( const std::string & filename )

pure virtual

Import / export the list of named conditions.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::importSettings ( const std::string & filename )

pure virtual

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::slot_coordinateSystemChanged ( )

protectedpure virtual

\name Slots for handling changes in the simulation.

Handle current coordinate system changes

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::slot_oceanLayerAdded ( const DtOceanLayer & layer )

protectedpure virtual

Handle an ocean layer being added.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::slot_oceanLayerToBeDeleted ( const DtOceanLayer & layer )

protectedpure virtual

Handle an ocean layer being removed.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::slot_oceanLayerSeaLevelChanged	(	const DtOceanLayer &	layer,
		double	seaLevel
	)

protectedpure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::slot_oceanLayerLodRangeChanged	(	const DtOceanLayer &	layer,
		int	range
	)

protectedpure virtual

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

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::slot_surgeDepthChanged ( double depth )

protectedpure virtual

Handle a change to surge depth.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

virtual void makVrv::DtEnvironmentInterface::slot_depthOffsetChanged ( double offset )

protectedpure virtual

Handle a change to depth offset.

Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtEnvironmentInterface.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation