The shared ocean render settings. More...

Inheritance diagram for makVrv::DtSharedOceanRenderSettings:

Public Member Functions
virtual	~DtSharedOceanRenderSettings ()
	DTOR. More...

Setting Getters & Setters
bool	oceanPlanarReflectionsEnabled () const

void	setOceanPlanarReflectionsEnabled (bool setting)

float	oceanPlanarReflectionsLODScale () const

void	setOceanPlanarReflectionsLODScale (float setting)

bool	oceanPlanarReflectionsSpecifyFarClip () const

void	setOceanPlanarReflectionsSpecifyFarClip (bool setting)

double	oceanPlanarReflectionsFarClip () const

void	setOceanPlanarReflectionsFarClip (double setting)

bool	waveSprayEffectEnabled () const

void	setWaveSprayEffectEnabled (bool setting)

bool	rotorWashDecalEnabled () const

void	setRotorWashDecalEnabled (bool setting)

double	oceanHeightMapResolution () const

void	setOceanHeightMapResolution (double setting)

bool	tidalStreamWakesEnabled () const

void	setTidalStreamWakesEnabled (bool setting)

double	regenerateCubeMapThreshold () const

void	setRegenerateCubeMapThreshold (double threshold)

double	regenerateHeightMapPercThreshold () const

void	setRegenerateHeightMapPercThreshold (double threshold)

bool	omitCloudInCubeMap () const

void	setOmitCloudInCubeMap (bool omit)

int	oceanHeightMapTextureSize () const

void	setOceanHeightMapTextureSize (int setting)

double	staticOceanLodRange () const

void	setStaticOceanLodRange (double range)

int	planarReflectionTextureWidth () const

void	setPlanarReflectionTextureWidth (int w)

int	planarReflectionTextureHeight () const

void	setPlanarReflectionTextureHeight (int h)

unsigned int	oceanQuality () const

void	setOceanQuality (unsigned int quality)

bool	planarReflectionsShowSpeedTrees () const

void	setPlanarReflectionsShowSpeedTrees (bool setting)

Settings record / backup methods
void	setFromRecord (const makArchives::DtOceanRenderSettingsRecord &rec)
	Restore the settings from a record. More...

void	getRecord (makArchives::DtOceanRenderSettingsRecord &rec) const
	Get the settings as a record. More...

virtual const DtOceanRenderSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const). More...

virtual DtOceanRenderSettingsBackup *	settingsBackup ()
	Accessor for the settings backup. More...

virtual void	backup ()
	Called to back up the settings. More...

Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR. More...

virtual	~DtSharedSettings ()
	DTOR. More...

boost::shared_mutex &	mutex ()
	Get the mutex for the settings object. More...

SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example. More...

void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object. More...

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...

virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Member Functions
static const std::string &	className ()
	The class name for this settings object. More...

Protected Member Functions
	DtSharedOceanRenderSettings (DtSharedSettingsManager &manager)
	Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock). More...

Friends
class	DtReadSettingsLock< DtSharedOceanRenderSettings >
	Use the DtReadSettingsLock to read the object. More...

class	DtWriteSettingsLock< DtSharedOceanRenderSettings >
	Use the DtWriteSettingsLock to write to the object. More...

Detailed Description

The shared ocean render settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedOceanRenderSettings::~DtSharedOceanRenderSettings ( )

virtual

DTOR.

makVrv::DtSharedOceanRenderSettings::DtSharedOceanRenderSettings ( DtSharedSettingsManager & manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Member Function Documentation

bool makVrv::DtSharedOceanRenderSettings::oceanPlanarReflectionsEnabled ( ) const

void makVrv::DtSharedOceanRenderSettings::setOceanPlanarReflectionsEnabled ( bool setting )

float makVrv::DtSharedOceanRenderSettings::oceanPlanarReflectionsLODScale ( ) const

void makVrv::DtSharedOceanRenderSettings::setOceanPlanarReflectionsLODScale ( float setting )

bool makVrv::DtSharedOceanRenderSettings::oceanPlanarReflectionsSpecifyFarClip ( ) const

void makVrv::DtSharedOceanRenderSettings::setOceanPlanarReflectionsSpecifyFarClip ( bool setting )

double makVrv::DtSharedOceanRenderSettings::oceanPlanarReflectionsFarClip ( ) const

void makVrv::DtSharedOceanRenderSettings::setOceanPlanarReflectionsFarClip ( double setting )

bool makVrv::DtSharedOceanRenderSettings::waveSprayEffectEnabled ( ) const

void makVrv::DtSharedOceanRenderSettings::setWaveSprayEffectEnabled ( bool setting )

bool makVrv::DtSharedOceanRenderSettings::rotorWashDecalEnabled ( ) const

void makVrv::DtSharedOceanRenderSettings::setRotorWashDecalEnabled ( bool setting )

double makVrv::DtSharedOceanRenderSettings::oceanHeightMapResolution ( ) const

void makVrv::DtSharedOceanRenderSettings::setOceanHeightMapResolution ( double setting )

bool makVrv::DtSharedOceanRenderSettings::tidalStreamWakesEnabled ( ) const

void makVrv::DtSharedOceanRenderSettings::setTidalStreamWakesEnabled ( bool setting )

double makVrv::DtSharedOceanRenderSettings::regenerateCubeMapThreshold ( ) const

void makVrv::DtSharedOceanRenderSettings::setRegenerateCubeMapThreshold ( double threshold )

double makVrv::DtSharedOceanRenderSettings::regenerateHeightMapPercThreshold ( ) const

void makVrv::DtSharedOceanRenderSettings::setRegenerateHeightMapPercThreshold ( double threshold )

bool makVrv::DtSharedOceanRenderSettings::omitCloudInCubeMap ( ) const

void makVrv::DtSharedOceanRenderSettings::setOmitCloudInCubeMap ( bool omit )

int makVrv::DtSharedOceanRenderSettings::oceanHeightMapTextureSize ( ) const

void makVrv::DtSharedOceanRenderSettings::setOceanHeightMapTextureSize ( int setting )

double makVrv::DtSharedOceanRenderSettings::staticOceanLodRange ( ) const

void makVrv::DtSharedOceanRenderSettings::setStaticOceanLodRange ( double range )

int makVrv::DtSharedOceanRenderSettings::planarReflectionTextureWidth ( ) const

void makVrv::DtSharedOceanRenderSettings::setPlanarReflectionTextureWidth ( int w )

int makVrv::DtSharedOceanRenderSettings::planarReflectionTextureHeight ( ) const

void makVrv::DtSharedOceanRenderSettings::setPlanarReflectionTextureHeight ( int h )

unsigned int makVrv::DtSharedOceanRenderSettings::oceanQuality ( ) const

void makVrv::DtSharedOceanRenderSettings::setOceanQuality ( unsigned int quality )

bool makVrv::DtSharedOceanRenderSettings::planarReflectionsShowSpeedTrees ( ) const

void makVrv::DtSharedOceanRenderSettings::setPlanarReflectionsShowSpeedTrees ( bool setting )

void makVrv::DtSharedOceanRenderSettings::setFromRecord ( const makArchives::DtOceanRenderSettingsRecord & rec )

Restore the settings from a record.

void makVrv::DtSharedOceanRenderSettings::getRecord ( makArchives::DtOceanRenderSettingsRecord & rec ) const

Get the settings as a record.

virtual const DtOceanRenderSettingsBackup* makVrv::DtSharedOceanRenderSettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtOceanRenderSettingsBackup* makVrv::DtSharedOceanRenderSettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedOceanRenderSettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

static const std::string& makVrv::DtSharedOceanRenderSettings::className ( )

static

The class name for this settings object.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedOceanRenderSettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedOceanRenderSettings >

friend

Use the DtWriteSettingsLock to write to the object.

Member Data Documentation

bool makVrv::DtSharedOceanRenderSettings::myOceanPlanarReflectionsEnabled

protected

float makVrv::DtSharedOceanRenderSettings::myOceanPlanarReflectionsLODScale

protected

bool makVrv::DtSharedOceanRenderSettings::myOceanPlanarReflectionsSpecifyFarClip

protected

double makVrv::DtSharedOceanRenderSettings::myOceanPlanarReflectionsFarClip

protected

bool makVrv::DtSharedOceanRenderSettings::myWaveSprayEffectEnabled

protected

bool makVrv::DtSharedOceanRenderSettings::myRotorWashDecalEnabled

protected

double makVrv::DtSharedOceanRenderSettings::myOceanHeightMapResolution

protected

bool makVrv::DtSharedOceanRenderSettings::myTidalStreamWakesEnabled

protected

double makVrv::DtSharedOceanRenderSettings::myRegenerateCubeMapThreshold

protected

double makVrv::DtSharedOceanRenderSettings::myRegenerateHeightMapPercThreshold

protected

bool makVrv::DtSharedOceanRenderSettings::myOmitCloudInCubeMap

protected

int makVrv::DtSharedOceanRenderSettings::myOceanHeightMapTextureSize

protected

int makVrv::DtSharedOceanRenderSettings::myPlanarReflectionTextureWidth

protected

int makVrv::DtSharedOceanRenderSettings::myPlanarReflectionTextureHeight

protected

unsigned int makVrv::DtSharedOceanRenderSettings::myOceanQuality

protected

double makVrv::DtSharedOceanRenderSettings::myStaticOceanLodRange

protected

bool makVrv::DtSharedOceanRenderSettings::myPlanarReflectionsShowSpeedTrees

protected

DtOceanRenderSettingsBackup* makVrv::DtSharedOceanRenderSettings::mySettingsBackup

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtSharedOceanRenderSettings.h

Protected Attributes
bool	myOceanPlanarReflectionsEnabled

float	myOceanPlanarReflectionsLODScale

bool	myOceanPlanarReflectionsSpecifyFarClip

double	myOceanPlanarReflectionsFarClip

bool	myWaveSprayEffectEnabled

bool	myRotorWashDecalEnabled

double	myOceanHeightMapResolution

bool	myTidalStreamWakesEnabled

double	myRegenerateCubeMapThreshold

double	myRegenerateHeightMapPercThreshold

bool	myOmitCloudInCubeMap

int	myOceanHeightMapTextureSize

int	myPlanarReflectionTextureWidth

int	myPlanarReflectionTextureHeight

unsigned int	myOceanQuality

double	myStaticOceanLodRange

bool	myPlanarReflectionsShowSpeedTrees

DtOceanRenderSettingsBackup *	mySettingsBackup

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation