The DtEnvironment configures the environmental effects for a scene. Environmental effects include clouds, precipitation, air turbidity, ambient air temperature and visibility.

Inheritance diagram for makVrv::DtEnvironment:

[legend]

Public Member Functions
	DtEnvironment (DtDe &de)

virtual	~DtEnvironment ()

virtual void	init ()

virtual void	getRecord (makArchives::DtEnvironmentRecord &record)

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

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

virtual void	updateOrAddElevationalConfiguration (const DtElevationalConfigurationRecord &record)

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

virtual void	removeElevationalConfiguration (float baseMSLAltitude)

virtual void	moveElevationalConfiguration (float oldBaseMSLAltitude, float newBaseMSLAltitude)

virtual void	setWindSpeedAtMSLAltitude (float mslAltitude, float windSpeed)

virtual float	windSpeedAtMSLAltitude (float mslAltitude) const

virtual void	setWindDirectionAtMSLAltitude (float mslAltitude, float windDirection)

virtual float	windDirectionAtMSLAltitude (float mslAltitude) const

virtual void	setVisibilityDistanceAtMSLAltitude (float mslAltitude, float visibilityDistance)

virtual float	visibilityDistanceAtMSLAltitude (float mslAltitude) const

virtual void	setObscurantAtMSLAltitude (float mslAltitude, VisibilityObscurant obscurant)

virtual VisibilityObscurant	obscurantAtMSLAltitude (float mslAltitude) const

virtual void	setCloudTypeAtMSLAltitude (float mslAltitude, CloudType cloudType)

virtual CloudType	cloudTypeAtMSLAltitude (float mslAltitude) const

virtual void	setSkyCoverageAtMSLAltitude (float mslAltitude, float skyCoverage)

virtual float	skyCoverageAtMSLAltitude (float mslAltitude) const

virtual float	lightLevel () const

const DtSettingsBackup *	settingsBackup () const

DtSettingsBackup *	settingsBackup ()

virtual float	seaLevel () const

virtual void	initializeEnvironmentSettings ()


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

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

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

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

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

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

virtual std::string	defaultEnvironmentName () const


virtual void	setLightningPresent (bool lightningPresent)

virtual bool	lightningPresent () const


virtual void	setAirTurbidity (float turbidity)

virtual float	airTurbidity () const


virtual void	setVisibleDistance (float distance)

virtual float	visibleDistance () const


virtual void	setWindSpeed (float windSpeed)

virtual float	windSpeed () const


virtual void	setWindDirection (float direction)

virtual float	windDirection () const


virtual void	setPrecipitationType (PrecipitationType type)

virtual PrecipitationType	precipitationType () const


virtual void	setPrecipitationIntensity (float intensity)

virtual float	precipitationIntensity () const


virtual void	setAmbientAirTemperature (float temperature)

virtual float	ambientAirTemperature () const


virtual void	setAmbientAirPressure (float pressure)

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)

virtual float	fogHeight () const


virtual void	setFogColor (const DtVector &color)

virtual DtVector	fogColor () const


virtual void	setGroundFogColor (const DtVector &color) override

virtual DtVector	groundFogColor () const override


virtual void	setSeaState (DtDouglasSeaState::Scale state)

virtual DtDouglasSeaState::Scale	seaState () const


virtual void	setSeaStateDirection (float dir)

virtual float	seaStateDirection () const


virtual void	setWindDrivenSeaState (bool enabled)

virtual bool	windDrivenSeaState () const


virtual void	setSwellState (DtDouglasSwellState::Scale state)

virtual DtDouglasSwellState::Scale	swellState () const


virtual void	setSwellStateDirection (float dir)

virtual float	swellStateDirection () const


virtual void	setWindFetch (float distance)

virtual float	windFetch () const


virtual void	setSeaChoppiness (float chop)

virtual float	seaChoppiness () const


void	setUnderwaterVisibilityEnabled (bool enabled)

bool	underwaterVisibilityEnabled () const


virtual void	setUnderwaterVisibility (float distance)

virtual float	underwaterVisibility () const


virtual void	setWaterSurfaceTransparency (float normalizedValue)

virtual float	waterSurfaceTransparency () const


virtual void	setSurgeDepth (float meters)

virtual float	surgeDepth () const


virtual void	setDepthOffset (float meters)

virtual float	depthOffset () const


virtual void	setAmbientWaterTemperature (float temperature)

virtual float	ambientWaterTemperature () const


virtual void	setWaterCurrentSpeed (float speed)

virtual float	waterCurrentSpeed () const


virtual void	setWaterCurrentDirection (float direction)

virtual float	waterCurrentDirection () const


virtual void	setTidalOffset (float meters)

virtual float	tidalOffset () const


virtual void	setTidalDirection (bool inOut)

virtual bool	tidalDirection () const


virtual void	setThermoclineDepth (unsigned int layer, float depth)

virtual float	thermoclineDepth (unsigned int layer) const


virtual void	setThermoclinePermeability (unsigned int layer, float permeability)

virtual float	thermoclinePermeability (unsigned int layer) const


virtual void	setGroundSnowAccumulation (float depth)

virtual float	groundSnowAccumulation () const


virtual void	setRoadSnowAccumulation (float depth)

virtual float	roadSnowAccumulation () const


virtual void	setSnowMinimumElevation (float elevation)

virtual float	snowMinimumElevation () const


virtual void	setSnowElevationTransition (float elevation)

virtual float	snowElevationTransition () const


virtual void	setGroundRainAccumulation (float depth)

virtual float	groundRainAccumulation () const


virtual DtUniqueID	addLocalWind (WindType localWindType)

virtual void	removeLocalWind (DtUniqueID id) const


virtual void	setLocalWindLocation (DtUniqueID id, DtVector loc)


virtual void	setLocalWindSpeed (DtUniqueID id, float windSpeed)


void	loadDefaults (bool loadOnlyFactorySettings=false)

void	restore ()

void	saveAsDefaults ()


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

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

Public Member Functions inherited from makVrv::DtEnvironmentInterface
	DtEnvironmentInterface ()

virtual	~DtEnvironmentInterface ()

Protected Types
typedef std::vector< DtCloudLayer >	CloudLayersVector

Protected Member Functions
virtual void	resetClouds ()

virtual void	refreshCloudLayerThicknessIfNeeded ()

virtual void	clearCloudsFromSky ()

virtual void	addElevationalCloudLayersToCloudCoverManagerIfNeeded ()

virtual void	sendToSkyAllCloudLayers ()

virtual void	initializeCloudLayerRecordByCloudType (makArchives::DtCloudLayerRecord &) const

virtual void	sendToSkyCloudLayerAdded (DtCloudLayerId layerId)

virtual void	sendToSkyCloudLayerEnabled (DtCloudLayerId layerId, bool enabled)

virtual void	sendToSkyCloudLayerRemoved (DtCloudLayerId layerId)

virtual void	sendToSkyCloudLayerModified (DtCloudLayerId layerId)


DtDe &	myDe

DtAgentManagerInterface &	mySceneInterface

DtSkyObjectAgent *	mySkyObject

DtDynamicOceanObjectAgent *	myDynamicOceanObject

DtWeatherEffectsObjectAgent *	myWeatherEffectsObject

DtRecordSettingsBackupInterface *	mySettingsBackup

DtSignalConnectionManager	myConnections

DtSignalConnectionManager	myRemoteEnvironmentConnections

makArchives::DtEnvironmentRecord	myCurrentSettings

std::string	myEnvironmentRecordNameToRestore

DtEnvironmentList	myEnvironmentList

DtLocalWindObjectManager &	myLocalWindManager

float	mySeaLevel

DtVector	myGroundFogColor

virtual void	slot_listenToRemoteEnvironmentSettingsChanged (bool allowSimMessages)

virtual void	slot_cloudCoverCloudLayerEnabledChanged (DtCloudLayerId layerId, bool enableState)

virtual void	slot_cloudCoverCloudLayerModified (DtCloudLayerId layerId)

virtual void	slot_cloudCoverCloudLayerPositionAndOrientationChanged (DtCloudLayerId layerId, const DtVector &position, float orientation)

virtual void	slot_cloudCoverCloudLayerAdded (DtCloudLayerId layerId)

virtual void	slot_cloudCoverCloudLayerToBeRemoved (DtCloudLayerId layerId)

virtual void	slot_cloudCoverToBeRemoved (const std::string &cloudCoverName)

virtual void	slot_coordinateSystemChanged ()

virtual void	slot_oceanLayerAdded (const DtOceanLayer &layer)

virtual void	slot_oceanLayerToBeDeleted (const DtOceanLayer &layer)

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

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

virtual void	slot_surgeDepthChanged (double depth)

virtual void	slot_depthOffsetChanged (double offset)

virtual void	updateEnvironment ()

virtual void	initializeOcean ()

virtual void	enableCurrentCloudCoverLayers ()

virtual void	disableCurrentCloudCoverLayers ()

virtual void	autoSave ()

virtual void	sendMarineEnvironmentToOceanObject ()

virtual void	sendWeatherEnvironmentToSkyObject ()

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 std::string	theRemoteEnvironmentName

static const float	theMaximumVisibilityDistance

Member Typedef Documentation

typedef std::vector<DtCloudLayer> makVrv::DtEnvironment::CloudLayersVector

protected

Constructor & Destructor Documentation

makVrv::DtEnvironment::DtEnvironment ( DtDe & de )

CTOR.

virtual makVrv::DtEnvironment::~DtEnvironment ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtEnvironment::init ( )

virtual

Initialize the Environment object (like preloading all known cloud layers) before the first environment record is loaded.

virtual void makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::environmentConditionRecord ( const std::string & )

virtual

Returns the environment record for the environment condition name.

virtual void makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::renameEnvironment	(	const std::string &	oldName,
		const std::string &	newName
	)

virtual

Rename an environment entry.

Implements makVrv::DtEnvironmentInterface.

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

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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::defaultEnvironmentName ( ) const

virtual

Get the name of the default environment conditions.

Returns: The name of the default environment.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get whether or not lightning is present.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get whether or not lightning is present.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the air turbidity (haziness)

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the air turbidity (haziness)

Implements makVrv::DtEnvironmentInterface.

virtual void makVrv::DtEnvironment::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 makVrv::DtEnvironment::visibleDistance ( ) const

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 void makVrv::DtEnvironment::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 makVrv::DtEnvironment::windSpeed ( ) const

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 void makVrv::DtEnvironment::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 makVrv::DtEnvironment::windDirection ( ) const

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 void makVrv::DtEnvironment::setPrecipitationType ( PrecipitationType type )

virtual

Set / get the precipitation type.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the precipitation type.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the precipitation intensity.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the precipitation intensity.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::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 makVrv::DtEnvironment::setAmbientAirTemperature ( float temperature )

virtual

Set / get the ambient air temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the ambient air temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the ambient air pressure in Pascals.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the ambient air pressure in Pascals.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the air pressure altitude in meters.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the air pressure altitude in meters.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the air temperature altitude in meters.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the air temperature altitude in meters.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the air pressure altitude is sea level.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the air pressure altitude is sea level.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the air temperature altitude is sea level.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set/Get the air temperature altitude is sea level.

Implements makVrv::DtEnvironmentInterface.

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

virtual

get/set the sea level water concentration in PPMV

Implements makVrv::DtEnvironmentInterface.

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

virtual

get/set the sea level water concentration in PPMV

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the fog ceiling height in meters.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the fog ceiling height in meters.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the fog color in normalized color components.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the fog color in normalized color components.

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

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

overridevirtual

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrv::DtEnvironment::setSeaState ( DtDouglasSeaState::Scale state )

virtual

Set / get the sea state conditions based on the Douglas sea scale. (http://en.wikipedia.org/wiki/Douglas_Sea_Scale)

Implements makVrv::DtEnvironmentInterface.

virtual DtDouglasSeaState::Scale makVrv::DtEnvironment::seaState ( ) const

virtual

Set / get the sea state conditions based on the Douglas sea scale. (http://en.wikipedia.org/wiki/Douglas_Sea_Scale)

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the sea state direction, in radians from True North.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the sea state direction, in radians from True North.

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

virtual void makVrv::DtEnvironment::setSwellState ( DtDouglasSwellState::Scale state )

virtual

Set / get the sea swell conditions based on the Douglas sea scale. (http://en.wikipedia.org/wiki/Douglas_Sea_Scale)

Implements makVrv::DtEnvironmentInterface.

virtual DtDouglasSwellState::Scale makVrv::DtEnvironment::swellState ( ) const

virtual

Set / get the sea swell conditions based on the Douglas sea scale. (http://en.wikipedia.org/wiki/Douglas_Sea_Scale)

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the direction, in radians from True North, of sea swells.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the direction, in radians from True North, of sea swells.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the ocean fetch.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the ocean fetch.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the amount of chop on the sea.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the amount of chop on the sea.

Implements makVrv::DtEnvironmentInterface.

void makVrv::DtEnvironment::setUnderwaterVisibilityEnabled ( bool enabled )

virtual

Set / Get underwater visibility enabled.

Implements makVrv::DtEnvironmentInterface.

bool makVrv::DtEnvironment::underwaterVisibilityEnabled ( ) const

virtual

Set / Get underwater visibility enabled.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the maximum visibility under water in meters.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the maximum visibility under water in meters.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the transparency value of water surface.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the transparency value of water surface.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / Get the surge depth in distance.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / Get the surge depth in distance.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / Get the depth offset in distance.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / Get the depth offset in distance.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the ambient water temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the ambient water temperature, in Kelvins.

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the thermocline depths.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the thermocline depths.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the thermocline permeability.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the thermocline permeability.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the ground snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the ground snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the road snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the road snow accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the snow minimum elevation.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the snow minimum elevation.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrv::DtEnvironment::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 makVrv::DtEnvironment::snowElevationTransition ( ) const

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 void makVrv::DtEnvironment::setGroundRainAccumulation ( float depth )

virtual

Set / get the ground rain accumulation depth.

Implements makVrv::DtEnvironmentInterface.

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

virtual

Set / get the ground rain accumulation depth.

Implements makVrv::DtEnvironmentInterface.

virtual DtUniqueID makVrv::DtEnvironment::addLocalWind ( WindType localWindType )

virtual

Add / remove winds for osgEarth (ex. for rotorwash) Adding a wind will generate a unique ID for that wind which can be used later on in /see DtEnvironment and /see DtLocalWindObjectManager.

virtual void makVrv::DtEnvironment::removeLocalWind ( DtUniqueID id ) const

virtual

Add / remove winds for osgEarth (ex. for rotorwash) Adding a wind will generate a unique ID for that wind which can be used later on in /see DtEnvironment and /see DtLocalWindObjectManager.

virtual void makVrv::DtEnvironment::setLocalWindLocation	(	DtUniqueID	id,
		DtVector	loc
	)

virtual

Set wind location based on id.

virtual void makVrv::DtEnvironment::setLocalWindSpeed	(	DtUniqueID	id,
		float	windSpeed
	)

virtual

Set wind speed based on id. Speed is meter/second.

virtual float makVrv::DtEnvironment::lightLevel ( ) const

virtual

Get the current prevailing ambient light value Allows thing to be activated/deactivated by light level; values gp from 0. (total darkness) to 1. (noon-day sun )

void makVrv::DtEnvironment::loadDefaults ( bool loadOnlyFactorySettings = false )

virtual

Load default settings.

Parameters

[in] loadOnlyFactorySettings flag to load factory settings.

Implements makVrv::DtEnvironmentInterface.

void makVrv::DtEnvironment::restore ( )

virtual

Restores to backup settings from startup default.

Implements makVrv::DtEnvironmentInterface.

void makVrv::DtEnvironment::saveAsDefaults ( )

virtual

Save the current settings as the default settings.

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

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

virtual

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

Implements makVrv::DtEnvironmentInterface.

const DtSettingsBackup* makVrv::DtEnvironment::settingsBackup ( ) const

inline

DtSettingsBackup* makVrv::DtEnvironment::settingsBackup ( )

inline

virtual float makVrv::DtEnvironment::seaLevel ( ) const

virtual

Returns the current sea level.

virtual void makVrv::DtEnvironment::initializeEnvironmentSettings ( )

virtual

Initialize environment settings (cloud cover and settings from default record)

virtual void makVrv::DtEnvironment::resetClouds ( )

protectedvirtual

Reset all pre-loaded cloud layers by removing them from the Sky object and adding them back in. Ran on initialization and whenever the coordinate system changes.

All cloud layers are sent to the Sky object and are enabled/disabled when needed.

virtual void makVrv::DtEnvironment::refreshCloudLayerThicknessIfNeeded ( )

protectedvirtual

Refresh the thickness of all the cloud layers for the current environment configuration, if needed, based on the base MSL altitudes of all the elevational configurations being maintained.

virtual void makVrv::DtEnvironment::clearCloudsFromSky ( )

protectedvirtual

Remove all cloud layers from the internal Sky object.

virtual void makVrv::DtEnvironment::addElevationalCloudLayersToCloudCoverManagerIfNeeded ( )

protectedvirtual

Add the cloud covers/layers from all the elevational configurations for all environment configurations being maintained to the cloud cover manager, if needed.

virtual void makVrv::DtEnvironment::sendToSkyAllCloudLayers ( )

protectedvirtual

Send all cloud layers to the internal Sky object and make them all disabled.

virtual void makVrv::DtEnvironment::initializeCloudLayerRecordByCloudType ( makArchives::DtCloudLayerRecord & ) const

protectedvirtual

virtual void makVrv::DtEnvironment::sendToSkyCloudLayerAdded ( DtCloudLayerId layerId )

protectedvirtual

virtual void makVrv::DtEnvironment::sendToSkyCloudLayerEnabled	(	DtCloudLayerId	layerId,
		bool	enabled
	)

protectedvirtual

virtual void makVrv::DtEnvironment::sendToSkyCloudLayerRemoved ( DtCloudLayerId layerId )

protectedvirtual

virtual void makVrv::DtEnvironment::sendToSkyCloudLayerModified ( DtCloudLayerId layerId )

protectedvirtual

virtual void makVrv::DtEnvironment::slot_listenToRemoteEnvironmentSettingsChanged ( bool allowSimMessages )

protectedvirtual

Slots connected to the Sky Conditions Manager.

virtual void makVrv::DtEnvironment::slot_cloudCoverCloudLayerEnabledChanged	(	DtCloudLayerId	layerId,
		bool	enableState
	)

protectedvirtual

Slots connected to the Sky Conditions Manager.

virtual void makVrv::DtEnvironment::slot_cloudCoverCloudLayerModified ( DtCloudLayerId layerId )

protectedvirtual

Slots connected to the Sky Conditions Manager.

virtual void makVrv::DtEnvironment::slot_cloudCoverCloudLayerPositionAndOrientationChanged	(	DtCloudLayerId	layerId,
		const DtVector &	position,
		float	orientation
	)

protectedvirtual

Slots connected to the Sky Conditions Manager.

virtual void makVrv::DtEnvironment::slot_cloudCoverCloudLayerAdded ( DtCloudLayerId layerId )

protectedvirtual

Slots connected to the Sky Conditions Manager.

virtual void makVrv::DtEnvironment::slot_cloudCoverCloudLayerToBeRemoved ( DtCloudLayerId layerId )

protectedvirtual

Slots connected to the Sky Conditions Manager.

virtual void makVrv::DtEnvironment::slot_cloudCoverToBeRemoved ( const std::string & cloudCoverName )

protectedvirtual

Slots connected to the Sky Conditions Manager.

virtual void makVrv::DtEnvironment::slot_coordinateSystemChanged ( )

protectedvirtual

Called when the current coordinate system changes.

Implements makVrv::DtEnvironmentInterface.

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

protectedvirtual

Called by signal when an ocean layer is added.

Implements makVrv::DtEnvironmentInterface.

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

protectedvirtual

Called by signal when an ocean layer is about to be removed.

Implements makVrv::DtEnvironmentInterface.

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

protectedvirtual

Called by signal when an ocean layer's sea level changes.

Implements makVrv::DtEnvironmentInterface.

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

protectedvirtual

Called by signal when an ocean layer's lod range (the altitude at which we LOD out dynamic ocean) changes.

Implements makVrv::DtEnvironmentInterface.

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

protectedvirtual

Called by signal when the surge depth changes.

Implements makVrv::DtEnvironmentInterface.

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

protectedvirtual

Called by signal when the depth offset changes.

Implements makVrv::DtEnvironmentInterface.

virtual void makVrv::DtEnvironment::updateEnvironment ( )

protectedvirtual

Update the environment settings for the current environment.

virtual void makVrv::DtEnvironment::initializeOcean ( )

protectedvirtual

Initialize the (distributed) dynamic ocean object with the current environmental values.

virtual void makVrv::DtEnvironment::enableCurrentCloudCoverLayers ( )

protectedvirtual

enables selected cloud cover

virtual void makVrv::DtEnvironment::disableCurrentCloudCoverLayers ( )

protectedvirtual

Slots connected to the Sky Conditions Manager.

virtual void makVrv::DtEnvironment::autoSave ( )

protectedvirtual

Slots connected to the Sky Conditions Manager.

virtual void makVrv::DtEnvironment::sendMarineEnvironmentToOceanObject ( )

protectedvirtual

Helper function to set the appropriate marine environment on a dynamic ocean object.

virtual void makVrv::DtEnvironment::sendWeatherEnvironmentToSkyObject ( )

protectedvirtual

Helper function to set the appropriate weather environment on a sky object.

Member Data Documentation

DtDe& makVrv::DtEnvironment::myDe

protected

Slots connected to the Sky Conditions Manager.

DtAgentManagerInterface& makVrv::DtEnvironment::mySceneInterface

protected

Slots connected to the Sky Conditions Manager.

DtSkyObjectAgent* makVrv::DtEnvironment::mySkyObject

protected

Slots connected to the Sky Conditions Manager.

DtDynamicOceanObjectAgent* makVrv::DtEnvironment::myDynamicOceanObject

protected

Slots connected to the Sky Conditions Manager.

DtWeatherEffectsObjectAgent* makVrv::DtEnvironment::myWeatherEffectsObject

protected

Slots connected to the Sky Conditions Manager.

DtRecordSettingsBackupInterface* makVrv::DtEnvironment::mySettingsBackup

protected

Slots connected to the Sky Conditions Manager.

DtSignalConnectionManager makVrv::DtEnvironment::myConnections

protected

Slots connected to the Sky Conditions Manager.

DtSignalConnectionManager makVrv::DtEnvironment::myRemoteEnvironmentConnections

protected

Slots connected to the Sky Conditions Manager.

makArchives::DtEnvironmentRecord makVrv::DtEnvironment::myCurrentSettings

protected

Slots connected to the Sky Conditions Manager.

std::string makVrv::DtEnvironment::myEnvironmentRecordNameToRestore

protected

Slots connected to the Sky Conditions Manager.

DtEnvironmentList makVrv::DtEnvironment::myEnvironmentList

protected

Slots connected to the Sky Conditions Manager.

DtLocalWindObjectManager& makVrv::DtEnvironment::myLocalWindManager

protected

Slots connected to the Sky Conditions Manager.

float makVrv::DtEnvironment::mySeaLevel

protected

Slots connected to the Sky Conditions Manager.

DtVector makVrv::DtEnvironment::myGroundFogColor

protected

Slots connected to the Sky Conditions Manager.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtEnvironment.h

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation