makVrv::DtEnvironment Class Reference

The DtEnvironment configures the environmental effects for a scene. More...

Public Types
enum	PrecipitationType { Rain = 0, Snow = 1 }

Public Member Functions
	DtEnvironment (DtDe &de, DtAgentManagerInterface &sceneInterface)
	CTOR.
	~DtEnvironment ()
	DTOR.
void	clear ()
	Clear all clouds, precipitation.
void	getRecord (makArchives::DtEnvironmentRecord &record)
	Get the environment by a record.
void	setFromRecord (const makArchives::DtEnvironmentRecord &record)
	Set the environment by a record.
void	addCloudLayer (const makArchives::DtCloudLayerRecord &record)
	Add a cloud layer. (It is enabled by default).
void	setCloudLayerEnabled (unsigned int index, bool enabled)
	Set whether a cloud layer is enabled (visible).
void	setCloudLayerPosition (unsigned int index, double xCoord, double yCoord)
	Sets the position of a cloud layer (not auto-saved)
void	removeCloudLayer (unsigned int index)
	Remove a cloud layer by index;.
void	setAirTurbidity (float turbidity)
	Set the air turbidity (haziness)
void	setVisibleDistance (float distance)
	Set the visible distance in meters.
void	setPrecipitationEnabled (bool enabled)
	Set whether precipitation is enabled.
void	setPrecipitationType (PrecipitationType type)
	Set the precipitation type.
void	setPrecipitationIntensity (float intensity)
	Set the precipitation intensity.
void	setWindSpeed (float speed)
	Set the wind speed in meters per second.
void	setWindDirection (float direction)
	Set the wind direction in radians from north (clockwise).
void	setAmbientAirTemperature (float temperature)
	Set the ambient air temperature in celsius.
void	setSeaState (int state)
	Set the sea state according to the Beaufort Scale.
void	setSeaChoppiness (float chop)
	Set the amount of chop on the sea.
void	setUnderwaterVisibility (float distance)
	Set the maximum visibility under water in meters.
void	setAmbientWaterTemperature (float temperature)
	Set the ambient water temperature in celsius.
void	setWaterCurrentSpeed (float speed)
	Set the speed of water currents in meters per second.
void	setWaterCurrentDirection (float direction)
	Set the direction of water currents in radians from north (clockwise).
void	setTidalOffset (float meters)
	Set the current tidal offset from mean-sea-level in meters.
void	setTidalDirection (bool inOut)
	Set the current direction of tidal flow (0=out, 1=in).
const makArchives::DtEnvironmentRecord &	settings () const
	Get the current settings.
void	loadDefaults (bool loadOnlyFactorySettings=false)
void	restore ()
void	saveAsDefaults ()
void	exportSettings (const std::string &fileName)
void	importSettings (const std::string &fileName)
const DtSettingsBackup *	settingsBackup () const
DtSettingsBackup *	settingsBackup ()

Static Public Member Functions
static int	translateCloudTypeStringToEnum (const std::string &str)
static std::string	translateCloudTypeEnumToString (int id)

Protected Member Functions
virtual void	slot_coordinateSystemChanged (const std::string &, const std::string &)
	Called when the current coordinate system changes.

Protected Attributes
DtDe &	myDe
DtAgentManagerInterface &	mySceneInterface
makArchives::DtEnvironmentRecord *	mySettings
DtSkyObjectAgent *	mySkyObject
DtRecordSettingsBackupInterface *	mySettingsBackup
DtSignalConnectionManager	myConnections

Detailed Description

The DtEnvironment configures the environmental effects for a scene.

Environmental effects include clouds, precipitation, air turbidity, and visibility

Member Enumeration Documentation

enum makVrv::DtEnvironment::PrecipitationType

Enumerator:

Rain
Snow

Constructor & Destructor Documentation

makVrv::DtEnvironment::DtEnvironment	(	DtDe &	de,
		DtAgentManagerInterface &	sceneInterface
	)

CTOR.

makVrv::DtEnvironment::~DtEnvironment

(

)

DTOR.

Member Function Documentation

void makVrv::DtEnvironment::clear

(

)

Clear all clouds, precipitation.

void makVrv::DtEnvironment::getRecord

(

makArchives::DtEnvironmentRecord &

record

)

Get the environment by a record.

void makVrv::DtEnvironment::setFromRecord

(

const makArchives::DtEnvironmentRecord &

record

)

Set the environment by a record.

void makVrv::DtEnvironment::addCloudLayer

(

const makArchives::DtCloudLayerRecord &

record

)

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

void makVrv::DtEnvironment::setCloudLayerEnabled	(	unsigned int	index,
		bool	enabled
	)

Set whether a cloud layer is enabled (visible).

void makVrv::DtEnvironment::setCloudLayerPosition	(	unsigned int	index,
		double	xCoord,
		double	yCoord
	)

Sets the position of a cloud layer (not auto-saved)

void makVrv::DtEnvironment::removeCloudLayer

(

unsigned int

index

)

Remove a cloud layer by index;.

void makVrv::DtEnvironment::setAirTurbidity

(

float

turbidity

)

Set the air turbidity (haziness)

void makVrv::DtEnvironment::setVisibleDistance

(

float

distance

)

Set the visible distance in meters.

void makVrv::DtEnvironment::setPrecipitationEnabled

(

bool

enabled

)

Set whether precipitation is enabled.

void makVrv::DtEnvironment::setPrecipitationType

(

PrecipitationType

type

)

Set the precipitation type.

void makVrv::DtEnvironment::setPrecipitationIntensity

(

float

intensity

)

Set the precipitation intensity.

void makVrv::DtEnvironment::setWindSpeed

(

float

speed

)

Set the wind speed in meters per second.

void makVrv::DtEnvironment::setWindDirection

(

float

direction

)

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

void makVrv::DtEnvironment::setAmbientAirTemperature

(

float

temperature

)

Set the ambient air temperature in celsius.

void makVrv::DtEnvironment::setSeaState

(

int

state

)

Set the sea state according to the Beaufort Scale.

void makVrv::DtEnvironment::setSeaChoppiness

(

float

chop

)

Set the amount of chop on the sea.

Note

This value may become obsolete.

void makVrv::DtEnvironment::setUnderwaterVisibility

(

float

distance

)

Set the maximum visibility under water in meters.

void makVrv::DtEnvironment::setAmbientWaterTemperature

(

float

temperature

)

Set the ambient water temperature in celsius.

void makVrv::DtEnvironment::setWaterCurrentSpeed

(

float

speed

)

Set the speed of water currents in meters per second.

void makVrv::DtEnvironment::setWaterCurrentDirection

(

float

direction

)

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

void makVrv::DtEnvironment::setTidalOffset

(

float

meters

)

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

void makVrv::DtEnvironment::setTidalDirection

(

bool

inOut

)

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

const makArchives::DtEnvironmentRecord& makVrv::DtEnvironment::settings

(

)

const

Get the current settings.

static int makVrv::DtEnvironment::translateCloudTypeStringToEnum ( const std::string &  str )

static

static std::string makVrv::DtEnvironment::translateCloudTypeEnumToString ( int  id )

static

void makVrv::DtEnvironment::loadDefaults

(

bool

loadOnlyFactorySettings = false

)

void makVrv::DtEnvironment::restore

(

)

void makVrv::DtEnvironment::saveAsDefaults

(

)

void makVrv::DtEnvironment::exportSettings

(

const std::string &

fileName

)

void makVrv::DtEnvironment::importSettings

(

const std::string &

fileName

)

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

inline

DtSettingsBackup* makVrv::DtEnvironment::settingsBackup ( )

inline

virtual void makVrv::DtEnvironment::slot_coordinateSystemChanged ( const std::string &  , const std::string &    )

protectedvirtual

Called when the current coordinate system changes.

Member Data Documentation

DtDe& makVrv::DtEnvironment::myDe

protected

DtAgentManagerInterface& makVrv::DtEnvironment::mySceneInterface

protected

makArchives::DtEnvironmentRecord* makVrv::DtEnvironment::mySettings

protected

DtSkyObjectAgent* makVrv::DtEnvironment::mySkyObject

protected

DtRecordSettingsBackupInterface* makVrv::DtEnvironment::mySettingsBackup

protected

DtSignalConnectionManager makVrv::DtEnvironment::myConnections

protected

---

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

• include/vrvCore/DtEnvironment.h