makVrv::DtSharedLightingRenderSettings Class Reference

The shared lighting render settings. More...

Inheritance diagram for makVrv::DtSharedLightingRenderSettings:

Public Member Functions
virtual	~DtSharedLightingRenderSettings ()
	DTOR.
Setting Getters & Setters
float	lightingEmissionScale () const
	Get / Set scale factor for emissive textures.
void	setLightingEmissionScale (float setting)
	Get / Set scale factor for emissive textures.
float	lightingDiffuseScale () const
	Get / Set scale factor for diffuse light.
void	setLightingDiffuseScale (float setting)
	Get / Set scale factor for emissive textures.
float	lightingAmbientScale () const
	Get / Set scale factor for ambient light.
void	setLightingAmbientScale (float setting)
	Get / Set scale factor for emissive textures.
float	globalAmbientValue () const
	Get / Set scale factor for emissive textures.
void	setGlobalAmbientValue (float ambientValue)
	Get / Set scale factor for emissive textures.
bool	useGlobalAmbient () const
	Get / Set scale factor for emissive textures.
void	setUseGlobalAmbient (bool useGlobalAmbient)
	Get / Set scale factor for emissive textures.
float	globalDiffuseValue () const
	Get / Set scale factor for emissive textures.
void	setGlobalDiffuseValue (float diffuseValue)
	Get / Set scale factor for emissive textures.
bool	useGlobalDiffuse () const
	Get / Set scale factor for emissive textures.
void	setUseGlobalDiffuse (bool useGlobalDiffuse)
	Get / Set scale factor for emissive textures.
bool	perPixelLightingEnabled () const
	Get / Set scale factor for emissive textures.
void	setPerPixelLightingEnabled (bool setting)
	Get / Set scale factor for emissive textures.
Settings record / backup methods
void	setFromRecord (const makArchives::DtLightingRenderSettingsRecord &rec)
	Restore the settings from a record.
void	getRecord (makArchives::DtLightingRenderSettingsRecord &rec) const
	Get the settings as a record.
virtual const DtLightingRenderSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtLightingRenderSettingsBackup *	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
	DtSharedLightingRenderSettings (DtSharedSettingsManager &manager)
	Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Protected Attributes
float	myLightingEmissionScale
float	myLightingDiffuseScale
float	myLightingAmbientScale
float	myGlobalAmbientValue
bool	myUseGlobalAmbient
float	myGlobalDiffuseValue
bool	myUseGlobalDiffuse
bool	myPerPixelLightingEnabled
DtLightingRenderSettingsBackup *	mySettingsBackup

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

Detailed Description

The shared lighting render settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedLightingRenderSettings::~DtSharedLightingRenderSettings ( )

virtual

DTOR.

makVrv::DtSharedLightingRenderSettings::DtSharedLightingRenderSettings ( DtSharedSettingsManager &  manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Member Function Documentation

float makVrv::DtSharedLightingRenderSettings::lightingEmissionScale

(

)

const

Get / Set scale factor for emissive textures.

void makVrv::DtSharedLightingRenderSettings::setLightingEmissionScale

(

float

setting

)

Get / Set scale factor for emissive textures.

float makVrv::DtSharedLightingRenderSettings::lightingDiffuseScale

(

)

const

Get / Set scale factor for diffuse light.

void makVrv::DtSharedLightingRenderSettings::setLightingDiffuseScale

(

float

setting

)

Get / Set scale factor for emissive textures.

float makVrv::DtSharedLightingRenderSettings::lightingAmbientScale

(

)

const

Get / Set scale factor for ambient light.

void makVrv::DtSharedLightingRenderSettings::setLightingAmbientScale

(

float

setting

)

Get / Set scale factor for emissive textures.

float makVrv::DtSharedLightingRenderSettings::globalAmbientValue

(

)

const

Get / Set scale factor for emissive textures.

void makVrv::DtSharedLightingRenderSettings::setGlobalAmbientValue

(

float

ambientValue

)

Get / Set scale factor for emissive textures.

bool makVrv::DtSharedLightingRenderSettings::useGlobalAmbient

(

)

const

Get / Set scale factor for emissive textures.

void makVrv::DtSharedLightingRenderSettings::setUseGlobalAmbient

(

bool

useGlobalAmbient

)

Get / Set scale factor for emissive textures.

float makVrv::DtSharedLightingRenderSettings::globalDiffuseValue

(

)

const

Get / Set scale factor for emissive textures.

void makVrv::DtSharedLightingRenderSettings::setGlobalDiffuseValue

(

float

diffuseValue

)

Get / Set scale factor for emissive textures.

bool makVrv::DtSharedLightingRenderSettings::useGlobalDiffuse

(

)

const

Get / Set scale factor for emissive textures.

void makVrv::DtSharedLightingRenderSettings::setUseGlobalDiffuse

(

bool

useGlobalDiffuse

)

Get / Set scale factor for emissive textures.

bool makVrv::DtSharedLightingRenderSettings::perPixelLightingEnabled

(

)

const

Get / Set scale factor for emissive textures.

void makVrv::DtSharedLightingRenderSettings::setPerPixelLightingEnabled

(

bool

setting

)

Get / Set scale factor for emissive textures.

void makVrv::DtSharedLightingRenderSettings::setFromRecord

(

const makArchives::DtLightingRenderSettingsRecord &

rec

)

Restore the settings from a record.

void makVrv::DtSharedLightingRenderSettings::getRecord

(

makArchives::DtLightingRenderSettingsRecord &

rec

)

const

Get the settings as a record.

virtual const DtLightingRenderSettingsBackup* makVrv::DtSharedLightingRenderSettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtLightingRenderSettingsBackup* makVrv::DtSharedLightingRenderSettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedLightingRenderSettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

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

static

The class name for this settings object.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedLightingRenderSettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedLightingRenderSettings >

friend

Use the DtWriteSettingsLock to write to the object.

Member Data Documentation

float makVrv::DtSharedLightingRenderSettings::myLightingEmissionScale

protected

float makVrv::DtSharedLightingRenderSettings::myLightingDiffuseScale

protected

float makVrv::DtSharedLightingRenderSettings::myLightingAmbientScale

protected

float makVrv::DtSharedLightingRenderSettings::myGlobalAmbientValue

protected

bool makVrv::DtSharedLightingRenderSettings::myUseGlobalAmbient

protected

float makVrv::DtSharedLightingRenderSettings::myGlobalDiffuseValue

protected

bool makVrv::DtSharedLightingRenderSettings::myUseGlobalDiffuse

protected

bool makVrv::DtSharedLightingRenderSettings::myPerPixelLightingEnabled

protected

DtLightingRenderSettingsBackup* makVrv::DtSharedLightingRenderSettings::mySettingsBackup

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvCore/DtSharedLightingRenderSettings.h