makVrv::DtSharedRenderSettings Class Reference

The shared render settings. More...

Inheritance diagram for makVrv::DtSharedRenderSettings:

Public Member Functions
virtual	~DtSharedRenderSettings ()
	DTOR.
Setting Getters & Setters
bool	wireframeMode () const
void	setWireframeMode (bool setting)
bool	terrainScalingEnabled () const
void	setTerrainScalingEnabled (bool enabled)
double	terrainScaleFactor () const
void	setTerrainScaleFactor (double scaleFactor)
bool	clearTrackHistoryOnTerrainScaleChanged () const
void	setClearTrackHistoryOnTerrainScaleChanged (bool clear)
void	setPlanViewGeocentricOccludedTransparency (float f)
float	planViewGeocentricOccludedTransparency () const
bool	shadowMode () const
void	setShadowMode (bool setting)
int	shadowQuality () const
void	setShadowQuality (int setting)
bool	entityShadowMode () const
void	setEntityShadowMode (bool setting)
bool	propShadowMode () const
void	setPropShadowMode (bool setting)
bool	terrainShadowMode () const
void	setTerrainShadowMode (bool setting)
bool	performanceOverlayEnabled () const
void	setPerformanceOverlayEnabled (bool enabled)
Settings record / backup methods
void	setFromRecord (const makArchives::DtRenderSettingsRecord &rec)
	Restore the settings from a record.
void	getRecord (makArchives::DtRenderSettingsRecord &rec) const
	Get the settings as a record.
virtual const DtRenderSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtRenderSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR.
virtual	~DtSharedSettings ()
	DTOR.
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object.
SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example.
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

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

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

Protected Attributes
bool	myWireframeMode
bool	myTerrainScalingEnabled
double	myTerrainScaleFactor
bool	myClearTrackHistoryOnTerrainScaleChanged
float	myPlanViewGeocentricOccludedTransparency
bool	myShadowMode
int	myShadowQuality
bool	myEntityShadowMode
bool	myPropShadowMode
bool	myTerrainShadowMode
bool	myPerformanceOverlayEnabled
DtRenderSettingsBackup *	mySettingsBackup

Friends
class	DtReadSettingsLock< DtSharedRenderSettings >
	Use the DtReadSettingsLock to read the object.
class	DtWriteSettingsLock< DtSharedRenderSettings >
	Use the DtWriteSettingsLock to write to the object.

Detailed Description

The shared render settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedRenderSettings::~DtSharedRenderSettings ( )

virtual

DTOR.

makVrv::DtSharedRenderSettings::DtSharedRenderSettings ( DtSharedSettingsManager &  manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Member Function Documentation

bool makVrv::DtSharedRenderSettings::wireframeMode

(

)

const

void makVrv::DtSharedRenderSettings::setWireframeMode

(

bool

setting

)

bool makVrv::DtSharedRenderSettings::terrainScalingEnabled

(

)

const

void makVrv::DtSharedRenderSettings::setTerrainScalingEnabled

(

bool

enabled

)

double makVrv::DtSharedRenderSettings::terrainScaleFactor

(

)

const

void makVrv::DtSharedRenderSettings::setTerrainScaleFactor

(

double

scaleFactor

)

bool makVrv::DtSharedRenderSettings::clearTrackHistoryOnTerrainScaleChanged

(

)

const

void makVrv::DtSharedRenderSettings::setClearTrackHistoryOnTerrainScaleChanged

(

bool

clear

)

void makVrv::DtSharedRenderSettings::setPlanViewGeocentricOccludedTransparency

(

float

f

)

float makVrv::DtSharedRenderSettings::planViewGeocentricOccludedTransparency

(

)

const

bool makVrv::DtSharedRenderSettings::shadowMode

(

)

const

void makVrv::DtSharedRenderSettings::setShadowMode

(

bool

setting

)

int makVrv::DtSharedRenderSettings::shadowQuality

(

)

const

void makVrv::DtSharedRenderSettings::setShadowQuality

(

int

setting

)

bool makVrv::DtSharedRenderSettings::entityShadowMode

(

)

const

void makVrv::DtSharedRenderSettings::setEntityShadowMode

(

bool

setting

)

bool makVrv::DtSharedRenderSettings::propShadowMode

(

)

const

void makVrv::DtSharedRenderSettings::setPropShadowMode

(

bool

setting

)

bool makVrv::DtSharedRenderSettings::terrainShadowMode

(

)

const

void makVrv::DtSharedRenderSettings::setTerrainShadowMode

(

bool

setting

)

bool makVrv::DtSharedRenderSettings::performanceOverlayEnabled

(

)

const

void makVrv::DtSharedRenderSettings::setPerformanceOverlayEnabled

(

bool

enabled

)

void makVrv::DtSharedRenderSettings::setFromRecord

(

const makArchives::DtRenderSettingsRecord &

rec

)

Restore the settings from a record.

void makVrv::DtSharedRenderSettings::getRecord

(

makArchives::DtRenderSettingsRecord &

rec

)

const

Get the settings as a record.

virtual const DtRenderSettingsBackup* makVrv::DtSharedRenderSettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtRenderSettingsBackup* makVrv::DtSharedRenderSettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedRenderSettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

static std::string makVrv::DtSharedRenderSettings::className ( )

static

The class name for this settings object.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedRenderSettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedRenderSettings >

friend

Use the DtWriteSettingsLock to write to the object.

Member Data Documentation

bool makVrv::DtSharedRenderSettings::myWireframeMode

protected

bool makVrv::DtSharedRenderSettings::myTerrainScalingEnabled

protected

double makVrv::DtSharedRenderSettings::myTerrainScaleFactor

protected

bool makVrv::DtSharedRenderSettings::myClearTrackHistoryOnTerrainScaleChanged

protected

float makVrv::DtSharedRenderSettings::myPlanViewGeocentricOccludedTransparency

protected

bool makVrv::DtSharedRenderSettings::myShadowMode

protected

int makVrv::DtSharedRenderSettings::myShadowQuality

protected

bool makVrv::DtSharedRenderSettings::myEntityShadowMode

protected

bool makVrv::DtSharedRenderSettings::myPropShadowMode

protected

bool makVrv::DtSharedRenderSettings::myTerrainShadowMode

protected

bool makVrv::DtSharedRenderSettings::myPerformanceOverlayEnabled

protected

DtRenderSettingsBackup* makVrv::DtSharedRenderSettings::mySettingsBackup

protected

---

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

• include/vrvCore/DtSharedRenderSettings.h