makVrf::DtLocalEnvironment Class Reference

Inheritance diagram for makVrf::DtLocalEnvironment:

Public Member Functions
	DtLocalEnvironment (makVrv::DtDe &de)
virtual	~DtLocalEnvironment ()
virtual void	updateOrAddElevationalConfiguration (const DtElevationalConfigurationRecord &record)
	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
	Get an elevational configuration record by its base MSL altitude, in meters, and return it by reference. More...
virtual void	removeElevationalConfiguration (float baseMSLAltitude)
	Remove an elevational configuration record by its MSL altitude, in meters. More...
virtual void	moveElevationalConfiguration (float oldBaseMSLAltitude, float newBaseMSLAltitude)
	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)
	Set the wind speed at the provided MSL altitude, in meters. More...
virtual float	windSpeedAtMSLAltitude (float mslAltitude) const
	Get the wind speed at the provided MSL altitude, in meters. More...
virtual void	setWindDirectionAtMSLAltitude (float mslAltitude, float windDirection)
	Set the wind direction at the provided MSL altitude, in meters. More...
virtual float	windDirectionAtMSLAltitude (float mslAltitude) const
	Get the wind direction at the provided MSL altitude, in meters. More...
virtual void	setVisibilityDistanceAtMSLAltitude (float mslAltitude, float visibilityDistance)
	Set the visibility distance at the provided MSL altitude, in meters. More...
virtual float	visibilityDistanceAtMSLAltitude (float mslAltitude) const
	Get the visibility distance at the provided MSL altitude, in meters. More...
virtual void	setObscurantAtMSLAltitude (float mslAltitude, VisibilityObscurant obscurant)
	Set the obscurant at the provided MSL altitude, in meters. More...
virtual VisibilityObscurant	obscurantAtMSLAltitude (float mslAltitude) const
	Get the obscurant at the provided MSL altitude, in meters. More...
virtual void	setCloudTypeAtMSLAltitude (float mslAltitude, CloudType cloudType)
	Set the cloud type at the provided MSL altitude, in meters. More...
virtual CloudType	cloudTypeAtMSLAltitude (float mslAltitude) const
	Get the cloud type at the provided MSL altitude, in meters. More...
virtual void	setSkyCoverageAtMSLAltitude (float mslAltitude, float skyCoverage)
	Set the sky coverage at the provided MSL altitude, in meters. More...
virtual float	skyCoverageAtMSLAltitude (float mslAltitude) const
	Get the sky coverage at the provided MSL altitude, in meters. More...
virtual void	loadDefaults (bool loadOnlyFactorySettings=false)
virtual void	getRecord (makArchives::DtEnvironmentRecord &record)
	Put the current environment conditions into a record. More...
virtual void	setFromRecord (const makArchives::DtEnvironmentRecord &record)
	Set the current environment conditions from a record. More...
virtual makArchives::DtEnvironmentRecord	environmentConditionRecord (const std::string &)
	Returns the environment record for the environment condition name. More...
virtual void	slot_coordinateSystemChanged ()
	\name Slots for handling changes in the simulation. More...
virtual void	slot_oceanLayerAdded (const makVrv::DtOceanLayer &layer)
	Handle an ocean layer being added. More...
virtual void	slot_oceanLayerToBeDeleted (const makVrv::DtOceanLayer &layer)
	Handle an ocean layer being removed. More...
virtual void	slot_oceanLayerSeaLevelChanged (const makVrv::DtOceanLayer &layer, double seaLevel)
	Handle a change to an ocean layer's sea level. More...
virtual void	slot_oceanLayerLodRangeChanged (const makVrv::DtOceanLayer &layer, int range)
	Handle a change to an ocean layer's lod range. More...
virtual void	slot_surgeDepthChanged (double depth)
	Handle a change to surge depth. More...
virtual void	slot_depthOffsetChanged (double offset)
	Handle a change to depth offset. More...
virtual void	autoSave ()
virtual void	setLightningPresent (bool lightningPresent)
	Set/Get whether or not lightning is present. More...
virtual bool	lightningPresent () const
virtual void	setAirTurbidity (float turbidity)
	Set / get the air turbidity (haziness) More...
virtual float	airTurbidity () const
virtual void	setVisibleDistance (float distance)
	Set / get the 'global' visible distance, in meters. More...
virtual float	visibleDistance () const
virtual void	setWindSpeed (float windSpeed)
	Set / get the 'global' wind speed, in meters per second. More...
virtual float	windSpeed () const
virtual void	setWindDirection (float direction)
	Set / get the 'global' wind direction, in radians. More...
virtual float	windDirection () const
virtual void	setPrecipitationType (PrecipitationType type)
	Set / get the precipitation type. More...
virtual PrecipitationType	precipitationType () const
virtual void	setPrecipitationIntensity (float intensity)
	Set / get the precipitation intensity. More...
virtual float	precipitationIntensity () const
virtual void	setAmbientAirTemperature (float temperature)
	Set / get the ambient air temperature, in Kelvins. More...
virtual float	ambientAirTemperature () const
virtual void	setAmbientAirPressure (float pressure)
	Set/Get the ambient air pressure in Pascals. More...
virtual float	ambientAirPressure () const
virtual void	setAirPressureAltitude (float altitude)
virtual float	airPressureAltitude () const
virtual void	setAirTemperatureAltitude (float altitude)
virtual float	airTemperatureAltitude () const
virtual void	setAirPressureAltitudeIsSeaLevel (bool seaLevel)
virtual bool	airPressureAltitudeIsSeaLevel () const
virtual void	setAirTemperatureAltitudeIsSeaLevel (bool seaLevel)
virtual bool	airTemperatureAltitudeIsSeaLevel () const
virtual void	setSeaLevelWaterConcentration (float water)
virtual float	seaLevelWaterConcentration () const
virtual void	setFogHeight (float height)
	Set / get the fog ceiling height in meters. More...
virtual float	fogHeight () const
virtual void	setFogColor (const DtVector &color)
	Set / get the fog color in normalized color components. More...
virtual DtVector	fogColor () const
virtual void	setGroundFogColor (const DtVector &color) override
	Set / get the ground fog color in normalized color components. More...
virtual DtVector	groundFogColor () const override
virtual void	setSeaState (int state)
	Set / get the sea state according to the Beaufort Scale. More...
virtual int	seaState () const
virtual void	setSeaStateDirection (float dir)
	Set / get the sea state direction in radians from north. More...
virtual float	seaStateDirection () const
virtual void	setWindDrivenSeaState (bool enabled)
	Set / get if sea state is wind driven or manually driven. More...
virtual bool	windDrivenSeaState () const
virtual void	setSwellState (int state)
	Set / get the sea-swell state according to the Douglas Scale. More...
virtual int	swellState () const
virtual void	setSwellStateDirection (float dir)
	Set / get the sea-swell state direction in radians from north. More...
virtual float	swellStateDirection () const
virtual void	setWindFetch (float distance)
	Set / get the ocean fetch. More...
virtual float	windFetch () const
virtual void	setSeaChoppiness (float chop)
	Set / get the amount of chop on the sea. More...
virtual float	seaChoppiness () const
void	setUnderwaterVisibilityEnabled (bool enabled)
bool	underwaterVisibilityEnabled () const
virtual void	setUnderwaterVisibility (float distance)
	Set / get the maximum visibility under water in meters. More...
virtual float	underwaterVisibility () const
virtual void	setWaterSurfaceTransparency (float normalizedValue)
	Set / get the transparency value of water surface. More...
virtual float	waterSurfaceTransparency () const
virtual void	setSurgeDepth (float meters)
	Set / Get the surge depth in distance. More...
virtual float	surgeDepth () const
virtual void	setDepthOffset (float meters)
	Set / Get the depth offset in distance. More...
virtual float	depthOffset () const
virtual void	setAmbientWaterTemperature (float temperature)
	Set / get the ambient water temperature, in Kelvins. More...
virtual float	ambientWaterTemperature () const
virtual void	setWaterCurrentSpeed (float speed)
	Set / get the speed of water currents in meters per second. More...
virtual float	waterCurrentSpeed () const
virtual void	setWaterCurrentDirection (float direction)
	Set / get the direction of water currents in radians from north (clockwise). More...
virtual float	waterCurrentDirection () const
virtual void	setTidalOffset (float meters)
	Set / get the current tidal offset from mean-sea-level in meters. More...
virtual float	tidalOffset () const
virtual void	setTidalDirection (bool inOut)
	Set / get the current direction of tidal flow (0=out, 1=in). More...
virtual bool	tidalDirection () const
virtual void	setThermoclineDepth (unsigned int layer, float depth)
	Set / get the thermocline depths. More...
virtual float	thermoclineDepth (unsigned int layer) const
virtual void	setThermoclinePermeability (unsigned int layer, float permeability)
	Set / get the thermocline permeability. More...
virtual float	thermoclinePermeability (unsigned int layer) const
virtual void	setGroundSnowAccumulation (float depth)
	Set / get the ground snow accumulation depth. More...
virtual float	groundSnowAccumulation () const
virtual void	setRoadSnowAccumulation (float depth)
	Set / get the road snow accumulation depth. More...
virtual float	roadSnowAccumulation () const
virtual void	setSnowMinimumElevation (float elevation)
	Set / get the snow minimum elevation. More...
virtual float	snowMinimumElevation () const
virtual void	setSnowElevationTransition (float elevation)
virtual float	snowElevationTransition () const
virtual void	setGroundRainAccumulation (float depth)
	Set / get the ground rain accumulation depth. More...
virtual float	groundRainAccumulation () const
virtual void	saveEnvironment (const std::string &name)
virtual void	setEnvironment (const std::string &name)
	Set the current environment to the environment of the given name. More...
virtual void	removeEnvironment (const std::string &name)
	Remove an environment with the given name. More...
virtual void	renameEnvironment (const std::string &oldName, const std::string &newName)
	Rename an environment entry. More...
virtual void	getEnvironmentNames (std::vector< std::string > &names, bool includeLocalOnlyEnvironment=true)
	Get the names of all the environment conditions. More...
virtual void	setDefaultEnvironmentName (const std::string &name)
	Set the name of the default environment conditions. More...
virtual std::string	defaultEnvironmentName () const
	Get the name of the default environment conditions. More...
void	restore ()
	Restores to backup settings from startup default. More...
void	saveAsDefaults ()
	Save the current settings as the default settings. More...
virtual void	exportSettings (const std::string &filename)
	Import / export the list of named conditions (.enlx file) More...
virtual void	importSettings (const std::string &filename)
Public Member Functions inherited from makVrv::DtEnvironmentInterface
	DtEnvironmentInterface ()
	CTOR. More...
virtual	~DtEnvironmentInterface ()
	Virtual DTOR. More...

Protected Attributes
makVrv::DtDe &	myDe
makArchives::DtEnvironmentRecord	myCurrentSettings
	This is an env record that reflects our current settings. More...
makVrv::DtEnvironmentList	myEnvironmentList
	This is an env list that reflects saved settings. More...
DtVector	myGroundFogColor
	Until this is in an environment record. More...

Additional Inherited Members
Public Types inherited from makVrv::DtEnvironmentInterface
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
Static Public Attributes inherited from makVrv::DtEnvironmentInterface
static const float	theMaximumVisibilityDistance
	Maximum Visibility Distance. More...

Constructor & Destructor Documentation

makVrf::DtLocalEnvironment::DtLocalEnvironment

(

makVrv::DtDe &

de

)

virtual makVrf::DtLocalEnvironment::~DtLocalEnvironment ( )

virtual

Member Function Documentation

virtual void makVrf::DtLocalEnvironment::setLightningPresent ( bool  lightningPresent )

virtual

Set/Get whether or not lightning is present.

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtLocalEnvironment::lightningPresent ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setAirTurbidity ( float  turbidity )

virtual

Set / get the air turbidity (haziness)

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::airTurbidity ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setVisibleDistance ( float  distance )

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.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::visibleDistance ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setWindSpeed ( float  windSpeed )

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.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::windSpeed ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setWindDirection ( float  direction )

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.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::windDirection ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setPrecipitationType ( PrecipitationType  type )

virtual

Set / get the precipitation type.

Implements makVrv::DtEnvironmentInterface.

virtual PrecipitationType makVrf::DtLocalEnvironment::precipitationType ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setPrecipitationIntensity ( float  intensity )

virtual

Set / get the precipitation intensity.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::precipitationIntensity ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::updateOrAddElevationalConfiguration ( const DtElevationalConfigurationRecord &  record )

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.

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtLocalEnvironment::getElevationalConfiguration ( float  baseMSLAltitude, makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord &  wRec  ) const

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.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::removeElevationalConfiguration ( float  baseMSLAltitude )

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.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::moveElevationalConfiguration ( float  oldBaseMSLAltitude, float  newBaseMSLAltitude  )

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.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setWindSpeedAtMSLAltitude ( float  mslAltitude, float  windSpeed  )

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.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::windSpeedAtMSLAltitude ( float  mslAltitude ) const

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.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setWindDirectionAtMSLAltitude ( float  mslAltitude, float  windDirection  )

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::windDirectionAtMSLAltitude ( float  mslAltitude ) const

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setVisibilityDistanceAtMSLAltitude ( float  mslAltitude, float  visibilityDistance  )

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.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::visibilityDistanceAtMSLAltitude ( float  mslAltitude ) const

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.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setObscurantAtMSLAltitude ( float  mslAltitude, VisibilityObscurant  obscurant  )

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.

Implements makVrv::DtEnvironmentInterface.

virtual VisibilityObscurant makVrf::DtLocalEnvironment::obscurantAtMSLAltitude ( float  mslAltitude ) const

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.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setCloudTypeAtMSLAltitude ( float  mslAltitude, CloudType  cloudType  )

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.

Implements makVrv::DtEnvironmentInterface.

virtual CloudType makVrf::DtLocalEnvironment::cloudTypeAtMSLAltitude ( float  mslAltitude ) const

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.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSkyCoverageAtMSLAltitude ( float  mslAltitude, float  skyCoverage  )

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::skyCoverageAtMSLAltitude ( float  mslAltitude ) const

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setAmbientAirTemperature ( float  temperature )

virtual

Set / get the ambient air temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::ambientAirTemperature ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setAmbientAirPressure ( float  pressure )

virtual

Set/Get the ambient air pressure in Pascals.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::ambientAirPressure ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setAirPressureAltitude ( float  altitude )

virtual

Set/Get the air pressure altitude in meters

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::airPressureAltitude ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setAirTemperatureAltitude ( float  altitude )

virtual

Set/Get the air temperature altitude in meters

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::airTemperatureAltitude ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setAirPressureAltitudeIsSeaLevel ( bool  seaLevel )

virtual

Set/Get the air pressure altitude is sea level

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtLocalEnvironment::airPressureAltitudeIsSeaLevel ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setAirTemperatureAltitudeIsSeaLevel ( bool  seaLevel )

virtual

Set/Get the air temperature altitude is sea level

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtLocalEnvironment::airTemperatureAltitudeIsSeaLevel ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSeaLevelWaterConcentration ( float  water )

virtual

get/set the sea level water concentration in PPMV

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::seaLevelWaterConcentration ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setFogHeight ( float  height )

virtual

Set / get the fog ceiling height in meters.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::fogHeight ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setFogColor ( const DtVector &  color )

virtual

Set / get the fog color in normalized color components.

Implements makVrv::DtEnvironmentInterface.

virtual DtVector makVrf::DtLocalEnvironment::fogColor ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setGroundFogColor ( const DtVector &  color )

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual DtVector makVrf::DtLocalEnvironment::groundFogColor ( ) const

overridevirtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSeaState ( int  state )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual int makVrf::DtLocalEnvironment::seaState ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSeaStateDirection ( float  dir )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::seaStateDirection ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setWindDrivenSeaState ( bool  enabled )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtLocalEnvironment::windDrivenSeaState ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSwellState ( int  state )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual int makVrf::DtLocalEnvironment::swellState ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSwellStateDirection ( float  dir )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::swellStateDirection ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setWindFetch ( float  distance )

virtual

Set / get the ocean fetch.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::windFetch ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSeaChoppiness ( float  chop )

virtual

Set / get the amount of chop on the sea.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::seaChoppiness ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

void makVrf::DtLocalEnvironment::setUnderwaterVisibilityEnabled ( bool  enabled )

virtual

Set / Get underwater visibility enabled.

Implements makVrv::DtEnvironmentInterface.

bool makVrf::DtLocalEnvironment::underwaterVisibilityEnabled ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setUnderwaterVisibility ( float  distance )

virtual

Set / get the maximum visibility under water in meters.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::underwaterVisibility ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setWaterSurfaceTransparency ( float  normalizedValue )

virtual

Set / get the transparency value of water surface.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::waterSurfaceTransparency ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSurgeDepth ( float  meters )

virtual

Set / Get the surge depth in distance.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::surgeDepth ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setDepthOffset ( float  meters )

virtual

Set / Get the depth offset in distance.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::depthOffset ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setAmbientWaterTemperature ( float  temperature )

virtual

Set / get the ambient water temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::ambientWaterTemperature ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setWaterCurrentSpeed ( float  speed )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::waterCurrentSpeed ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setWaterCurrentDirection ( float  direction )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::waterCurrentDirection ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setTidalOffset ( float  meters )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::tidalOffset ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setTidalDirection ( bool  inOut )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual bool makVrf::DtLocalEnvironment::tidalDirection ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the thermocline depths.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::thermoclineDepth ( unsigned int  layer ) const

virtual

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the thermocline permeability.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::thermoclinePermeability ( unsigned int  layer ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setGroundSnowAccumulation ( float  depth )

virtual

Set / get the ground snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::groundSnowAccumulation ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setRoadSnowAccumulation ( float  depth )

virtual

Set / get the road snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::roadSnowAccumulation ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSnowMinimumElevation ( float  elevation )

virtual

Set / get the snow minimum elevation.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::snowMinimumElevation ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSnowElevationTransition ( float  elevation )

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::snowElevationTransition ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setGroundRainAccumulation ( float  depth )

virtual

Set / get the ground rain accumulation depth.

Implements makVrv::DtEnvironmentInterface.

virtual float makVrf::DtLocalEnvironment::groundRainAccumulation ( ) const

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::loadDefaults ( bool  loadOnlyFactorySettings = false )

virtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::getRecord ( makArchives::DtEnvironmentRecord &  record )

virtual

Put the current environment conditions into a record.

Parameters

[out]

record

is the record to be populated with data.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setFromRecord ( const makArchives::DtEnvironmentRecord &  record )

virtual

Set the current environment conditions from a record.

Parameters

[in]

record

is the record to read the data from.

Implements makVrv::DtEnvironmentInterface.

virtual makArchives::DtEnvironmentRecord makVrf::DtLocalEnvironment::environmentConditionRecord ( const std::string &  )

virtual

Returns the environment record for the environment condition name.

virtual void makVrf::DtLocalEnvironment::saveEnvironment ( const std::string &  name )

virtual

Save the current environment with the given name.

Parameters

[in]

name

is the name of the environment to save.

Note

If an environment with the given name does not exist, the current environment will be saved as a new environment. If an environment with the given name does exist, the environment will be over written with current environment settings.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setEnvironment ( const std::string &  name )

virtual

Set the current environment to the environment of the given name.

Parameters

[in]

name

is the name of the environment to set.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::removeEnvironment ( const std::string &  name )

virtual

Remove an environment with the given name.

Parameters

[in]

name

is the name of the environment to remove.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Rename an environment entry.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::getEnvironmentNames ( std::vector< std::string > &  names, bool  includeLocalOnlyEnvironment = true  )

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.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set the name of the default environment conditions.

Parameters

[in]

name

is the name of the default environment.

Implements makVrv::DtEnvironmentInterface.

virtual std::string makVrf::DtLocalEnvironment::defaultEnvironmentName ( ) const

virtual

Get the name of the default environment conditions.

Returns

The name of the default environment.

Implements makVrv::DtEnvironmentInterface.

void makVrf::DtLocalEnvironment::restore ( )

inlinevirtual

Restores to backup settings from startup default.

Implements makVrv::DtEnvironmentInterface.

void makVrf::DtLocalEnvironment::saveAsDefaults ( )

virtual

Save the current settings as the default settings.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::exportSettings ( const std::string &  filename )

inlinevirtual

Import / export the list of named conditions (.enlx file)

Implements makVrv::DtEnvironmentInterface.

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

inlinevirtual

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::slot_coordinateSystemChanged ( )

inlinevirtual

\name Slots for handling changes in the simulation.

Handle current coordinate system changes

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::slot_oceanLayerAdded ( const makVrv::DtOceanLayer &  layer )

inlinevirtual

Handle an ocean layer being added.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::slot_oceanLayerToBeDeleted ( const makVrv::DtOceanLayer &  layer )

inlinevirtual

Handle an ocean layer being removed.

Implements makVrv::DtEnvironmentInterface.

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

inlinevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

inlinevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::slot_surgeDepthChanged ( double  depth )

inlinevirtual

Handle a change to surge depth.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::slot_depthOffsetChanged ( double  offset )

inlinevirtual

Handle a change to depth offset.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::autoSave ( )

virtual

Member Data Documentation

makVrv::DtDe& makVrf::DtLocalEnvironment::myDe

protected

makArchives::DtEnvironmentRecord makVrf::DtLocalEnvironment::myCurrentSettings

protected

This is an env record that reflects our current settings.

makVrv::DtEnvironmentList makVrf::DtLocalEnvironment::myEnvironmentList

protected

This is an env list that reflects saved settings.

DtVector makVrf::DtLocalEnvironment::myGroundFogColor

protected

Until this is in an environment record.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfGuiCore/localEnvironment.h