makVrf::DtLocalEnvironment Class Reference

Inheritance diagram for makVrf::DtLocalEnvironment:

Public Member Functions
	DtLocalEnvironment (makVrv::DtDe &de)
virtual	~DtLocalEnvironment () override
virtual void	updateOrAddElevationalConfiguration (const DtElevationalConfigurationRecord &record) override
virtual bool	getElevationalConfiguration (float baseMSLAltitude, makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord &wRec) const override
virtual void	removeElevationalConfiguration (float baseMSLAltitude) override
virtual void	moveElevationalConfiguration (float oldBaseMSLAltitude, float newBaseMSLAltitude) override
virtual void	setWindSpeedAtMSLAltitude (float mslAltitude, float windSpeed) override
virtual float	windSpeedAtMSLAltitude (float mslAltitude) const override
virtual void	setWindDirectionAtMSLAltitude (float mslAltitude, float windDirection) override
virtual float	windDirectionAtMSLAltitude (float mslAltitude) const override
virtual void	setVisibilityDistanceAtMSLAltitude (float mslAltitude, float visibilityDistance) override
virtual float	visibilityDistanceAtMSLAltitude (float mslAltitude) const override
virtual void	setObscurantAtMSLAltitude (float mslAltitude, VisibilityObscurant obscurant) override
virtual VisibilityObscurant	obscurantAtMSLAltitude (float mslAltitude) const override
virtual void	setCloudTypeAtMSLAltitude (float mslAltitude, CloudType cloudType) override
virtual CloudType	cloudTypeAtMSLAltitude (float mslAltitude) const override
virtual void	setSkyCoverageAtMSLAltitude (float mslAltitude, float skyCoverage) override
virtual float	skyCoverageAtMSLAltitude (float mslAltitude) const override
virtual void	setTidalDirection (bool inOut) override
virtual bool	tidalDirection () const override
virtual void	loadDefaults (bool loadOnlyFactorySettings=false) override
virtual void	getRecord (makArchives::DtEnvironmentRecord &record) const override
virtual void	setFromRecord (const makArchives::DtEnvironmentRecord &record) override
virtual makArchives::DtEnvironmentRecord	environmentConditionRecord (const std::string &)
virtual void	slot_coordinateSystemChanged () override
virtual void	slot_oceanLayerAdded (const makVrv::DtOceanLayer &layer) override
virtual void	slot_oceanLayerToBeDeleted (const makVrv::DtOceanLayer &layer) override
virtual void	slot_oceanLayerSeaLevelChanged (const makVrv::DtOceanLayer &layer, double seaLevel) override
virtual void	slot_oceanLayerLodRangeChanged (const makVrv::DtOceanLayer &layer, int range) override
virtual void	slot_surgeDepthChanged (double depth) override
virtual void	slot_depthOffsetChanged (double offset) override
virtual void	autoSave ()
virtual void	setLightningPresent (bool lightningPresent) override
virtual bool	lightningPresent () const override
virtual void	setAirTurbidity (float turbidity) override
virtual float	airTurbidity () const override
virtual void	setVisibleDistance (float distance) override
virtual float	visibleDistance () const override
virtual void	setWindSpeed (float windSpeed) override
virtual float	windSpeed () const override
virtual void	setWindDirection (float direction) override
virtual float	windDirection () const override
virtual void	setPrecipitationType (PrecipitationType type) override
virtual PrecipitationType	precipitationType () const override
virtual void	setPrecipitationIntensity (float intensity) override
virtual float	precipitationIntensity () const override
virtual void	setAmbientAirTemperature (float temperature) override
virtual float	ambientAirTemperature () const override
virtual void	setAmbientAirPressure (float pressure) override
virtual float	ambientAirPressure () const override
virtual void	setAirPressureAltitude (float altitude) override
virtual float	airPressureAltitude () const override
virtual void	setAirTemperatureAltitude (float altitude) override
virtual float	airTemperatureAltitude () const override
virtual void	setAirPressureAltitudeIsSeaLevel (bool seaLevel) override
virtual bool	airPressureAltitudeIsSeaLevel () const override
virtual void	setAirTemperatureAltitudeIsSeaLevel (bool seaLevel) override
virtual bool	airTemperatureAltitudeIsSeaLevel () const override
virtual void	setSeaLevelWaterConcentration (float water) override
virtual float	seaLevelWaterConcentration () const override
virtual void	setFogHeight (float height) override
virtual float	fogHeight () const override
virtual void	setFogColor (const DtVector &color) override
virtual DtVector	fogColor () const override
virtual void	setGroundFogColor (const DtVector &color) override
virtual DtVector	groundFogColor () const override
virtual void	setBlowingParticulateMatter (int)
virtual int	blowingParticulateMatter () const
virtual void	setSeaState (makVrv::DtDouglasSeaState::Scale state) override
virtual makVrv::DtDouglasSeaState::Scale	seaState () const override
virtual void	setSeaStateDirection (float dir) override
virtual float	seaStateDirection () const override
virtual void	setWindDrivenSeaState (bool enabled) override
virtual bool	windDrivenSeaState () const override
virtual void	setSwellState (makVrv::DtDouglasSwellState::Scale state) override
virtual makVrv::DtDouglasSwellState::Scale	swellState () const override
virtual void	setSwellStateDirection (float dir) override
virtual float	swellStateDirection () const override
virtual void	setWindFetch (float distance) override
virtual float	windFetch () const override
virtual void	setSeaChoppiness (float chop) override
virtual float	seaChoppiness () const override
virtual void	setUnderwaterVisibilityEnabled (bool enabled) override
virtual bool	underwaterVisibilityEnabled () const override
virtual void	setUnderwaterVisibility (float distance) override
virtual float	underwaterVisibility () const override
virtual void	setWaterSurfaceTransparency (float normalizedValue) override
virtual float	waterSurfaceTransparency () const override
virtual void	setSurgeDepth (float meters) override
virtual float	surgeDepth () const override
virtual void	setDepthOffset (float meters) override
virtual float	depthOffset () const override
virtual void	setAmbientWaterTemperature (float temperature) override
virtual float	ambientWaterTemperature () const override
virtual void	setWaterCurrentSpeed (float speed) override
virtual float	waterCurrentSpeed () const override
virtual void	setWaterCurrentDirection (float direction) override
virtual float	waterCurrentDirection () const override
virtual void	setTidalOffset (float meters) override
virtual float	tidalOffset () const override
virtual void	setThermoclineDepth (unsigned int layer, float depth) override
virtual float	thermoclineDepth (unsigned int layer) const override
virtual void	setThermoclinePermeability (unsigned int layer, float permeability) override
virtual float	thermoclinePermeability (unsigned int layer) const override
virtual void	setGroundSnowAccumulation (float depth) override
virtual float	groundSnowAccumulation () const override
virtual void	setRoadSnowAccumulation (float depth) override
virtual float	roadSnowAccumulation () const override
virtual void	setSnowMinimumElevation (float elevation) override
virtual float	snowMinimumElevation () const override
virtual void	setSnowElevationTransition (float elevation) override
virtual float	snowElevationTransition () const override
virtual void	setGroundRainAccumulation (float depth) override
virtual float	groundRainAccumulation () const override
virtual void	saveEnvironment (const std::string &name) override
virtual void	setEnvironment (const std::string &name) override
virtual void	removeEnvironment (const std::string &name) override
virtual void	renameEnvironment (const std::string &oldName, const std::string &newName) override
virtual void	getEnvironmentNames (std::vector< std::string > &names, bool includeLocalOnlyEnvironment=true) override
virtual void	setDefaultEnvironmentName (const std::string &name) override
virtual std::string	defaultEnvironmentName () const override
virtual void	restore () override
virtual void	saveAsDefaults () override
virtual void	exportSettings (const std::string &filename) override
virtual void	importSettings (const std::string &filename) override
Public Member Functions inherited from makVrv::DtEnvironmentInterface
	DtEnvironmentInterface ()
virtual	~DtEnvironmentInterface ()

Protected Attributes
makVrv::DtDe &	myDe
makArchives::DtEnvironmentRecord	myCurrentSettings
makVrv::DtEnvironmentList	myEnvironmentList
DtVector	myGroundFogColor

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::BlowingParticulateMatterType	BlowingParticulateMatterType
typedef makArchives::VisibilityObscurant	VisibilityObscurant
typedef makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord	DtElevationalConfigurationRecord
typedef DtCloudTypeMapper::CloudType	CloudType
Static Public Attributes inherited from makVrv::DtEnvironmentInterface
static const std::string	theRemoteEnvironmentName
static const float	theMaximumVisibilityDistance

Constructor & Destructor Documentation

makVrf::DtLocalEnvironment::DtLocalEnvironment

(

makVrv::DtDe &

de

)

virtual makVrf::DtLocalEnvironment::~DtLocalEnvironment ( )

overridevirtual

Member Function Documentation

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

overridevirtual

Set/Get whether or not lightning is present.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get whether or not lightning is present.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the air turbidity (haziness)

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the air turbidity (haziness)

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

overridevirtual

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 void makVrf::DtLocalEnvironment::setWindSpeed ( float  windSpeed )

overridevirtual

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

overridevirtual

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 void makVrf::DtLocalEnvironment::setWindDirection ( float  direction )

overridevirtual

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

overridevirtual

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 void makVrf::DtLocalEnvironment::setPrecipitationType ( PrecipitationType  type )

overridevirtual

Set / get the precipitation type.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the precipitation type.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the precipitation intensity.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the precipitation intensity.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

overridevirtual

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 )

overridevirtual

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  )

overridevirtual

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  )

overridevirtual

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

overridevirtual

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  )

overridevirtual

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

overridevirtual

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  )

overridevirtual

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

overridevirtual

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  )

overridevirtual

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

overridevirtual

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  )

overridevirtual

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

overridevirtual

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  )

overridevirtual

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

overridevirtual

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 )

overridevirtual

Set / get the ambient air temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the ambient air temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the ambient air pressure in Pascals.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the ambient air pressure in Pascals.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the air pressure altitude in meters.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the air pressure altitude in meters.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the air temperature altitude in meters.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the air temperature altitude in meters.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the air pressure altitude is sea level.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the air pressure altitude is sea level.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the air temperature altitude is sea level.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set/Get the air temperature altitude is sea level.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

get/set the sea level water concentration in PPMV

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

get/set the sea level water concentration in PPMV

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the fog ceiling height in meters.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the fog ceiling height in meters.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the fog color in normalized color components.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the fog color in normalized color components.

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

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setBlowingParticulateMatter ( int  )

virtual

Set / get the blowing particulate matter.. Not currently written to environment record.

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

virtual

Set / get the blowing particulate matter.. Not currently written to environment record.

virtual void makVrf::DtLocalEnvironment::setSeaState ( makVrv::DtDouglasSeaState::Scale  state )

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual makVrv::DtDouglasSeaState::Scale makVrf::DtLocalEnvironment::seaState ( ) const

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::setSwellState ( makVrv::DtDouglasSwellState::Scale  state )

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual makVrv::DtDouglasSwellState::Scale makVrf::DtLocalEnvironment::swellState ( ) const

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the ocean fetch.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the ocean fetch.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the amount of chop on the sea.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the amount of chop on the sea.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / Get underwater visibility enabled.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / Get underwater visibility enabled.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the maximum visibility under water in meters.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the maximum visibility under water in meters.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the transparency value of water surface.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the transparency value of water surface.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / Get the surge depth in distance.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / Get the surge depth in distance.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / Get the depth offset in distance.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / Get the depth offset in distance.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the ambient water temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the ambient water temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the thermocline depths.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the thermocline depths.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the thermocline permeability.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the thermocline permeability.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the ground snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the ground snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the road snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the road snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the snow minimum elevation.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the snow minimum elevation.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

overridevirtual

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 void makVrf::DtLocalEnvironment::setGroundRainAccumulation ( float  depth )

overridevirtual

Set / get the ground rain accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Set / get the ground rain accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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 )

overridevirtual

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 )

overridevirtual

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 )

overridevirtual

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 )

overridevirtual

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  )

overridevirtual

Rename an environment entry.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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 )

overridevirtual

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

overridevirtual

Get the name of the default environment conditions.

Returns

The name of the default environment.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::restore ( )

inlineoverridevirtual

Restores to backup settings from startup default.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::saveAsDefaults ( )

overridevirtual

Save the current settings as the default settings.

Implements makVrv::DtEnvironmentInterface.

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

inlineoverridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

inlineoverridevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrf::DtLocalEnvironment::slot_coordinateSystemChanged ( )

inlineoverridevirtual

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

inlineoverridevirtual

Handle an ocean layer being added.

Implements makVrv::DtEnvironmentInterface.

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

inlineoverridevirtual

Handle an ocean layer being removed.

Implements makVrv::DtEnvironmentInterface.

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

inlineoverridevirtual

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  )

inlineoverridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

inlineoverridevirtual

Handle a change to surge depth.

Implements makVrv::DtEnvironmentInterface.

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

inlineoverridevirtual

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.vrf5-2-branch/include/vrfGuiCore/localEnvironment.h