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, Hail = DtSkyObject::Hail, Sleet = DtSkyObject::Sleet, Drizzle = DtSkyObject::Drizzle }

typedef makArchives::VisibilityObscurant	VisibilityObscurant

typedef makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord	DtElevationalConfigurationRecord

typedef DtCloudTypeMapper::CloudType	CloudType

Public Member Functions
	DtEnvironmentInterface ()
	CTOR. More...

virtual	~DtEnvironmentInterface ()
	Virtual DTOR. More...

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. More...

virtual void	setFromRecord (const makArchives::DtEnvironmentRecord &record)=0
	Set the startup (last current) environment from record. More...

virtual void	updateOrAddElevationalConfiguration (const DtElevationalConfigurationRecord &record)=0
	Update an elevational configuration record which consists of 1) a base MSL altitude, in meters, 2) a wind speed, in meters per second, 3) a wind direction, in radians from True North (clockwise), 4) a visibility distance, in meters, and 5) an enumerated visibility obscurant value. More...

virtual bool	getElevationalConfiguration (float baseMSLAltitude, makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord &wRec) const =0
	Get an elevational configuration record by its base MSL altitude, in meters, and return it by reference. More...

virtual void	removeElevationalConfiguration (float baseMSLAltitude)=0
	Remove an elevational configuration record by its MSL altitude, in meters. More...

virtual void	moveElevationalConfiguration (float oldBaseMSLAltitude, float newBaseMSLAltitude)=0
	Move an elevational configuration record from the provided 'old' base MSL altitude to the provided 'new' base MSL altitude. More...

virtual void	setWindSpeedAtMSLAltitude (float mslAltitude, float windSpeed)=0
	Set the wind speed at the provided MSL altitude, in meters. More...

virtual float	windSpeedAtMSLAltitude (float mslAltitude) const =0
	Get the wind speed at the provided MSL altitude, in meters. More...

virtual void	setWindDirectionAtMSLAltitude (float mslAltitude, float windDirection)=0
	Set the wind direction at the provided MSL altitude, in meters. More...

virtual float	windDirectionAtMSLAltitude (float mslAltitude) const =0
	Get the wind direction at the provided MSL altitude, in meters. More...

virtual void	setVisibilityDistanceAtMSLAltitude (float mslAltitude, float visibilityDistance)=0
	Set the visibility distance at the provided MSL altitude, in meters. More...

virtual float	visibilityDistanceAtMSLAltitude (float mslAltitude) const =0
	Get the visibility distance at the provided MSL altitude, in meters. More...

virtual void	setObscurantAtMSLAltitude (float mslAltitude, VisibilityObscurant obscurant)=0
	Set the obscurant at the provided MSL altitude, in meters. More...

virtual VisibilityObscurant	obscurantAtMSLAltitude (float mslAltitude) const =0
	Get the obscurant at the provided MSL altitude, in meters. More...

virtual void	setCloudTypeAtMSLAltitude (float mslAltitude, CloudType cloudType)=0
	Set the cloud type at the provided MSL altitude, in meters. More...

virtual CloudType	cloudTypeAtMSLAltitude (float mslAltitude) const =0
	Get the cloud type at the provided MSL altitude, in meters. More...

virtual void	setSkyCoverageAtMSLAltitude (float mslAltitude, float skyCoverage)=0
	Set the sky coverage at the provided MSL altitude, in meters. More...

virtual float	skyCoverageAtMSLAltitude (float mslAltitude) const =0
	Get the sky coverage at the provided MSL altitude, in meters. More...

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. More...

virtual void	removeEnvironment (const std::string &envName)=0
	Remove an environment entry. More...

virtual void	renameEnvironment (const std::string &oldName, const std::string &newName)=0
	Rename an environment entry. More...

virtual void	getEnvironmentNames (std::vector< std::string > &names, bool includeLocalOnlyEnvironment=false)=0
	Get the names of all the environment conditions. More...

virtual void	setEnvironment (const std::string &envName)=0
	The current environment takes on the settings of the named env. More...

virtual void	setDefaultEnvironmentName (const std::string &name)=0
	Set the name of the default environment conditions. More...

virtual std::string	defaultEnvironmentName () const =0
	Get the name of the default environment conditions. More...

virtual void	setLightningPresent (bool lightningPresent)=0
	Set/Get whether or not lightning is present. More...

virtual bool	lightningPresent () const =0


virtual void	setAirTurbidity (float turbidity)=0
	Set/Get the air turbidity (haziness) More...

virtual float	airTurbidity () const =0


virtual void	setVisibleDistance (float distance)=0
	Set / get the 'global' visible distance, in meters. More...

virtual float	visibleDistance () const =0


virtual void	setWindSpeed (float windSpeed)=0
	Set / get the 'global' wind speed, in meters per second. More...

virtual float	windSpeed () const =0


virtual void	setWindDirection (float direction)=0
	Set / get the 'global' wind direction, in radians. More...

virtual float	windDirection () const =0


virtual void	setPrecipitationType (PrecipitationType type)=0
	Set/Get the precipitation type. More...

virtual PrecipitationType	precipitationType () const =0


virtual void	setPrecipitationIntensity (float intensity)=0
	Set/Get the precipitation intensity. More...

virtual float	precipitationIntensity () const =0


virtual void	setAmbientAirTemperature (float temperature)=0
	Set/Get the ambient air temperature, in Kelvins. More...

virtual float	ambientAirTemperature () const =0


virtual void	setAmbientAirPressure (float pressure)=0
	Set/Get the ambient air pressure in Pascals. More...

virtual float	ambientAirPressure () const =0


virtual void	setAirPressureAltitude (float altitude)=0

virtual float	airPressureAltitude () const =0


virtual void	setAirTemperatureAltitude (float altitude)=0

virtual float	airTemperatureAltitude () const =0


virtual void	setAirPressureAltitudeIsSeaLevel (bool seaLevel)=0

virtual bool	airPressureAltitudeIsSeaLevel () const =0


virtual void	setAirTemperatureAltitudeIsSeaLevel (bool seaLevel)=0

virtual bool	airTemperatureAltitudeIsSeaLevel () const =0


virtual void	setSeaLevelWaterConcentration (float water)=0

virtual float	seaLevelWaterConcentration () const =0


virtual void	setFogHeight (float height)=0
	Set/Get the fog ceiling height in meters. More...

virtual float	fogHeight () const =0


virtual void	setFogColor (const DtVector &color)=0
	Set/Get the fog color in normalized color components. More...

virtual DtVector	fogColor () const =0


virtual void	setGroundFogColor (const DtVector &color)=0
	Set / get the ground fog color in normalized color components. More...

virtual DtVector	groundFogColor () const =0


virtual void	setSeaState (int state)=0
	Set/Get the sea state according to the Beaufort Scale. More...

virtual int	seaState () const =0


virtual void	setSeaStateDirection (float dir)=0
	Set/Get the sea state direction in radians from north. More...

virtual float	seaStateDirection () const =0


virtual void	setWindDrivenSeaState (bool enabled)=0
	Set/Get if sea state is wind driven or manually driven. More...

virtual bool	windDrivenSeaState () const =0


virtual void	setSwellState (int state)=0
	Set/Get the sea-swell state according to the Douglas Scale. More...

virtual int	swellState () const =0


virtual void	setSwellStateDirection (float dir)=0
	Set/Get the sea-swell state direction in radians from north. More...

virtual float	swellStateDirection () const =0


virtual void	setWindFetch (float distance)=0
	Set/Get the ocean fetch. More...

virtual float	windFetch () const =0


virtual void	setSeaChoppiness (float chop)=0
	Set/Get the amount of chop on the sea. More...

virtual float	seaChoppiness () const =0


virtual void	setUnderwaterVisibilityEnabled (bool enabled)=0

virtual bool	underwaterVisibilityEnabled () const =0


virtual void	setUnderwaterVisibility (float distance)=0
	Set/Get the maximum visibility under water in meters. More...

virtual float	underwaterVisibility () const =0


virtual void	setWaterSurfaceTransparency (float normalizedValue)=0
	Set/Get the transparency value of water surface. More...

virtual float	waterSurfaceTransparency () const =0


virtual void	setSurgeDepth (float meters)=0
	Set / Get the surge depth in distance. More...

virtual float	surgeDepth () const =0


virtual void	setDepthOffset (float meters)=0
	Set / Get the depth offset in distance. More...

virtual float	depthOffset () const =0


virtual void	setAmbientWaterTemperature (float temperature)=0
	Set/Get the ambient water temperature, in Kelvins. More...

virtual float	ambientWaterTemperature () const =0


virtual void	setWaterCurrentSpeed (float speed)=0
	Set/Get the speed of water currents in meters per second. More...

virtual float	waterCurrentSpeed () const =0


virtual void	setWaterCurrentDirection (float direction)=0
	Set/Get the direction of water currents in radians from north (clockwise). More...

virtual float	waterCurrentDirection () const =0


virtual void	setTidalOffset (float meters)=0
	Set/Get the current tidal offset from mean-sea-level in meters. More...

virtual float	tidalOffset () const =0


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

virtual bool	tidalDirection () const =0


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

virtual float	thermoclineDepth (unsigned int layer) const =0


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

virtual float	thermoclinePermeability (unsigned int layer) const =0


virtual void	setGroundSnowAccumulation (float depth)=0
	Set/Get the ground snow accumulation depth. More...

virtual float	groundSnowAccumulation () const =0


virtual void	setRoadSnowAccumulation (float depth)=0
	Set/Get the road snow accumulation depth. More...

virtual float	roadSnowAccumulation () const =0


virtual void	setSnowMinimumElevation (float elevation)=0
	Set/Get the snow minimum elevation. More...

virtual float	snowMinimumElevation () const =0


virtual void	setSnowElevationTransition (float elevation)=0

virtual float	snowElevationTransition () const =0


virtual void	setGroundRainAccumulation (float depth)=0
	Set/Get the ground rain accumulation depth. More...

virtual float	groundRainAccumulation () const =0


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

virtual void	importSettings (const std::string &filename)=0

Static Public Attributes
static const float	theMaximumVisibilityDistance
	Maximum Visibility Distance. More...

Protected Member Functions

virtual void	slot_coordinateSystemChanged ()=0
	\name Slots for handling changes in the simulation. More...

virtual void	slot_oceanLayerAdded (const DtOceanLayer &layer)=0
	Handle an ocean layer being added. More...

virtual void	slot_oceanLayerToBeDeleted (const DtOceanLayer &layer)=0
	Handle an ocean layer being removed. More...

virtual void	slot_oceanLayerSeaLevelChanged (const DtOceanLayer &layer, double seaLevel)=0
	Handle a change to an ocean layer's sea level. More...

virtual void	slot_oceanLayerLodRangeChanged (const DtOceanLayer &layer, int range)=0
	Handle a change to an ocean layer's lod range. More...

virtual void	slot_surgeDepthChanged (double depth)=0
	Handle a change to surge depth. More...

virtual void	slot_depthOffsetChanged (double offset)=0
	Handle a change to depth offset. More...

Detailed Description

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

Member Typedef Documentation

typedef makArchives::VisibilityObscurant makVrv::DtEnvironmentInterface::VisibilityObscurant

typedef makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord makVrv::DtEnvironmentInterface::DtElevationalConfigurationRecord

typedef DtCloudTypeMapper::CloudType makVrv::DtEnvironmentInterface::CloudType

Member Enumeration Documentation

enum makVrv::DtEnvironmentInterface::PrecipitationType

Enumerator
None
Rain
Snow
Hail
Sleet
Drizzle

Constructor & Destructor Documentation

makVrv::DtEnvironmentInterface::DtEnvironmentInterface ( )

CTOR.

virtual makVrv::DtEnvironmentInterface::~DtEnvironmentInterface ( )

virtual

Virtual DTOR.

Member Function Documentation

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 makVrf::DtLocalEnvironment, and makVrv::DtEnvironment.

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

pure virtual

Set the startup (last current) environment from record.

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

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 makVrf::DtLocalEnvironment, and makVrv::DtEnvironment.

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

pure virtual

Remove an environment entry.

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

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

pure virtual

Rename an environment entry.

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

virtual void makVrv::DtEnvironmentInterface::getEnvironmentNames	(	std::vector< std::string > &	names,
		bool	includeLocalOnlyEnvironment = `false`
	)

pure virtual

Get the names of all the environment conditions.

The includeLocalOnlyEnvironment flag is used by VR-Forces to get all the global and local environment conditions to be listed by their local weather area editor panel.

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

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

pure virtual

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

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

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 makVrf::DtLocalEnvironment, and makVrv::DtEnvironment.

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 makVrf::DtLocalEnvironment, and makVrv::DtEnvironment.

virtual void makVrv::DtEnvironmentInterface::setLightningPresent ( bool lightningPresent )

pure virtual

Set/Get whether or not lightning is present.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setAirTurbidity ( float turbidity )

pure virtual

Set/Get the air turbidity (haziness)

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setVisibleDistance ( float distance )

pure virtual

Set / get the 'global' visible distance, in meters.

This functions sets/gets the visibility distance for the elevational configuration record at base MSL altitude 0. If there are no other elevational configurations, then the visible distance specified has a global effect.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setWindSpeed ( float windSpeed )

pure virtual

Set / get the 'global' wind speed, in meters per second.

These functions sets/gets the wind speed for the elevational configuration record at base MSL altitude 0. If there are no other elevational configurations, then the wind speed specified has a global effect.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setWindDirection ( float direction )

pure virtual

Set / get the 'global' wind direction, in radians.

This functions sets/gets the wind direction for the elevational configuration record at base MSL altitude 0. If there are no other elevational configurations, then the wind direction specified has a global effect.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setPrecipitationType ( PrecipitationType type )

pure virtual

Set/Get the precipitation type.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setPrecipitationIntensity ( float intensity )

pure virtual

Set/Get the precipitation intensity.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::updateOrAddElevationalConfiguration ( const DtElevationalConfigurationRecord & record )

pure virtual

Update an elevational configuration record which consists of 1) a base MSL altitude, in meters, 2) a wind speed, in meters per second, 3) a wind direction, in radians from True North (clockwise), 4) a visibility distance, in meters, and 5) an enumerated visibility obscurant value.

If the elevational configuration record doesn't exist, add a new one with the passed in attributes. The Base MSL Altitude is used to locate the specific elevational configuration record to update, if there is one, by doing a floating point comparison (with a +/- delta of 0.001) against all the existing elevational configuration records.

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

virtual bool makVrv::DtEnvironmentInterface::getElevationalConfiguration	(	float	baseMSLAltitude,
		makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord &	wRec
	)		const

pure virtual

Get an elevational configuration record by its base MSL altitude, in meters, and return it by reference.

The function returns true if the elevational configuration record was found and returned - returning false otherwise. The Base MSL Altitude is used to locate the specific elevational configuration record to return, if there is one, by doing a floating point comparison (with a +/- delta of 0.001) against all the existing elevational configuration records.

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

virtual void makVrv::DtEnvironmentInterface::removeElevationalConfiguration ( float baseMSLAltitude )

pure virtual

Remove an elevational configuration record by its MSL altitude, in meters.

The Base MSL Altitude is used to locate the specific elevational configuration record to remove, if there is one, by doing a floating point comparison (with a +/- delta of 0.001) against all the existing elevational configuration records. This function emits a warning if the elevational configuration record to remove was not found.

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

virtual void makVrv::DtEnvironmentInterface::moveElevationalConfiguration	(	float	oldBaseMSLAltitude,
		float	newBaseMSLAltitude
	)

pure virtual

Move an elevational configuration record from the provided 'old' base MSL altitude to the provided 'new' base MSL altitude.

This function checks to see if there is already an elevational configuration record for the passed in new base MSL altitude and, if there is, this function will emit a warning. If there is not an elevational wind for the passed in old base MSL altitude, then the function will also emit a warning. The Base MSL Altitude is used to locate the specific elevational configuration record to move, if there is one, by doing a floating point comparison (with a +/- delta of 0.001) against all the existing elevational configuration records.

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

virtual void makVrv::DtEnvironmentInterface::setWindSpeedAtMSLAltitude	(	float	mslAltitude,
		float	windSpeed
	)

pure virtual

Set the wind speed at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and sets the record's wind speed. Wind speed is expressed in meters per second.

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

virtual float makVrv::DtEnvironmentInterface::windSpeedAtMSLAltitude ( float mslAltitude ) const

pure virtual

Get the wind speed at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and returns the record's wind speed. Wind speed is expressed in meters per second.

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

virtual void makVrv::DtEnvironmentInterface::setWindDirectionAtMSLAltitude	(	float	mslAltitude,
		float	windDirection
	)

pure virtual

Set the wind direction at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and sets the record's wind direction. Wind direction is expressed in radians from True North (clockwise).

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

virtual float makVrv::DtEnvironmentInterface::windDirectionAtMSLAltitude ( float mslAltitude ) const

pure virtual

Get the wind direction at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and returns the record's wind direction. Wind direction is expressed in radians from True North (clockwise).

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

virtual void makVrv::DtEnvironmentInterface::setVisibilityDistanceAtMSLAltitude	(	float	mslAltitude,
		float	visibilityDistance
	)

pure virtual

Set the visibility distance at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and sets the record's visibility distance. Visibility distance is expressed in meters.

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

virtual float makVrv::DtEnvironmentInterface::visibilityDistanceAtMSLAltitude ( float mslAltitude ) const

pure virtual

Get the visibility distance at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and returns the record's visibility distance. Visibility distance is expressed in meters.

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

virtual void makVrv::DtEnvironmentInterface::setObscurantAtMSLAltitude	(	float	mslAltitude,
		VisibilityObscurant	obscurant
	)

pure virtual

Set the obscurant at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and sets the record's obscurant. Obscurant is expressed as a VisibilityObscurant enumerated value.

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

virtual VisibilityObscurant makVrv::DtEnvironmentInterface::obscurantAtMSLAltitude ( float mslAltitude ) const

pure virtual

Get the obscurant at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and returns the record's obscurant. Obscurant is expressed as a VisibilityObscurant enumerated value.

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

virtual void makVrv::DtEnvironmentInterface::setCloudTypeAtMSLAltitude	(	float	mslAltitude,
		CloudType	cloudType
	)

pure virtual

Set the cloud type at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and sets the record's obscurant. Cloud type is expressed as a CloudType enumerated value.

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

virtual CloudType makVrv::DtEnvironmentInterface::cloudTypeAtMSLAltitude ( float mslAltitude ) const

pure virtual

Get the cloud type at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and returns the record's obscurant. Cloud type is expressed as a CloudType enumerated value.

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

virtual void makVrv::DtEnvironmentInterface::setSkyCoverageAtMSLAltitude	(	float	mslAltitude,
		float	skyCoverage
	)

pure virtual

Set the sky coverage at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and sets the record's obscurant. Sky coverage is expressed in normalized Oktas [0-1].

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

virtual float makVrv::DtEnvironmentInterface::skyCoverageAtMSLAltitude ( float mslAltitude ) const

pure virtual

Get the sky coverage at the provided MSL altitude, in meters.

This function finds the elevational configuration record with the lowest base MSL altitude that is at or below the requested altitude and returns the record's obscurant. Sky coverage is expressed in normalized Oktas [0-1].

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

virtual void makVrv::DtEnvironmentInterface::setAmbientAirTemperature ( float temperature )

pure virtual

Set/Get the ambient air temperature, in Kelvins.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setAmbientAirPressure ( float pressure )

pure virtual

Set/Get the ambient air pressure in Pascals.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setAirPressureAltitude ( float altitude )

pure virtual

Set/Get the air pressure altitude in meters

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setAirTemperatureAltitude ( float altitude )

pure virtual

Set/Get the air temperature altitude in meters

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setAirPressureAltitudeIsSeaLevel ( bool seaLevel )

pure virtual

Set/Get the air pressure altitude is sea level

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setAirTemperatureAltitudeIsSeaLevel ( bool seaLevel )

pure virtual

Set/Get the air temperature altitude is sea level

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setSeaLevelWaterConcentration ( float water )

pure virtual

get/set the sea level water concentration in PPMV

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setFogHeight ( float height )

pure virtual

Set/Get the fog ceiling height in meters.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setFogColor ( const DtVector & color )

pure virtual

Set/Get the fog color in normalized color components.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setGroundFogColor ( const DtVector & color )

pure virtual

Set / get the ground fog color in normalized color components.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setSeaState ( int state )

pure virtual

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

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setSeaStateDirection ( float dir )

pure virtual

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

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

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

pure virtual

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

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

pure virtual

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

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setSwellState ( int state )

pure virtual

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

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setSwellStateDirection ( float dir )

pure virtual

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

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setWindFetch ( float distance )

pure virtual

Set/Get the ocean fetch.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setSeaChoppiness ( float chop )

pure virtual

Set/Get the amount of chop on the sea.

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

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

pure virtual

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

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

pure virtual

Set / Get underwater visibility enabled.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setUnderwaterVisibility ( float distance )

pure virtual

Set/Get the maximum visibility under water in meters.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setWaterSurfaceTransparency ( float normalizedValue )

pure virtual

Set/Get the transparency value of water surface.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setSurgeDepth ( float meters )

pure virtual

Set / Get the surge depth in distance.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setDepthOffset ( float meters )

pure virtual

Set / Get the depth offset in distance.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setAmbientWaterTemperature ( float temperature )

pure virtual

Set/Get the ambient water temperature, in Kelvins.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setWaterCurrentSpeed ( float speed )

pure virtual

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

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setWaterCurrentDirection ( float direction )

pure virtual

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

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setTidalOffset ( float meters )

pure virtual

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

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setTidalDirection ( bool inOut )

pure virtual

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

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

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

pure virtual

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

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

pure virtual

Set/Get the thermocline depths.

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

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

pure virtual

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

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

pure virtual

Set/Get the thermocline permeability.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setGroundSnowAccumulation ( float depth )

pure virtual

Set/Get the ground snow accumulation depth.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setRoadSnowAccumulation ( float depth )

pure virtual

Set/Get the road snow accumulation depth.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setSnowMinimumElevation ( float elevation )

pure virtual

Set/Get the snow minimum elevation.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setSnowElevationTransition ( float elevation )

pure virtual

Set/Get the snow elevation transition which specifies how long it takes to go from no snow to the full snow depth.

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::setGroundRainAccumulation ( float depth )

pure virtual

Set/Get the ground rain accumulation depth.

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

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

pure virtual

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

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

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::restore ( )

pure virtual

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

virtual void makVrv::DtEnvironmentInterface::saveAsDefaults ( )

pure virtual

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

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

pure virtual

Import / export the list of named conditions.

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

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

pure virtual

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

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::DtLocalEnvironment.

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

protectedpure virtual

Handle an ocean layer being added.

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

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

protectedpure virtual

Handle an ocean layer being removed.

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

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::DtLocalEnvironment.

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::DtLocalEnvironment.

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

protectedpure virtual

Handle a change to surge depth.

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

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

protectedpure virtual

Handle a change to depth offset.

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

Member Data Documentation

const float makVrv::DtEnvironmentInterface::theMaximumVisibilityDistance

static

Maximum Visibility Distance.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtEnvironmentInterface.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation