makVrv::DtShadowSettingsObject Class Reference

Public Member Functions
	DtShadowSettingsObject (DtDe &de, DtUniqueID id, const std::string &name="")
	~DtShadowSettingsObject ()
void	setNameAndRegister (const std::string &name, int quality)
const std::string &	name ()
int	quality () const
void	setDirty (bool dirty)
bool	dirty () const
void	setEntitiesCastsShadows (bool castShadows)
bool	entitiesCastsShadows () const
void	setPropsCastsShadows (bool castShadows)
bool	propsCastsShadows () const
void	setTerrainCastsShadows (bool castShadows)
bool	terrainCastsShadows () const
void	setMoonCastsShadows (bool castShadows)
bool	moonCastsShadows () const
void	setVisualizeShadows (bool visualizeShadows)
bool	visualizeShadows () const
void	setNumberOfSplits (unsigned int numSplits)
unsigned int	numberOfSplits () const
void	setUseCachedFarCascade (bool useCachedFarCascade)
bool	useCachedFarCascade () const
void	setFarCascadeUpdateFrequency (float value)
float	farCascadeUpdateFrequency () const
void	setUseFrontFaceCulling (bool useFrontFaceCulling)
bool	useFrontFaceCulling () const
void	setUsePolygonOffset (bool usePolygonOffset)
bool	usePolygonOffset () const
void	setPolygonOffset (unsigned int splitIndex, float factor, float units)
float	polygonOffsetFactor (unsigned int splitIndex) const
float	polygonOffsetUnits (unsigned int splitIndex) const
void	setSpotLightShadowMapSize (unsigned int size)
unsigned int	spotLightShadowMapSize () const
void	setGlobalLightShadowMapSize (unsigned int size)
unsigned int	globalLightShadowMapSize () const
void	setUseMaximumViewDistance (bool useMaximumViewDistance)
bool	useMaximumViewDistance () const
void	setMaximumViewDistance (double viewDistance)
double	maximumViewDistance () const
void	setShadowAmbientFactor (float shadowAmbientFactor)
float	shadowAmbientFactor () const
void	setShadowStabilizationScheme (makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme shadowStabilizationScheme)
makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme	shadowStabilizationScheme () const
void	setSplitDistanceComputeScheme (makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme splitDistanceComputeScheme)
makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme	splitDistanceComputeScheme () const
void	setMixedSplitInterpolationValue (double interp)
double	mixedSplitInterpolationValue () const
void	setSplitSelectionScheme (makArchives::DtShadowSettingsRecord::SplitSelectionScheme splitSelectionScheme)
makArchives::DtShadowSettingsRecord::SplitSelectionScheme	splitSelectionScheme () const
void	setPreFilteringScheme (makArchives::DtShadowSettingsRecord::PreFilteringScheme preFilteringScheme)
makArchives::DtShadowSettingsRecord::PreFilteringScheme	preFilteringScheme () const
void	setFilteringScheme (makArchives::DtShadowSettingsRecord::FilteringScheme filteringScheme)
makArchives::DtShadowSettingsRecord::FilteringScheme	filteringScheme () const
void	setPoissonDiskSamplingScheme (makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme poissonDiskSamplingScheme)
makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme	poissonDiskSamplingScheme () const
void	setUseViewportMulticast (bool useViewportMulticast)
bool	useViewportMulticast () const
void	setNumPersistentPassesPerCascade (unsigned int numPasses)
unsigned int	numPersistentPassesPerCascade () const
void	setNumAdditionalPassesPerCascade (unsigned int numPasses)
unsigned int	numAdditionalPassesPerCascade () const
void	setPcfFilterWidth (unsigned int pcfFilterWidth)
unsigned int	pcfFilterWidth () const
void	setBlendCascadesBoundaries (bool blendCascadesBoundaries)
bool	blendCascadesBoundaries () const
void	setAdjustFarAndFlagsBasedOnHAT (bool enabled)
bool	adjustFarAndFlagsBasedOnHAT () const
void	setApplyShadowToAmbientLighting (bool applyShadowToAmbient)
bool	applyShadowToAmbientLighting ()
void	setSplitNearDistanceMinimumBias (double bias)
double	splitNearDistanceMinimumBias () const
void	setSplitNearDistanceMaximumBias (double bias)
double	splitNearDistanceMaximumBias () const
void	setSplitFarDistanceBias (double bias)
double	splitFarDistanceBias () const
void	setEVSMPositiveExponent (double evsmPositiveExponent)
double	evsmPositiveExponent () const
void	setEVSMNegativeExponent (double evsmNegativeExponent)
double	evsmNegativeExponent () const
void	setVSMMininumVariance (double vsmMininumVariance)
double	vsmMininumVariance () const
void	setESMDarkeningFactor (double esmDarkeningFactor)
double	esmDarkeningFactor () const
void	setAntiFlickerQuantizationFactor (float antiFlickerQuantizationFactor)
float	antiFlickerQuantizationFactor () const

Protected Attributes
std::string	myName
int	myQuality
DtDe &	myDe
bool	myDirty
bool	myEntitiesCastsShadows
bool	myPropsCastsShadows
bool	myTerrainCastsShadows
bool	myMoonCastsShadows
unsigned int	myNumSplits
std::vector< float >	myPolygonOffsetFactor
std::vector< float >	myPolygonOffsetUnits
unsigned int	myGlobalLightShadowMapSize
double	myMaximumViewDistance
bool	myUseMaximumViewDistance
bool	myUseFrontFaceCulling
bool	myUseCachedFarCascade
float	myFarCascadeUpdateFrequency
bool	myUseViewportMulticast
bool	myAdjustFarAndFlagsBasedOnHAT
float	myShadowAmbientFactor
makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme	myShadowStabilizationScheme
makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme	mySplitDistanceComputeScheme
double	myMixedSplitInterp
makArchives::DtShadowSettingsRecord::SplitSelectionScheme	mySplitSelectionScheme
makArchives::DtShadowSettingsRecord::PreFilteringScheme	myPreFilteringScheme
makArchives::DtShadowSettingsRecord::FilteringScheme	myFilteringScheme
makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme	myPoissonDiskSamplingScheme
unsigned int	myNumPersistentPassesPerCascade
unsigned int	myNumAdditionalPassesPerCascade
unsigned int	myPcfFilterWidth
bool	myBlendCascadesBoundaries
bool	myApplyShadowToAmbientLighting
bool	myVisualizeShadows
unsigned int	mySpotLightShadowMapSize
bool	myUsePolygonOffset

Constructor & Destructor Documentation

makVrv::DtShadowSettingsObject::DtShadowSettingsObject	(	DtDe &	de,
		DtUniqueID	id,
		const std::string &	name = ""
	)

CTOR.

makVrv::DtShadowSettingsObject::~DtShadowSettingsObject

(

)

DTOR.

Member Function Documentation

void makVrv::DtShadowSettingsObject::setNameAndRegister	(	const std::string &	name,
		int	quality
	)

Sets setting name and registers the settings object in the DtShadowSettingsObjectManager singleton.

const std::string& makVrv::DtShadowSettingsObject::name ( void  )

inline

Returns setting name.

int makVrv::DtShadowSettingsObject::quality ( ) const

inline

Returns setting name.

void makVrv::DtShadowSettingsObject::setDirty

(

bool

dirty

)

Mark settings as dirty or changed.

bool makVrv::DtShadowSettingsObject::dirty ( ) const

inline

Checks if any setting just changed.

void makVrv::DtShadowSettingsObject::setEntitiesCastsShadows

(

bool

castShadows

)

Sets entities casts shadow flag.

bool makVrv::DtShadowSettingsObject::entitiesCastsShadows ( ) const

inline

Gets entities casts shadow flag.

void makVrv::DtShadowSettingsObject::setPropsCastsShadows

(

bool

castShadows

)

Sets props casts shadow flag.

bool makVrv::DtShadowSettingsObject::propsCastsShadows ( ) const

inline

Gets props casts shadow flag.

void makVrv::DtShadowSettingsObject::setTerrainCastsShadows

(

bool

castShadows

)

Sets terrain casts shadow flag.

bool makVrv::DtShadowSettingsObject::terrainCastsShadows ( ) const

inline

Gets terrain casts shadow flag.

void makVrv::DtShadowSettingsObject::setMoonCastsShadows

(

bool

castShadows

)

Sets moon casts shadow flag.

bool makVrv::DtShadowSettingsObject::moonCastsShadows ( ) const

inline

Gets moon casts shadow flag.

void makVrv::DtShadowSettingsObject::setVisualizeShadows

(

bool

visualizeShadows

)

Sets shadow visualization mode.

bool makVrv::DtShadowSettingsObject::visualizeShadows ( ) const

inline

Gets shadow visualization mode.

void makVrv::DtShadowSettingsObject::setNumberOfSplits

(

unsigned int

numSplits

)

Sets shadow visualization mode.

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

inline

Gets shadow visualization mode.

void makVrv::DtShadowSettingsObject::setUseCachedFarCascade

(

bool

useCachedFarCascade

)

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

bool makVrv::DtShadowSettingsObject::useCachedFarCascade ( ) const

inline

Gets use cached far cascade.

void makVrv::DtShadowSettingsObject::setFarCascadeUpdateFrequency ( float  value )

inline

Sets far cascade update frequency.

float makVrv::DtShadowSettingsObject::farCascadeUpdateFrequency ( ) const

inline

Gets far cascade update frequency.

void makVrv::DtShadowSettingsObject::setUseFrontFaceCulling

(

bool

useFrontFaceCulling

)

sets use front face culling

bool makVrv::DtShadowSettingsObject::useFrontFaceCulling ( ) const

inline

Gets use front face culling.

void makVrv::DtShadowSettingsObject::setUsePolygonOffset

(

bool

usePolygonOffset

)

Sets use polygon offset.

bool makVrv::DtShadowSettingsObject::usePolygonOffset ( ) const

inline

Gets use polygon offset.

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

Sets polygon offset parameters.

float makVrv::DtShadowSettingsObject::polygonOffsetFactor

(

unsigned int

splitIndex

)

const

Gets polygon offset factor parameter.

float makVrv::DtShadowSettingsObject::polygonOffsetUnits

(

unsigned int

splitIndex

)

const

Gets polygon offset unit parameter.

void makVrv::DtShadowSettingsObject::setSpotLightShadowMapSize

(

unsigned int

size

)

Sets spot light texture atlas size.

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

inline

Gets spot light texture atlas size.

void makVrv::DtShadowSettingsObject::setGlobalLightShadowMapSize

(

unsigned int

size

)

Sets global light texture size for cascaded shadow mapping.

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

inline

Gets global light texture size for cascaded shadow mapping.

void makVrv::DtShadowSettingsObject::setUseMaximumViewDistance

(

bool

useMaximumViewDistance

)

Sets use maximum view distance.

bool makVrv::DtShadowSettingsObject::useMaximumViewDistance ( ) const

inline

Gets use maximum view distance.

void makVrv::DtShadowSettingsObject::setMaximumViewDistance

(

double

viewDistance

)

Set maximum view distance.

double makVrv::DtShadowSettingsObject::maximumViewDistance ( ) const

inline

Get maximum far distance.

void makVrv::DtShadowSettingsObject::setShadowAmbientFactor

(

float

shadowAmbientFactor

)

Sets shadow factor for modulating the scene.

float makVrv::DtShadowSettingsObject::shadowAmbientFactor ( ) const

inline

Gets shadow factor for modulating the scene.

void makVrv::DtShadowSettingsObject::setShadowStabilizationScheme

(

makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme

shadowStabilizationScheme

)

Sets shadow stabilization scheme.

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

inline

Gets shadow stabilization scheme.

void makVrv::DtShadowSettingsObject::setSplitDistanceComputeScheme

(

makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme

splitDistanceComputeScheme

)

Sets split distance compute scheme.

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

inline

Gets split distance compute scheme.

void makVrv::DtShadowSettingsObject::setMixedSplitInterpolationValue

(

double

interp

)

Sets mixed logarithmic uniform split interpolation value.

double makVrv::DtShadowSettingsObject::mixedSplitInterpolationValue ( ) const

inline

Gets mixed logarithmic uniform split interpolation value.

void makVrv::DtShadowSettingsObject::setSplitSelectionScheme

(

makArchives::DtShadowSettingsRecord::SplitSelectionScheme

splitSelectionScheme

)

Sets split selection scheme.

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

inline

Gets split selection scheme.

void makVrv::DtShadowSettingsObject::setPreFilteringScheme

(

makArchives::DtShadowSettingsRecord::PreFilteringScheme

preFilteringScheme

)

Sets pre-filtering scheme.

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

inline

Gets pre-filtering scheme.

void makVrv::DtShadowSettingsObject::setFilteringScheme

(

makArchives::DtShadowSettingsRecord::FilteringScheme

filteringScheme

)

Sets filtering scheme.

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

inline

Gets filtering scheme.

void makVrv::DtShadowSettingsObject::setPoissonDiskSamplingScheme

(

makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme

poissonDiskSamplingScheme

)

Sets poisson disk sampling scheme.

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

inline

Gets poisson disk sampling scheme.

void makVrv::DtShadowSettingsObject::setUseViewportMulticast

(

bool

useViewportMulticast

)

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

bool makVrv::DtShadowSettingsObject::useViewportMulticast ( ) const

inline

Gets use viewport multicast.

void makVrv::DtShadowSettingsObject::setNumPersistentPassesPerCascade

(

unsigned int

numPasses

)

Sets persistent number of passes per cascade.

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

inline

Gets persistent number of passes per cascade.

void makVrv::DtShadowSettingsObject::setNumAdditionalPassesPerCascade

(

unsigned int

numPasses

)

Sets additional number of passes per cascade.

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

inline

Gets additional number of passes per cascade.

void makVrv::DtShadowSettingsObject::setPcfFilterWidth

(

unsigned int

pcfFilterWidth

)

Sets PCF filter width.

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

inline

Gets PCF filter width.

void makVrv::DtShadowSettingsObject::setBlendCascadesBoundaries

(

bool

blendCascadesBoundaries

)

Enables/Disables blend between cascade boundaries.

bool makVrv::DtShadowSettingsObject::blendCascadesBoundaries ( ) const

inline

Gets blend between cascade boundaries.

void makVrv::DtShadowSettingsObject::setAdjustFarAndFlagsBasedOnHAT ( bool  enabled )

inline

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

bool makVrv::DtShadowSettingsObject::adjustFarAndFlagsBasedOnHAT ( ) const

inline

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

void makVrv::DtShadowSettingsObject::setApplyShadowToAmbientLighting

(

bool

applyShadowToAmbient

)

Sets whether to apply the shadow factor to ambient lighting.

bool makVrv::DtShadowSettingsObject::applyShadowToAmbientLighting

(

)

Gets whether to apply the shadow factor to ambient lighting.

void makVrv::DtShadowSettingsObject::setSplitNearDistanceMinimumBias

(

double

bias

)

Sets split near distance minimum bias.

double makVrv::DtShadowSettingsObject::splitNearDistanceMinimumBias ( ) const

inline

Gets split near distance minimum bias.

void makVrv::DtShadowSettingsObject::setSplitNearDistanceMaximumBias

(

double

bias

)

Sets split near distance maximum bias.

double makVrv::DtShadowSettingsObject::splitNearDistanceMaximumBias ( ) const

inline

Gets split near distance maximum bias.

void makVrv::DtShadowSettingsObject::setSplitFarDistanceBias

(

double

bias

)

Sets split far distance bias.

double makVrv::DtShadowSettingsObject::splitFarDistanceBias ( ) const

inline

Gets split far distance bias.

void makVrv::DtShadowSettingsObject::setEVSMPositiveExponent

(

double

evsmPositiveExponent

)

Sets exponential variance shadow maps(EVSM) positive exponent.

double makVrv::DtShadowSettingsObject::evsmPositiveExponent ( ) const

inline

Gets exponential variance shadow maps(EVSM) positive exponent.

void makVrv::DtShadowSettingsObject::setEVSMNegativeExponent

(

double

evsmNegativeExponent

)

Sets exponential variance shadow maps(EVSM) negative exponent.

double makVrv::DtShadowSettingsObject::evsmNegativeExponent ( ) const

inline

Gets exponential variance shadow maps(EVSM) negative exponent.

void makVrv::DtShadowSettingsObject::setVSMMininumVariance

(

double

vsmMininumVariance

)

Sets variance shadow maps(VSM) minimum variance.

double makVrv::DtShadowSettingsObject::vsmMininumVariance ( ) const

inline

Gets variance shadow maps(VSM) minimum variance.

void makVrv::DtShadowSettingsObject::setESMDarkeningFactor

(

double

esmDarkeningFactor

)

Sets exponential shadow maps(ESM) darkening factor.

double makVrv::DtShadowSettingsObject::esmDarkeningFactor ( ) const

inline

Gets exponential shadow maps(ESM) darkening factor.

void makVrv::DtShadowSettingsObject::setAntiFlickerQuantizationFactor

(

float

antiFlickerQuantizationFactor

)

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

float makVrv::DtShadowSettingsObject::antiFlickerQuantizationFactor ( ) const

inline

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

Member Data Documentation

std::string makVrv::DtShadowSettingsObject::myName

protected

int makVrv::DtShadowSettingsObject::myQuality

protected

DtDe& makVrv::DtShadowSettingsObject::myDe

protected

bool makVrv::DtShadowSettingsObject::myDirty

protected

bool makVrv::DtShadowSettingsObject::myEntitiesCastsShadows

protected

bool makVrv::DtShadowSettingsObject::myPropsCastsShadows

protected

bool makVrv::DtShadowSettingsObject::myTerrainCastsShadows

protected

bool makVrv::DtShadowSettingsObject::myMoonCastsShadows

protected

unsigned int makVrv::DtShadowSettingsObject::myNumSplits

protected

std::vector<float> makVrv::DtShadowSettingsObject::myPolygonOffsetFactor

protected

std::vector<float> makVrv::DtShadowSettingsObject::myPolygonOffsetUnits

protected

unsigned int makVrv::DtShadowSettingsObject::myGlobalLightShadowMapSize

protected

double makVrv::DtShadowSettingsObject::myMaximumViewDistance

protected

bool makVrv::DtShadowSettingsObject::myUseMaximumViewDistance

protected

bool makVrv::DtShadowSettingsObject::myUseFrontFaceCulling

protected

bool makVrv::DtShadowSettingsObject::myUseCachedFarCascade

protected

float makVrv::DtShadowSettingsObject::myFarCascadeUpdateFrequency

protected

bool makVrv::DtShadowSettingsObject::myUseViewportMulticast

protected

bool makVrv::DtShadowSettingsObject::myAdjustFarAndFlagsBasedOnHAT

protected

float makVrv::DtShadowSettingsObject::myShadowAmbientFactor

protected

makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme makVrv::DtShadowSettingsObject::myShadowStabilizationScheme

protected

makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme makVrv::DtShadowSettingsObject::mySplitDistanceComputeScheme

protected

double makVrv::DtShadowSettingsObject::myMixedSplitInterp

protected

makArchives::DtShadowSettingsRecord::SplitSelectionScheme makVrv::DtShadowSettingsObject::mySplitSelectionScheme

protected

makArchives::DtShadowSettingsRecord::PreFilteringScheme makVrv::DtShadowSettingsObject::myPreFilteringScheme

protected

makArchives::DtShadowSettingsRecord::FilteringScheme makVrv::DtShadowSettingsObject::myFilteringScheme

protected

makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme makVrv::DtShadowSettingsObject::myPoissonDiskSamplingScheme

protected

unsigned int makVrv::DtShadowSettingsObject::myNumPersistentPassesPerCascade

protected

unsigned int makVrv::DtShadowSettingsObject::myNumAdditionalPassesPerCascade

protected

unsigned int makVrv::DtShadowSettingsObject::myPcfFilterWidth

protected

bool makVrv::DtShadowSettingsObject::myBlendCascadesBoundaries

protected

bool makVrv::DtShadowSettingsObject::myApplyShadowToAmbientLighting

protected

bool makVrv::DtShadowSettingsObject::myVisualizeShadows

protected

unsigned int makVrv::DtShadowSettingsObject::mySpotLightShadowMapSize

protected

bool makVrv::DtShadowSettingsObject::myUsePolygonOffset

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtShadowSettingsObject.h