DtShadowSettingsManager is responsible for loading and saving observer modes, and providing a mechanism to look up observer mode information by observer mode ID. More...

Inheritance diagram for makVrv::DtShadowSettingsManager:

[legend]

Public Member Functions
virtual	~DtShadowSettingsManager ()
	DTOR.
virtual void	createShadowSettings ()
	Load the default settings.
int	lookupShadowQuality (const std::string &stringKey) const
	Looks up the int key for the observer mode with the given name.
const std::string *	findShadowQualityStringKey (int quality) const
	Find the observer mode string for a int key.
void	setName (int quality, const std::string &name)
	Sets setting name.
std::string	name (int quality) const
	Returns setting name.
void	setEntitiesCastsShadows (int quality, bool castShadows)
	Sets entities casts shadow flag.
bool	entitiesCastsShadows (int quality) const
	Gets entities casts shadow flag.
bool	entitiesCastsShadows () const
	Gets entities casts shadow flag.
void	setPropsCastsShadows (int quality, bool castShadows)
	Sets props casts shadow flag.
bool	propsCastsShadows (int quality) const
	Gets props casts shadow flag.
bool	propsCastsShadows () const
	Gets props casts shadow flag.
void	setTerrainCastsShadows (int quality, bool castShadows)
	Sets terrain casts shadow flag.
bool	terrainCastsShadows (int quality) const
	Gets terrain casts shadow flag.
bool	terrainCastsShadows () const
	Gets terrain casts shadow flag.
void	setCloudsCastsShadows (int quality, bool castShadows)
	Sets clouds casts shadow flag.
bool	cloudsCastsShadows (int quality) const
	Gets clouds casts shadow flag.
bool	cloudsCastsShadows () const
	Gets clouds casts shadow flag.
void	setVisualizeShadows (int quality, bool visualizeShadows)
	Sets shadow visualization mode.
bool	visualizeShadows (int quality) const
	Gets shadow visualization mode.
bool	visualizeShadows () const
	Gets shadow visualization mode.
void	setNumberOfSplits (int quality, unsigned int numSplits)
	Sets shadow visualization mode.
unsigned int	numberOfSplits (int quality) const
	Gets shadow visualization mode.
unsigned int	numberOfSplits () const
	Gets shadow visualization mode.
void	setUseFrontFaceCulling (int quality, bool useFrontFaceCulling)
	Gets use front face culling.
bool	useFrontFaceCulling (int quality) const
	Gets use front face culling.
bool	useFrontFaceCulling () const
	Gets use front face culling.
void	setUseCachedFarCascade (int quality, bool useCachedFarCascade)
	Sets use cached far cascade this allows a last cascade to be much larger but update less frequently.
bool	useCachedFarCascade () const
	Gets use cached far cascade.
void	setFarCascadeUpdateFrequency (int quality, double update_freq)
	Sets far cascade update frequency.
double	farCascadeUpdateFrequency ()
	Gets far cascade update frequency.
void	setAdjustFarAndFlagsBasedOnHAT (int quality, bool adaptive)
	Sets to make the near cascades automatically change size and flags in the air.
bool	adjustFarAndFlagsBasedOnHAT ()
	Gets if near cascades automatically change size and flags in the air.
void	setUsePolygonOffset (int quality, bool usePolygonOffset)
	Sets use polygon offset.
bool	usePolygonOffset (int quality) const
	Gets use polygon offset.
bool	usePolygonOffset () const
	Gets use polygon offset.
void	setPolygonOffset (int quality, unsigned int splitIndex, float factor, float units)
	Sets polygon offset parameters.
float	polygonOffsetFactor (int quality, unsigned int splitIndex) const
	Gets polygon offset factor parameter.
float	polygonOffsetFactor (unsigned int splitIndex) const
	Gets polygon offset factor parameter.
float	polygonOffsetUnits (int quality, unsigned int splitIndex) const
	Gets polygon offset unit parameter.
float	polygonOffsetUnits (unsigned int splitIndex) const
	Gets polygon offset unit parameter.
void	setSpotLightShadowMapSize (int quality, unsigned int size)
	Sets spot light texture atlas size.
unsigned int	spotLightShadowMapSize (int quality) const
	Gets spot light texture atlas size.
unsigned int	spotLightShadowMapSize () const
	Gets spot light texture atlas size.
void	setGlobalLightShadowMapSize (int quality, unsigned int size)
	Sets global light texture size for cascaded shadow mapping.
unsigned int	globalLightShadowMapSize () const
	Gets global light texture size for cascaded shadow mapping.
unsigned int	globalLightShadowMapSize (int quality) const
	Gets global light texture size for cascaded shadow mapping.
void	setUseMaximumViewDistance (int quality, bool useMaximumViewDistance)
	Sets use maximum view distance.
bool	useMaximumViewDistance (int quality) const
	Gets use maximum view distance.
bool	useMaximumViewDistance () const
	Gets use maximum view distance.
void	setMaximumViewDistance (int quality, double viewDistance)
	Set maximum view distance.
double	maximumViewDistance (int quality) const
	Get maximum far distance.
double	maximumViewDistance () const
	Get maximum far distance.
void	setSplitNearDistanceMinimumBias (int quality, double bias)
	Sets split near distance minimum bias.
double	splitNearDistanceMinimumBias (int quality) const
	Gets split near distance minimum bias.
double	splitNearDistanceMinimumBias () const
	Gets split near distance minimum bias.
void	setSplitNearDistanceMaximumBias (int quality, double bias)
	Sets split near distance maximum bias.
double	splitNearDistanceMaximumBias (int quality) const
	Gets split near distance maximum bias.
double	splitNearDistanceMaximumBias () const
	Gets split near distance maximum bias.
void	setSplitFarDistanceBias (int quality, double bias)
	Sets split far distance bias.
double	splitFarDistanceBias (int quality) const
	Gets split far distance bias.
double	splitFarDistanceBias () const
	Gets split far distance bias.
void	setShadowAmbientFactor (int quality, float shadowAmbientFactor)
	Sets shadow factor for modulating the scene.
float	shadowAmbientFactor (int quality) const
	Gets shadow factor for modulating the scene.
float	shadowAmbientFactor () const
	Gets shadow factor for modulating the scene.
void	setShadowStabilizationScheme (int quality, makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme shadowStabilizationScheme)
	Sets shadow stabilization scheme.
makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme	shadowStabilizationScheme (int quality) const
	Gets shadow stabilization scheme.
makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme	shadowStabilizationScheme () const
	Gets shadow stabilization scheme.
void	setAntiFlickerQuantizationFactor (int quality, float antiFlickerQuantizationFactor)
	Sets shadow anti-flicker quantization value for approximate stabilization scheme.
float	antiFlickerQuantizationFactor (int quality) const
	Gets shadow anti-flicker quantization value for approximate stabilization scheme.
float	antiFlickerQuantizationFactor () const
	Gets shadow anti-flicker quantization value for approximate stabilization scheme.
void	setSplitDistanceComputeScheme (int quality, makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme splitDistanceComputeScheme)
	Sets split distance compute scheme.
makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme	splitDistanceComputeScheme (int quality) const
	Gets split distance compute scheme.
makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme	splitDistanceComputeScheme () const
	Gets split distance compute scheme.
void	setMixedSplitInterpolationValue (int quality, double interp)
	Sets mixed logarithmic uniform split interpolation value.
double	mixedSplitInterpolationValue (int quality) const
	Gets mixed logarithmic uniform split interpolation value.
double	mixedSplitInterpolationValue () const
	Gets mixed logarithmic uniform split interpolation value.
void	setSplitSelectionScheme (int quality, makArchives::DtShadowSettingsRecord::SplitSelectionScheme splitSelectionScheme)
	Sets split selection scheme.
makArchives::DtShadowSettingsRecord::SplitSelectionScheme	splitSelectionScheme (int quality) const
	Gets split selection scheme.
makArchives::DtShadowSettingsRecord::SplitSelectionScheme	splitSelectionScheme () const
	Gets split selection scheme.
void	setDataStorageScheme (int quality, makArchives::DtShadowSettingsRecord::DataStorageScheme dataStorageScheme)
	Sets data storage scheme.
makArchives::DtShadowSettingsRecord::DataStorageScheme	dataStorageScheme (int quality) const
	Gets data storage scheme.
makArchives::DtShadowSettingsRecord::DataStorageScheme	dataStorageScheme () const
	Gets data storage scheme.
void	setPreFilteringScheme (int quality, makArchives::DtShadowSettingsRecord::PreFilteringScheme preFilteringScheme)
	Sets pre-filtering scheme.
makArchives::DtShadowSettingsRecord::PreFilteringScheme	preFilteringScheme (int quality) const
	Gets pre-filtering scheme.
makArchives::DtShadowSettingsRecord::PreFilteringScheme	preFilteringScheme () const
	Gets pre-filtering scheme.
void	setFilteringScheme (int quality, makArchives::DtShadowSettingsRecord::FilteringScheme filteringScheme)
	Sets filtering scheme.
makArchives::DtShadowSettingsRecord::FilteringScheme	filteringScheme (int quality) const
	Gets filtering scheme.
makArchives::DtShadowSettingsRecord::FilteringScheme	filteringScheme () const
	Gets filtering scheme.
void	setPoissonDiskSamplingScheme (int quality, makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme poissonDiskSamplingScheme)
	Sets poisson disk sampling scheme.
makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme	poissonDiskSamplingScheme (int quality) const
	Gets poisson disk sampling scheme.
makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme	poissonDiskSamplingScheme () const
	Gets poisson disk sampling scheme.
void	setUseViewportMulticast (int quality, bool useViewportMulticast)
	Turns on viewport multicast allows faster shadow generation on modern video cards.
bool	useViewportMulticast () const
	Gets use viewport multicast.
void	setNumPersistentPassesPerCascade (int quality, unsigned int numPasses)
	Sets number of persistent passes per cascade.
unsigned int	numPersistentPassesPerCascade (int quality) const
	Gets number of persistent passes per cascade.
unsigned int	numPersistentPassesPerCascade () const
	Gets number of persistent passes per cascade.
void	setNumAdditionalPassesPerCascade (int quality, unsigned int numPasses)
	Sets number of passes per cascade.
unsigned int	numAdditionalPassesPerCascade (int quality) const
	Gets number of passes per cascade.
unsigned int	numAdditionalPassesPerCascade () const
	Gets number of passes per cascade.
void	setPcfFilterWidth (int quality, unsigned int pcfFilterWidth)
	Sets PCF filter width.
unsigned int	pcfFilterWidth (int quality) const
	Gets PCF filter width.
unsigned int	pcfFilterWidth () const
	Gets PCF filter width.
void	setBlendCascadesBoundaries (int quality, bool blendCascadesBoundaries)
	Enables/Disables blend between cascade boundaries.
bool	blendCascadesBoundaries (int quality) const
	Gets blend between cascade boundaries.
bool	blendCascadesBoundaries () const
	Gets blend between cascade boundaries.
void	setUseSDSM (int quality, bool useSDSM)
	Enables/Disables Sample Distribution Shadow Maps(SDSM)
bool	useSDSM (int quality) const
	Gets Sample Distribution Shadow Maps(SDSM) enabled or disabled state.
bool	useSDSM () const
	Gets Sample Distribution Shadow Maps(SDSM) enabled or disabled state.
void	setSDSMReadBackLatency (int quality, unsigned int sdsmReadBackLatency)
	Sets Sample Distribution Shadow Maps(SDSM) read back latency.
unsigned int	sdsmReadBackLatency (int quality) const
	Gets Sample Distribution Shadow Maps(SDSM) read back latency.
unsigned int	sdsmReadBackLatency () const
	Gets Sample Distribution Shadow Maps(SDSM) read back latency.
void	setUseCameraDepthBufferForSDSM (int quality, bool useCameraDepthBufferForSDSM)
	Enables/Disables the usage of the most recent camera depth buffer for Sample Distribution Shadow Maps(SDSM) as against rendering to a very small frame buffer.
bool	useCameraDepthBufferForSDSM (int quality) const
	Gets the setting for the usage of the most recent camera depth buffer for Sample Distribution Shadow Maps(SDSM) as against rendering to a very small frame buffer.
bool	useCameraDepthBufferForSDSM () const
	Gets the setting for the usage of the most recent camera depth buffer for Sample Distribution Shadow Maps(SDSM) as against rendering to a very small frame buffer.
void	setEVSMPositiveExponent (int quality, double evsmPositiveExponent)
	Sets exponential variance shadow maps(EVSM) positive exponent.
double	evsmPositiveExponent (int quality) const
	Gets exponential variance shadow maps(EVSM) positive exponent.
double	evsmPositiveExponent () const
	Gets exponential variance shadow maps(EVSM) positive exponent.
void	setEVSMNegativeExponent (int quality, double evsmNegativeExponent)
	Sets exponential variance shadow maps(EVSM) negative exponent.
double	evsmNegativeExponent (int quality) const
	Gets exponential variance shadow maps(EVSM) negative exponent.
double	evsmNegativeExponent () const
	Gets exponential variance shadow maps(EVSM) negative exponent.
void	setVSMMininumVariance (int quality, double vsmMininumVariance)
	Sets variance shadow maps(VSM) minimum variance.
double	vsmMininumVariance (int quality) const
	Gets variance shadow maps(VSM) minimum variance.
double	vsmMininumVariance () const
	Gets variance shadow maps(VSM) minimum variance.
void	setESMDarkeningFactor (int quality, double esmDarkeningFactor)
	Sets exponential shadow maps(ESM) darkening factor.
double	esmDarkeningFactor (int quality) const
	Gets exponential shadow maps(ESM) darkening factor.
double	esmDarkeningFactor () const
	Gets exponential shadow maps(ESM) darkening factor.
void	setDirty (int quality, bool dirty)
	Mark settings as dirty or changed.
bool	dirty (int quality) const
	Checks if any setting just changed.
bool	dirty () const
	Checks if any setting just changed.
void	setCurrentPolygonOffsetCascade (unsigned int cascade)
	Sets current polygon offset cascade.
unsigned int	currentPolygonOffsetCascade () const
	Gets current polygon offset cascade.
Setting Persistence Methods
virtual void	loadDefaults ()
	Load the default settings.
virtual void	importSettings (const std::string &filePath)
	Load the settings' state from the given file.
virtual void	setFromRecord (const makArchives::DtShadowSettingsCollectionRecord &record)
	Use the shadow settings from the given settings record.
virtual void	setShadowSettingsFromRecord (const makArchives::DtShadowSettingsCollectionRecord &record, int quality)
	Use the shadow settings from the given record.
virtual void	getRecord (makArchives::DtShadowSettingsCollectionRecord &record) const
	Populate the given record with the current settings.
virtual void	getShadowSettingsFromRecord (makArchives::DtShadowSettingsCollectionRecord &record, int quality) const
	Populate the given record with the current settings.
virtual DtShadowSettingsCollectionBackup *	shadowSettingsCollectionBackup ()
	Return our settings backup object, properly cast to the derived version we are using.
Public Member Functions inherited from makVrv::DtBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >
	DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
	CTOR.
virtual	~DtBaseSettingsManager ()
	Virtual DTOR.
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
	CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk.
virtual	~DtCommonBaseSettingsManager ()
	Virtual DTOR.
virtual void	autoSaveIfNecessary ()
	Saves the current settings as defaults if autosave is enabled.
virtual void	setAutoSave (bool doit)
	Sets whether autosave is enabled for the settings manager.
virtual bool	autoSave () const
	Gets whether autosave is enabled for the settings manager.
virtual void	setUseDefaultSettingsRecord (bool useit)
	Sets whether setting initialization should check for a default record.
virtual bool	useDefaultSettingsRecord () const
	Gets whether setting initialization should check for a default record.
virtual DtDeSettings *	settings ()
	Accessor for the manager's DtDeSettings object.
virtual const DtDeSettings *	settings () const
	Accessor for the manager's DtDeSettings object (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the manager's settings backup.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the manager's settings backup (const).
virtual void	saveDefaultSettings ()
	Saves the current settings' state as the default (on disk).
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
	Loads the default settings from disk.
virtual void	exportSettings (const std::string &filePath) const
	Save the current settings' state to the given file.
virtual void	getSplitRecord (std::vector< makArchives::DtShadowSettingsCollectionRecord > &rec, std::vector< std::string > &fileNames)
	For directory support, split the main record into different sub-records and give them each a file name.
virtual void	addRecords (makArchives::DtShadowSettingsCollectionRecord &rec, makArchives::DtShadowSettingsCollectionRecord &combinedRec)
	For directory support, when reading in a directory, add the records from each file to the combined record.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtShadowSettingsManager &	instance (DtDe &de)
	Get an instance used to emit, or to connect.

Public Attributes
boost::signal< void(int, const std::string &)>	shadowSettingsNameChanged
	brief signal that the indicated shadow setting's name changed
boost::signal< void(int, int)>	shadowSettingsEntitiesCastsShadowsChanged
	brief signal that the indicated shadow setting's entities casts shadows changed
boost::signal< void(int, int)>	shadowSettingsPropsCastsShadowsChanged
	brief signal that the indicated shadow setting's props casts shadows changed
boost::signal< void(int, int)>	shadowSettingsTerrainCastsShadowsChanged
	brief signal that the indicated shadow setting's terrain casts shadows changed
boost::signal< void(int, int)>	shadowSettingsCloudsCastsShadowsChanged
	brief signal that the indicated shadow setting's clouds casts shadows changed
boost::signal< void(int, int)>	shadowSettingsVisualizeShadowsChanged
	brief signal that the indicated shadow setting's shadow visualization mode changed
boost::signal< void(int, int)>	shadowSettingsNumberOfSplitsChanged
	brief signal that the indicated shadow setting's shadow visualization mode changed
boost::signal< void(int, bool)>	shadowSettingsUseFrontFaceCullingChanged
	brief signal that the indicated shadow setting's use front face culling changed
boost::signal< void(int, bool)>	shadowSettingsUseCachedFarCascadeChanged
	brief signal that the indicated shadow setting's use cached far cascade changed
boost::signal< void(int, double)>	shadowSettingsFarCascadeUpdateFreqChanged
	brief signal that the indicated shadow setting's far cascade update changed
boost::signal< void(int, bool)>	shadowSettingsAdjustFarAndFlagsBasedOnHATChanged
	brief signal near cascades automatically change size and flags in the air
boost::signal< void(int, bool)>	shadowSettingsUseViewportMulticastChanged
	brief signal that the indicated shadow setting's use viewport multicast changed
boost::signal< void(int, bool)>	shadowSettingsUsePolygonOffsetChanged
	brief signal that the indicated shadow setting's use polygon offset changed
boost::signal< void(int, unsigned int, float)>	shadowSettingsPolygonOffsetFactorChanged
	brief signal that the indicated shadow setting's polygon offset factor parameter changed
boost::signal< void(int, unsigned int, float)>	shadowSettingsPolygonOffsetUnitsChanged
	brief signal that the indicated shadow setting's polygon offset unit parameter changed
boost::signal< void(int, int)>	shadowSettingsSpotLightShadowMapSizeChanged
	brief signal that the indicated shadow setting's spot light texture atlas size changed
boost::signal< void(int, int)>	shadowSettingsGlobalLightShadowMapSizeChanged
	brief signal that the indicated shadow setting's global light texture size for cascaded shadow mapping changed
boost::signal< void(int, bool)>	shadowSettingsUseMaximumViewDistanceChanged
	brief signal that the indicated shadow setting's use maximum view distance changed
boost::signal< void(int, double)>	shadowSettingsMaximumViewDistanceChanged
	brief signal that the indicated shadow setting's maximum view distance changed
boost::signal< void(int, double)>	shadowSettingsSplitNearDistanceMinimumBiasChanged
	brief signal that the indicated shadow setting's split near distance minimum bias changed
boost::signal< void(int, double)>	shadowSettingsSplitNearDistanceMaximumBiasChanged
	brief signal that the indicated shadow setting's split near distance maximum bias changed
boost::signal< void(int, double)>	shadowSettingsSplitFarDistanceBiasChanged
	brief signal that the indicated shadow setting's split far distance bias changed
boost::signal< void(int, float)>	shadowSettingsShadowFactorChanged
	brief signal that the indicated shadow setting's shadow factor for modulating the scene changed
boost::signal< void(int, int)>	shadowSettingsShadowStabilizationSchemeChanged
	brief signal that the indicated shadow setting's shadow stabilization scheme changed
boost::signal< void(int, float)>	shadowSettingsAntiFlickerQuantizationFactorChanged
	brief signal that the indicated shadow setting's shadow anti-flicker quantization value for approximate stabilization scheme changed
boost::signal< void(int, int)>	shadowSettingsSplitDistanceComputeSchemeChanged
	brief signal that the indicated shadow setting's split distance compute scheme changed
boost::signal< void(int, double)>	shadowSettingsMixedSplitInterpolationValueChanged
	brief signal that the indicated shadow setting's mixed logarithmic uniform split interpolation value changed
boost::signal< void(int, int)>	shadowSettingsSplitSelectionSchemeChanged
	brief signal that the indicated shadow setting's split selection scheme changed
boost::signal< void(int, int)>	shadowSettingsDataStorageSchemeChanged
	brief signal that the indicated shadow setting's data storage scheme changed
boost::signal< void(int, int)>	shadowSettingsPreFilteringSchemeChanged
	brief signal that the indicated shadow setting's pre-filtering scheme changed
boost::signal< void(int, int)>	shadowSettingsFilteringSchemeChanged
	brief signal that the indicated shadow setting's filtering scheme changed
boost::signal< void(int, int)>	shadowSettingsPoissonDiskSamplingSchemeChanged
	brief signal that the indicated shadow setting's poisson disk sampling scheme changed
boost::signal< void(int, unsigned int)>	shadowSettingsNumPersistentPassesPerCascadeChanged
	brief signal that the indicated shadow setting's persistent number of passes per cascade changed
boost::signal< void(int, unsigned int)>	shadowSettingsNumAdditionalPassesPerCascadeChanged
	brief signal that the indicated shadow setting's additional number of passes per cascade changed
boost::signal< void(int, unsigned int)>	shadowSettingsPcfFilterWidthChanged
	brief signal that the indicated shadow setting's PCF filter width changed
boost::signal< void(int, bool)>	shadowSettingsBlendCascadesBoundariesChanged
	brief signal that the indicated shadow setting's blend cascades boundaries changed
boost::signal< void(int, bool)>	shadowSettingsUseSDSMChanged
	brief signal that the indicated shadow setting's use sdsm flag changed
boost::signal< void(int, unsigned int)>	shadowSettingsSDSMReadBackLatencyChanged
	brief signal that the indicated shadow setting's sdsm read back latency changed
boost::signal< void(int, bool)>	shadowSettingsUseCameraDepthBufferForSDSMChanged
	brief signal that the indicated shadow setting's use camera depth buffer for sdsm flag changed
boost::signal< void(int, double)>	shadowSettingsEVSMPositiveExponentChanged
	brief signal that the indicated shadow setting's evsm positive exponent changed
boost::signal< void(int, double)>	shadowSettingsEVSMNegativeExponentChanged
	brief signal that the indicated shadow setting's evsm negative exponent changed
boost::signal< void(int, double)>	shadowSettingsVSMMininumVarianceChanged
	brief signal that the indicated shadow setting's vsm minimum variance changed
boost::signal< void(int, double)>	shadowSettingsESMDarkeningFactorChanged
	brief signal that the indicated shadow setting's esm darkening factor changed
boost::signal< void(int, bool)>	shadowSettingsDirtyChanged
	brief signal that the indicated shadow setting's dirty flag changed
boost::signal< void(int)>	shadowSettingsAdded
	signal that the indicated shadow setting was added
boost::signal< void(int)>	shadowSettingsToBeRemoved
	signal that the indicated shadow setting is about to be removed

Protected Types
typedef std::map< int, DtShadowSettingsObjectAgent * >	ShadowSettingsObjectAgents
	Type returned when retrieving all observer modes.
typedef std::map< std::string, int >	ShadowSettingsObjectAgentsMap
	Map type for mapping observer mode names to integer keys.
Protected Types inherited from makVrv::DtBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >
typedef DtRecordSettingsBackup < DtBaseSettingsManager < makArchives::DtShadowSettingsCollectionRecord > , makArchives::DtShadowSettingsCollectionRecord >	RecordBackupType

Protected Member Functions
void	slot_slaveAdded (const makVrv::DtDeRecord &igRecord)
	Ensures the shadow settings object agents are properly distributed when a De is connected.
	DtShadowSettingsManager (DtDe &)
	CTOR.
DtShadowSettingsObjectAgent *	getShadowSettingsObjectAgentPtr (int quality) const
	Accessor for a pointer to the observer mode with the given key.
virtual void	addShadowSettingsObjectAgent (int quality, const std::string &stringKey, DtShadowSettingsObjectAgent *agent)
	Add an already filled out mode (such as one read from a file)
virtual void	createShadowSettings (int quality, const std::string &stringKey)
	Add a observer mode.
virtual void	removeShadowQuality (int quality)
	Remove a observer mode.
virtual void	clear ()
	delete all the current visual modes
virtual void	initializeBackup ()
	Creates a backup of the settings' current state.

Protected Attributes
unsigned int	myCurrentQualitySetting
unsigned int	myCurrentPolygonOffsetCascade
std::string	myName
int	myQuality
makArchives::DtShadowSettingsRecord *	myCurrentSettings
DtStringKeyConverter *	myStringKeyConverter
ShadowSettingsObjectAgents	myShadowSettingsObjectAgents
ShadowSettingsObjectAgentsMap	myShadowSettingsObjectAgentsMap

Friends
class	DtShadowSettingsManagerCreator
	Befriend the creator class so the manager can be instantiated properly.
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
	Befriend the manager instance functions for instance retreival/creation.
template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)
	Befriend the manager instance functions for instance retreival/creation.

Detailed Description

DtShadowSettingsManager is responsible for loading and saving observer modes, and providing a mechanism to look up observer mode information by observer mode ID.

Member Typedef Documentation

typedef std::map<int, DtShadowSettingsObjectAgent*> makVrv::DtShadowSettingsManager::ShadowSettingsObjectAgents

protected

Type returned when retrieving all observer modes.

typedef std::map<std::string, int> makVrv::DtShadowSettingsManager::ShadowSettingsObjectAgentsMap

protected

Map type for mapping observer mode names to integer keys.

Constructor & Destructor Documentation

virtual makVrv::DtShadowSettingsManager::~DtShadowSettingsManager ( )

virtual

DTOR.

makVrv::DtShadowSettingsManager::DtShadowSettingsManager ( DtDe & )

protected

CTOR.

Member Function Documentation

static DtShadowSettingsManager& makVrv::DtShadowSettingsManager::instance ( DtDe & de )

static

Get an instance used to emit, or to connect.

virtual void makVrv::DtShadowSettingsManager::createShadowSettings ( )

virtual

Load the default settings.

int makVrv::DtShadowSettingsManager::lookupShadowQuality ( const std::string & stringKey ) const

Looks up the int key for the observer mode with the given name.

Returns: -1 if no observer mode with the given name exists.

const std::string* makVrv::DtShadowSettingsManager::findShadowQualityStringKey ( int quality ) const

Find the observer mode string for a int key.

void makVrv::DtShadowSettingsManager::setName	(	int	quality,
		const std::string &	name
	)

Sets setting name.

std::string makVrv::DtShadowSettingsManager::name ( int quality ) const

Returns setting name.

void makVrv::DtShadowSettingsManager::setEntitiesCastsShadows	(	int	quality,
		bool	castShadows
	)

Sets entities casts shadow flag.

bool makVrv::DtShadowSettingsManager::entitiesCastsShadows ( int quality ) const

Gets entities casts shadow flag.

bool makVrv::DtShadowSettingsManager::entitiesCastsShadows ( ) const

Gets entities casts shadow flag.

void makVrv::DtShadowSettingsManager::setPropsCastsShadows	(	int	quality,
		bool	castShadows
	)

Sets props casts shadow flag.

bool makVrv::DtShadowSettingsManager::propsCastsShadows ( int quality ) const

Gets props casts shadow flag.

bool makVrv::DtShadowSettingsManager::propsCastsShadows ( ) const

Gets props casts shadow flag.

void makVrv::DtShadowSettingsManager::setTerrainCastsShadows	(	int	quality,
		bool	castShadows
	)

Sets terrain casts shadow flag.

bool makVrv::DtShadowSettingsManager::terrainCastsShadows ( int quality ) const

Gets terrain casts shadow flag.

bool makVrv::DtShadowSettingsManager::terrainCastsShadows ( ) const

Gets terrain casts shadow flag.

void makVrv::DtShadowSettingsManager::setCloudsCastsShadows	(	int	quality,
		bool	castShadows
	)

Sets clouds casts shadow flag.

bool makVrv::DtShadowSettingsManager::cloudsCastsShadows ( int quality ) const

Gets clouds casts shadow flag.

bool makVrv::DtShadowSettingsManager::cloudsCastsShadows ( ) const

Gets clouds casts shadow flag.

void makVrv::DtShadowSettingsManager::setVisualizeShadows	(	int	quality,
		bool	visualizeShadows
	)

Sets shadow visualization mode.

bool makVrv::DtShadowSettingsManager::visualizeShadows ( int quality ) const

Gets shadow visualization mode.

bool makVrv::DtShadowSettingsManager::visualizeShadows ( ) const

Gets shadow visualization mode.

void makVrv::DtShadowSettingsManager::setNumberOfSplits	(	int	quality,
		unsigned int	numSplits
	)

Sets shadow visualization mode.

unsigned int makVrv::DtShadowSettingsManager::numberOfSplits ( int quality ) const

Gets shadow visualization mode.

unsigned int makVrv::DtShadowSettingsManager::numberOfSplits ( ) const

Gets shadow visualization mode.

void makVrv::DtShadowSettingsManager::setUseFrontFaceCulling	(	int	quality,
		bool	useFrontFaceCulling
	)

Gets use front face culling.

bool makVrv::DtShadowSettingsManager::useFrontFaceCulling ( int quality ) const

Gets use front face culling.

bool makVrv::DtShadowSettingsManager::useFrontFaceCulling ( ) const

Gets use front face culling.

void makVrv::DtShadowSettingsManager::setUseCachedFarCascade	(	int	quality,
		bool	useCachedFarCascade
	)

Sets use cached far cascade this allows a last cascade to be much larger but update less frequently.

bool makVrv::DtShadowSettingsManager::useCachedFarCascade ( ) const

Gets use cached far cascade.

void makVrv::DtShadowSettingsManager::setFarCascadeUpdateFrequency	(	int	quality,
		double	update_freq
	)

Sets far cascade update frequency.

double makVrv::DtShadowSettingsManager::farCascadeUpdateFrequency ( )

Gets far cascade update frequency.

void makVrv::DtShadowSettingsManager::setAdjustFarAndFlagsBasedOnHAT	(	int	quality,
		bool	adaptive
	)

Sets to make the near cascades automatically change size and flags in the air.

bool makVrv::DtShadowSettingsManager::adjustFarAndFlagsBasedOnHAT ( )

Gets if near cascades automatically change size and flags in the air.

void makVrv::DtShadowSettingsManager::setUsePolygonOffset	(	int	quality,
		bool	usePolygonOffset
	)

Sets use polygon offset.

bool makVrv::DtShadowSettingsManager::usePolygonOffset ( int quality ) const

Gets use polygon offset.

bool makVrv::DtShadowSettingsManager::usePolygonOffset ( ) const

Gets use polygon offset.

void makVrv::DtShadowSettingsManager::setPolygonOffset	(	int	quality,
		unsigned int	splitIndex,
		float	factor,
		float	units
	)

Sets polygon offset parameters.

float makVrv::DtShadowSettingsManager::polygonOffsetFactor	(	int	quality,
		unsigned int	splitIndex
	)		const

Gets polygon offset factor parameter.

float makVrv::DtShadowSettingsManager::polygonOffsetFactor ( unsigned int splitIndex ) const

Gets polygon offset factor parameter.

float makVrv::DtShadowSettingsManager::polygonOffsetUnits	(	int	quality,
		unsigned int	splitIndex
	)		const

Gets polygon offset unit parameter.

float makVrv::DtShadowSettingsManager::polygonOffsetUnits ( unsigned int splitIndex ) const

Gets polygon offset unit parameter.

void makVrv::DtShadowSettingsManager::setSpotLightShadowMapSize	(	int	quality,
		unsigned int	size
	)

Sets spot light texture atlas size.

unsigned int makVrv::DtShadowSettingsManager::spotLightShadowMapSize ( int quality ) const

Gets spot light texture atlas size.

unsigned int makVrv::DtShadowSettingsManager::spotLightShadowMapSize ( ) const

Gets spot light texture atlas size.

void makVrv::DtShadowSettingsManager::setGlobalLightShadowMapSize	(	int	quality,
		unsigned int	size
	)

Sets global light texture size for cascaded shadow mapping.

unsigned int makVrv::DtShadowSettingsManager::globalLightShadowMapSize ( ) const

Gets global light texture size for cascaded shadow mapping.

unsigned int makVrv::DtShadowSettingsManager::globalLightShadowMapSize ( int quality ) const

Gets global light texture size for cascaded shadow mapping.

void makVrv::DtShadowSettingsManager::setUseMaximumViewDistance	(	int	quality,
		bool	useMaximumViewDistance
	)

Sets use maximum view distance.

bool makVrv::DtShadowSettingsManager::useMaximumViewDistance ( int quality ) const

Gets use maximum view distance.

bool makVrv::DtShadowSettingsManager::useMaximumViewDistance ( ) const

Gets use maximum view distance.

void makVrv::DtShadowSettingsManager::setMaximumViewDistance	(	int	quality,
		double	viewDistance
	)

Set maximum view distance.

double makVrv::DtShadowSettingsManager::maximumViewDistance ( int quality ) const

Get maximum far distance.

double makVrv::DtShadowSettingsManager::maximumViewDistance ( ) const

Get maximum far distance.

void makVrv::DtShadowSettingsManager::setSplitNearDistanceMinimumBias	(	int	quality,
		double	bias
	)

Sets split near distance minimum bias.

double makVrv::DtShadowSettingsManager::splitNearDistanceMinimumBias ( int quality ) const

Gets split near distance minimum bias.

double makVrv::DtShadowSettingsManager::splitNearDistanceMinimumBias ( ) const

Gets split near distance minimum bias.

void makVrv::DtShadowSettingsManager::setSplitNearDistanceMaximumBias	(	int	quality,
		double	bias
	)

Sets split near distance maximum bias.

double makVrv::DtShadowSettingsManager::splitNearDistanceMaximumBias ( int quality ) const

Gets split near distance maximum bias.

double makVrv::DtShadowSettingsManager::splitNearDistanceMaximumBias ( ) const

Gets split near distance maximum bias.

void makVrv::DtShadowSettingsManager::setSplitFarDistanceBias	(	int	quality,
		double	bias
	)

Sets split far distance bias.

double makVrv::DtShadowSettingsManager::splitFarDistanceBias ( int quality ) const

Gets split far distance bias.

double makVrv::DtShadowSettingsManager::splitFarDistanceBias ( ) const

Gets split far distance bias.

void makVrv::DtShadowSettingsManager::setShadowAmbientFactor	(	int	quality,
		float	shadowAmbientFactor
	)

Sets shadow factor for modulating the scene.

float makVrv::DtShadowSettingsManager::shadowAmbientFactor ( int quality ) const

Gets shadow factor for modulating the scene.

float makVrv::DtShadowSettingsManager::shadowAmbientFactor ( ) const

Gets shadow factor for modulating the scene.

void makVrv::DtShadowSettingsManager::setShadowStabilizationScheme	(	int	quality,
		makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme	shadowStabilizationScheme
	)

Sets shadow stabilization scheme.

makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme makVrv::DtShadowSettingsManager::shadowStabilizationScheme ( int quality ) const

Gets shadow stabilization scheme.

makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme makVrv::DtShadowSettingsManager::shadowStabilizationScheme ( ) const

Gets shadow stabilization scheme.

void makVrv::DtShadowSettingsManager::setAntiFlickerQuantizationFactor	(	int	quality,
		float	antiFlickerQuantizationFactor
	)

Sets shadow anti-flicker quantization value for approximate stabilization scheme.

float makVrv::DtShadowSettingsManager::antiFlickerQuantizationFactor ( int quality ) const

Gets shadow anti-flicker quantization value for approximate stabilization scheme.

float makVrv::DtShadowSettingsManager::antiFlickerQuantizationFactor ( ) const

Gets shadow anti-flicker quantization value for approximate stabilization scheme.

void makVrv::DtShadowSettingsManager::setSplitDistanceComputeScheme	(	int	quality,
		makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme	splitDistanceComputeScheme
	)

Sets split distance compute scheme.

makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme makVrv::DtShadowSettingsManager::splitDistanceComputeScheme ( int quality ) const

Gets split distance compute scheme.

makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme makVrv::DtShadowSettingsManager::splitDistanceComputeScheme ( ) const

Gets split distance compute scheme.

void makVrv::DtShadowSettingsManager::setMixedSplitInterpolationValue	(	int	quality,
		double	interp
	)

Sets mixed logarithmic uniform split interpolation value.

double makVrv::DtShadowSettingsManager::mixedSplitInterpolationValue ( int quality ) const

Gets mixed logarithmic uniform split interpolation value.

double makVrv::DtShadowSettingsManager::mixedSplitInterpolationValue ( ) const

Gets mixed logarithmic uniform split interpolation value.

void makVrv::DtShadowSettingsManager::setSplitSelectionScheme	(	int	quality,
		makArchives::DtShadowSettingsRecord::SplitSelectionScheme	splitSelectionScheme
	)

Sets split selection scheme.

makArchives::DtShadowSettingsRecord::SplitSelectionScheme makVrv::DtShadowSettingsManager::splitSelectionScheme ( int quality ) const

Gets split selection scheme.

makArchives::DtShadowSettingsRecord::SplitSelectionScheme makVrv::DtShadowSettingsManager::splitSelectionScheme ( ) const

Gets split selection scheme.

void makVrv::DtShadowSettingsManager::setDataStorageScheme	(	int	quality,
		makArchives::DtShadowSettingsRecord::DataStorageScheme	dataStorageScheme
	)

Sets data storage scheme.

makArchives::DtShadowSettingsRecord::DataStorageScheme makVrv::DtShadowSettingsManager::dataStorageScheme ( int quality ) const

Gets data storage scheme.

makArchives::DtShadowSettingsRecord::DataStorageScheme makVrv::DtShadowSettingsManager::dataStorageScheme ( ) const

Gets data storage scheme.

void makVrv::DtShadowSettingsManager::setPreFilteringScheme	(	int	quality,
		makArchives::DtShadowSettingsRecord::PreFilteringScheme	preFilteringScheme
	)

Sets pre-filtering scheme.

makArchives::DtShadowSettingsRecord::PreFilteringScheme makVrv::DtShadowSettingsManager::preFilteringScheme ( int quality ) const

Gets pre-filtering scheme.

makArchives::DtShadowSettingsRecord::PreFilteringScheme makVrv::DtShadowSettingsManager::preFilteringScheme ( ) const

Gets pre-filtering scheme.

void makVrv::DtShadowSettingsManager::setFilteringScheme	(	int	quality,
		makArchives::DtShadowSettingsRecord::FilteringScheme	filteringScheme
	)

Sets filtering scheme.

makArchives::DtShadowSettingsRecord::FilteringScheme makVrv::DtShadowSettingsManager::filteringScheme ( int quality ) const

Gets filtering scheme.

makArchives::DtShadowSettingsRecord::FilteringScheme makVrv::DtShadowSettingsManager::filteringScheme ( ) const

Gets filtering scheme.

void makVrv::DtShadowSettingsManager::setPoissonDiskSamplingScheme	(	int	quality,
		makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme	poissonDiskSamplingScheme
	)

Sets poisson disk sampling scheme.

makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme makVrv::DtShadowSettingsManager::poissonDiskSamplingScheme ( int quality ) const

Gets poisson disk sampling scheme.

makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme makVrv::DtShadowSettingsManager::poissonDiskSamplingScheme ( ) const

Gets poisson disk sampling scheme.

void makVrv::DtShadowSettingsManager::setUseViewportMulticast	(	int	quality,
		bool	useViewportMulticast
	)

Turns on viewport multicast allows faster shadow generation on modern video cards.

bool makVrv::DtShadowSettingsManager::useViewportMulticast ( ) const

Gets use viewport multicast.

void makVrv::DtShadowSettingsManager::setNumPersistentPassesPerCascade	(	int	quality,
		unsigned int	numPasses
	)

Sets number of persistent passes per cascade.

unsigned int makVrv::DtShadowSettingsManager::numPersistentPassesPerCascade ( int quality ) const

Gets number of persistent passes per cascade.

unsigned int makVrv::DtShadowSettingsManager::numPersistentPassesPerCascade ( ) const

Gets number of persistent passes per cascade.

void makVrv::DtShadowSettingsManager::setNumAdditionalPassesPerCascade	(	int	quality,
		unsigned int	numPasses
	)

Sets number of passes per cascade.

unsigned int makVrv::DtShadowSettingsManager::numAdditionalPassesPerCascade ( int quality ) const

Gets number of passes per cascade.

unsigned int makVrv::DtShadowSettingsManager::numAdditionalPassesPerCascade ( ) const

Gets number of passes per cascade.

void makVrv::DtShadowSettingsManager::setPcfFilterWidth	(	int	quality,
		unsigned int	pcfFilterWidth
	)

Sets PCF filter width.

unsigned int makVrv::DtShadowSettingsManager::pcfFilterWidth ( int quality ) const

Gets PCF filter width.

unsigned int makVrv::DtShadowSettingsManager::pcfFilterWidth ( ) const

Gets PCF filter width.

void makVrv::DtShadowSettingsManager::setBlendCascadesBoundaries	(	int	quality,
		bool	blendCascadesBoundaries
	)

Enables/Disables blend between cascade boundaries.

bool makVrv::DtShadowSettingsManager::blendCascadesBoundaries ( int quality ) const

Gets blend between cascade boundaries.

bool makVrv::DtShadowSettingsManager::blendCascadesBoundaries ( ) const

Gets blend between cascade boundaries.

void makVrv::DtShadowSettingsManager::setUseSDSM	(	int	quality,
		bool	useSDSM
	)

Enables/Disables Sample Distribution Shadow Maps(SDSM)

bool makVrv::DtShadowSettingsManager::useSDSM ( int quality ) const

Gets Sample Distribution Shadow Maps(SDSM) enabled or disabled state.

bool makVrv::DtShadowSettingsManager::useSDSM ( ) const

Gets Sample Distribution Shadow Maps(SDSM) enabled or disabled state.

void makVrv::DtShadowSettingsManager::setSDSMReadBackLatency	(	int	quality,
		unsigned int	sdsmReadBackLatency
	)

Sets Sample Distribution Shadow Maps(SDSM) read back latency.

unsigned int makVrv::DtShadowSettingsManager::sdsmReadBackLatency ( int quality ) const

Gets Sample Distribution Shadow Maps(SDSM) read back latency.

unsigned int makVrv::DtShadowSettingsManager::sdsmReadBackLatency ( ) const

Gets Sample Distribution Shadow Maps(SDSM) read back latency.

void makVrv::DtShadowSettingsManager::setUseCameraDepthBufferForSDSM	(	int	quality,
		bool	useCameraDepthBufferForSDSM
	)

Enables/Disables the usage of the most recent camera depth buffer for Sample Distribution Shadow Maps(SDSM) as against rendering to a very small frame buffer.

bool makVrv::DtShadowSettingsManager::useCameraDepthBufferForSDSM ( int quality ) const

Gets the setting for the usage of the most recent camera depth buffer for Sample Distribution Shadow Maps(SDSM) as against rendering to a very small frame buffer.

bool makVrv::DtShadowSettingsManager::useCameraDepthBufferForSDSM ( ) const

Gets the setting for the usage of the most recent camera depth buffer for Sample Distribution Shadow Maps(SDSM) as against rendering to a very small frame buffer.

void makVrv::DtShadowSettingsManager::setEVSMPositiveExponent	(	int	quality,
		double	evsmPositiveExponent
	)

Sets exponential variance shadow maps(EVSM) positive exponent.

double makVrv::DtShadowSettingsManager::evsmPositiveExponent ( int quality ) const

Gets exponential variance shadow maps(EVSM) positive exponent.

double makVrv::DtShadowSettingsManager::evsmPositiveExponent ( ) const

Gets exponential variance shadow maps(EVSM) positive exponent.

void makVrv::DtShadowSettingsManager::setEVSMNegativeExponent	(	int	quality,
		double	evsmNegativeExponent
	)

Sets exponential variance shadow maps(EVSM) negative exponent.

double makVrv::DtShadowSettingsManager::evsmNegativeExponent ( int quality ) const

Gets exponential variance shadow maps(EVSM) negative exponent.

double makVrv::DtShadowSettingsManager::evsmNegativeExponent ( ) const

Gets exponential variance shadow maps(EVSM) negative exponent.

void makVrv::DtShadowSettingsManager::setVSMMininumVariance	(	int	quality,
		double	vsmMininumVariance
	)

Sets variance shadow maps(VSM) minimum variance.

double makVrv::DtShadowSettingsManager::vsmMininumVariance ( int quality ) const

Gets variance shadow maps(VSM) minimum variance.

double makVrv::DtShadowSettingsManager::vsmMininumVariance ( ) const

Gets variance shadow maps(VSM) minimum variance.

void makVrv::DtShadowSettingsManager::setESMDarkeningFactor	(	int	quality,
		double	esmDarkeningFactor
	)

Sets exponential shadow maps(ESM) darkening factor.

double makVrv::DtShadowSettingsManager::esmDarkeningFactor ( int quality ) const

Gets exponential shadow maps(ESM) darkening factor.

double makVrv::DtShadowSettingsManager::esmDarkeningFactor ( ) const

Gets exponential shadow maps(ESM) darkening factor.

void makVrv::DtShadowSettingsManager::setDirty	(	int	quality,
		bool	dirty
	)

Mark settings as dirty or changed.

bool makVrv::DtShadowSettingsManager::dirty ( int quality ) const

Checks if any setting just changed.

bool makVrv::DtShadowSettingsManager::dirty ( ) const

Checks if any setting just changed.

void makVrv::DtShadowSettingsManager::setCurrentPolygonOffsetCascade ( unsigned int cascade )

Sets current polygon offset cascade.

unsigned int makVrv::DtShadowSettingsManager::currentPolygonOffsetCascade ( ) const

Gets current polygon offset cascade.

virtual void makVrv::DtShadowSettingsManager::loadDefaults ( )

virtual

Load the default settings.

Reimplemented from makVrv::DtCommonBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >.

virtual void makVrv::DtShadowSettingsManager::importSettings ( const std::string & filePath )

virtual

Load the settings' state from the given file.

Reimplemented from makVrv::DtCommonBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >.

virtual void makVrv::DtShadowSettingsManager::setFromRecord ( const makArchives::DtShadowSettingsCollectionRecord & record )

virtual

Use the shadow settings from the given settings record.

Implements makVrv::DtBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >.

virtual void makVrv::DtShadowSettingsManager::setShadowSettingsFromRecord	(	const makArchives::DtShadowSettingsCollectionRecord &	record,
		int	quality
	)

virtual

Use the shadow settings from the given record.

virtual void makVrv::DtShadowSettingsManager::getRecord ( makArchives::DtShadowSettingsCollectionRecord & record ) const

virtual

Populate the given record with the current settings.

Implements makVrv::DtBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >.

virtual void makVrv::DtShadowSettingsManager::getShadowSettingsFromRecord	(	makArchives::DtShadowSettingsCollectionRecord &	record,
		int	quality
	)		const

virtual

Populate the given record with the current settings.

virtual DtShadowSettingsCollectionBackup* makVrv::DtShadowSettingsManager::shadowSettingsCollectionBackup ( )

virtual

Return our settings backup object, properly cast to the derived version we are using.

void makVrv::DtShadowSettingsManager::slot_slaveAdded ( const makVrv::DtDeRecord & igRecord )

protected

Ensures the shadow settings object agents are properly distributed when a De is connected.

See Also: makVrv::DtDriver::slot_slaveAdded( const makVrv::DtDeRecord& )

DtShadowSettingsObjectAgent* makVrv::DtShadowSettingsManager::getShadowSettingsObjectAgentPtr ( int quality ) const

protected

Accessor for a pointer to the observer mode with the given key.

Returns: a pointer to the observer mode, or NULL if there isn't one.

virtual void makVrv::DtShadowSettingsManager::addShadowSettingsObjectAgent	(	int	quality,
		const std::string &	stringKey,
		DtShadowSettingsObjectAgent *	agent
	)

protectedvirtual

Add an already filled out mode (such as one read from a file)

Note that if the mode already exists, it overwrites it.

virtual void makVrv::DtShadowSettingsManager::createShadowSettings	(	int	quality,
		const std::string &	stringKey
	)

protectedvirtual

Add a observer mode.

An modeKey will be assigned. The user can then set the key map and model set to use. Returns the modeKey assigned

virtual void makVrv::DtShadowSettingsManager::removeShadowQuality ( int quality )

protectedvirtual

Remove a observer mode.

virtual void makVrv::DtShadowSettingsManager::clear ( )

protectedvirtual

delete all the current visual modes

virtual void makVrv::DtShadowSettingsManager::initializeBackup ( )

protectedvirtual

Creates a backup of the settings' current state.

Reimplemented from makVrv::DtBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >.

Friends And Related Function Documentation

friend class DtShadowSettingsManagerCreator

friend

Befriend the creator class so the manager can be instantiated properly.

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction	(	DtDe &	de,
		bool	allowedInSlave
	)

friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

  Manager requirements:
  1) Static instance function
  2) Protected DtSignalConnectionManager named myConnections.
  3) Member functioned called loadDefaults which takes no arguments.
     and loads the default settings of the manager or factory from disk.
  4) define defaultManagerInstanceFunction as friend.
  5) define defaultManagerRegisterInstanceFunction as friend (see below).
  5) Protected Constructor which only takes a DtDe reference.
  @code

class Manager { public: static Manager& instance(DtDe& de); void loadDefaults(); protected: template <typename managerclass>=""> friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool); template <typename managerclass>=""> friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr) Manager(DtDe&); DtSignalConnectionManager myConnections; };

  Then simply in the implementation of instance call 
  defaultManagerInstanceFunction with the de object and return the return
  value.
  @code

Manager& Manager::instance(DtDe& de) { return defaultManagerInstanceFunction<Manager>(de); }

template<typename ManagerClass >

void defaultManagerRegisterInstanceFunction	(	DtDe &	de,
		ManagerClass *	mgr
	)

friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

  @code

static void Manager::registerInstance(DtDe& de, Manager* mgr) { defaultManagerRegisterInstanceFunction(de,mgr); } ...else where call. // Assuming class NewManager : public Manager Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

boost::signal<void(int, const std::string&)> makVrv::DtShadowSettingsManager::shadowSettingsNameChanged

brief signal that the indicated shadow setting's name changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsEntitiesCastsShadowsChanged

brief signal that the indicated shadow setting's entities casts shadows changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsPropsCastsShadowsChanged

brief signal that the indicated shadow setting's props casts shadows changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsTerrainCastsShadowsChanged

brief signal that the indicated shadow setting's terrain casts shadows changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsCloudsCastsShadowsChanged

brief signal that the indicated shadow setting's clouds casts shadows changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsVisualizeShadowsChanged

brief signal that the indicated shadow setting's shadow visualization mode changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsNumberOfSplitsChanged

brief signal that the indicated shadow setting's shadow visualization mode changed

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsUseFrontFaceCullingChanged

brief signal that the indicated shadow setting's use front face culling changed

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsUseCachedFarCascadeChanged

brief signal that the indicated shadow setting's use cached far cascade changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsFarCascadeUpdateFreqChanged

brief signal that the indicated shadow setting's far cascade update changed

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsAdjustFarAndFlagsBasedOnHATChanged

brief signal near cascades automatically change size and flags in the air

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsUseViewportMulticastChanged

brief signal that the indicated shadow setting's use viewport multicast changed

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsUsePolygonOffsetChanged

brief signal that the indicated shadow setting's use polygon offset changed

boost::signal<void(int, unsigned int, float)> makVrv::DtShadowSettingsManager::shadowSettingsPolygonOffsetFactorChanged

brief signal that the indicated shadow setting's polygon offset factor parameter changed

boost::signal<void(int, unsigned int, float)> makVrv::DtShadowSettingsManager::shadowSettingsPolygonOffsetUnitsChanged

brief signal that the indicated shadow setting's polygon offset unit parameter changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsSpotLightShadowMapSizeChanged

brief signal that the indicated shadow setting's spot light texture atlas size changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsGlobalLightShadowMapSizeChanged

brief signal that the indicated shadow setting's global light texture size for cascaded shadow mapping changed

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsUseMaximumViewDistanceChanged

brief signal that the indicated shadow setting's use maximum view distance changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsMaximumViewDistanceChanged

brief signal that the indicated shadow setting's maximum view distance changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsSplitNearDistanceMinimumBiasChanged

brief signal that the indicated shadow setting's split near distance minimum bias changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsSplitNearDistanceMaximumBiasChanged

brief signal that the indicated shadow setting's split near distance maximum bias changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsSplitFarDistanceBiasChanged

brief signal that the indicated shadow setting's split far distance bias changed

boost::signal<void(int, float)> makVrv::DtShadowSettingsManager::shadowSettingsShadowFactorChanged

brief signal that the indicated shadow setting's shadow factor for modulating the scene changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsShadowStabilizationSchemeChanged

brief signal that the indicated shadow setting's shadow stabilization scheme changed

boost::signal<void(int, float)> makVrv::DtShadowSettingsManager::shadowSettingsAntiFlickerQuantizationFactorChanged

brief signal that the indicated shadow setting's shadow anti-flicker quantization value for approximate stabilization scheme changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsSplitDistanceComputeSchemeChanged

brief signal that the indicated shadow setting's split distance compute scheme changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsMixedSplitInterpolationValueChanged

brief signal that the indicated shadow setting's mixed logarithmic uniform split interpolation value changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsSplitSelectionSchemeChanged

brief signal that the indicated shadow setting's split selection scheme changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsDataStorageSchemeChanged

brief signal that the indicated shadow setting's data storage scheme changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsPreFilteringSchemeChanged

brief signal that the indicated shadow setting's pre-filtering scheme changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsFilteringSchemeChanged

brief signal that the indicated shadow setting's filtering scheme changed

boost::signal<void(int, int)> makVrv::DtShadowSettingsManager::shadowSettingsPoissonDiskSamplingSchemeChanged

brief signal that the indicated shadow setting's poisson disk sampling scheme changed

boost::signal<void(int, unsigned int)> makVrv::DtShadowSettingsManager::shadowSettingsNumPersistentPassesPerCascadeChanged

brief signal that the indicated shadow setting's persistent number of passes per cascade changed

boost::signal<void(int, unsigned int)> makVrv::DtShadowSettingsManager::shadowSettingsNumAdditionalPassesPerCascadeChanged

brief signal that the indicated shadow setting's additional number of passes per cascade changed

boost::signal<void(int, unsigned int)> makVrv::DtShadowSettingsManager::shadowSettingsPcfFilterWidthChanged

brief signal that the indicated shadow setting's PCF filter width changed

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsBlendCascadesBoundariesChanged

brief signal that the indicated shadow setting's blend cascades boundaries changed

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsUseSDSMChanged

brief signal that the indicated shadow setting's use sdsm flag changed

boost::signal<void(int, unsigned int)> makVrv::DtShadowSettingsManager::shadowSettingsSDSMReadBackLatencyChanged

brief signal that the indicated shadow setting's sdsm read back latency changed

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsUseCameraDepthBufferForSDSMChanged

brief signal that the indicated shadow setting's use camera depth buffer for sdsm flag changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsEVSMPositiveExponentChanged

brief signal that the indicated shadow setting's evsm positive exponent changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsEVSMNegativeExponentChanged

brief signal that the indicated shadow setting's evsm negative exponent changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsVSMMininumVarianceChanged

brief signal that the indicated shadow setting's vsm minimum variance changed

boost::signal<void(int, double)> makVrv::DtShadowSettingsManager::shadowSettingsESMDarkeningFactorChanged

brief signal that the indicated shadow setting's esm darkening factor changed

boost::signal<void(int, bool)> makVrv::DtShadowSettingsManager::shadowSettingsDirtyChanged

brief signal that the indicated shadow setting's dirty flag changed

boost::signal<void(int)> makVrv::DtShadowSettingsManager::shadowSettingsAdded

signal that the indicated shadow setting was added

boost::signal<void(int)> makVrv::DtShadowSettingsManager::shadowSettingsToBeRemoved

signal that the indicated shadow setting is about to be removed

unsigned int makVrv::DtShadowSettingsManager::myCurrentQualitySetting

protected

unsigned int makVrv::DtShadowSettingsManager::myCurrentPolygonOffsetCascade

protected

std::string makVrv::DtShadowSettingsManager::myName

protected

int makVrv::DtShadowSettingsManager::myQuality

protected

makArchives::DtShadowSettingsRecord* makVrv::DtShadowSettingsManager::myCurrentSettings

protected

DtStringKeyConverter* makVrv::DtShadowSettingsManager::myStringKeyConverter

protected

ShadowSettingsObjectAgents makVrv::DtShadowSettingsManager::myShadowSettingsObjectAgents

mutableprotected

ShadowSettingsObjectAgentsMap makVrv::DtShadowSettingsManager::myShadowSettingsObjectAgentsMap

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtShadowSettingsManager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation