osgShadow::ShadowSettings Class Reference

ShadowSettings provides the parameters that the ShadowTechnique should use as a guide for setting up shadowing. More...

Inheritance diagram for osgShadow::ShadowSettings:

Public Types
enum	ShadowMapProjectionHint { ORTHOGRAPHIC_SHADOW_MAP, PERSPECTIVE_SHADOW_MAP }
enum	MultipleShadowMapHint { PARALLEL_SPLIT, CASCADED }
enum	ShaderHint { NO_SHADERS, PROVIDE_FRAGMENT_SHADER, PROVIDE_VERTEX_AND_FRAGMENT_SHADER }
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
	ShadowSettings ()
	ShadowSettings (const ShadowSettings &ss, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgShadow, ShadowSettings)
void	setReceivesShadowTraversalMask (unsigned int mask)
unsigned int	getReceivesShadowTraversalMask () const
void	setCastsShadowTraversalMask (unsigned int mask)
unsigned int	getCastsShadowTraversalMask () const
void	setComputeNearFarModeOverride (osg::CullSettings::ComputeNearFarMode cnfn)
osg::CullSettings::ComputeNearFarMode	getComputeNearFarModeOverride () const
void	setLightNum (int lightNum)
	Set the LightNum of the light in the scene to assign a shadow for. More...
int	getLightNum () const
void	setBaseShadowTextureUnit (unsigned int unit)
unsigned int	getBaseShadowTextureUnit () const
void	setUseOverrideForShadowMapTexture (bool useOverride)
	Set whether to use osg::StateAttribute::OVERRIDE for the shadow map texture. More...
bool	getUseOverrideForShadowMapTexture () const
	Get whether to use osg::StateAttribute::OVERRIDE for the shadow map texture. More...
void	setTextureSize (const osg::Vec2s &textureSize)
	Set the size of the shadow map textures. More...
const osg::Vec2s &	getTextureSize () const
	Get the size of the shadow map textures. More...
void	setMinimumShadowMapNearFarRatio (double ratio)
double	getMinimumShadowMapNearFarRatio () const
void	setMaximumShadowMapDistance (double distance)
double	getMaximumShadowMapDistance () const
void	setShadowMapProjectionHint (ShadowMapProjectionHint hint)
ShadowMapProjectionHint	getShadowMapProjectionHint () const
void	setPerspectiveShadowMapCutOffAngle (double angle)
	Set the cut off angle, in degrees, between the light direction and the view direction that determines whether perspective shadow mapping is appropriate, or thar orthographic shadow map should be used instead. More...
double	getPerspectiveShadowMapCutOffAngle () const
void	setNumShadowMapsPerLight (unsigned int numShadowMaps)
unsigned int	getNumShadowMapsPerLight () const
void	setMultipleShadowMapHint (MultipleShadowMapHint hint)
MultipleShadowMapHint	getMultipleShadowMapHint () const
void	setShaderHint (ShaderHint shaderHint)
ShaderHint	getShaderHint () const
void	setDebugDraw (bool debugDraw)
bool	getDebugDraw () const
Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...
virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
	return the name of the object's library. More...
virtual const char *	className () const =0
	return the name of the object's class type. More...
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...
void	setName (const char *name)
	Set the name of object using a C style string. More...
const std::string &	getName () const
	Get the name of object. More...
void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...
DataVariance	getDataVariance () const
	Get the data variance of this object. More...
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...
template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
template<class T >
void	setUserData (const ref_ptr< T > &ud)
virtual Referenced *	getUserData ()
	Get user data. More...
virtual const Referenced *	getUserData () const
	Get const user data. More...
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...
virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template More...
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	referenceCount () const
	Return the number of pointers currently referencing this object. More...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Protected Member Functions
virtual	~ShadowSettings ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor. More...
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Protected Attributes
unsigned int	_receivesShadowTraversalMask
unsigned int	_castsShadowTraversalMask
osg::CullSettings::ComputeNearFarMode	_computeNearFearModeOverride
int	_lightNum
unsigned int	_baseShadowTextureUnit
bool	_useShadowMapTextureOverride
osg::Vec2s	_textureSize
double	_minimumShadowMapNearFarRatio
double	_maximumShadowMapDistance
ShadowMapProjectionHint	_shadowMapProjectionHint
double	_perspectiveShadowMapCutOffAngle
unsigned int	_numShadowMapsPerLight
MultipleShadowMapHint	_multipleShadowMapHint
ShaderHint	_shaderHint
bool	_debugDraw
Protected Attributes inherited from osg::Object
std::string	_name
DataVariance	_dataVariance
osg::UserDataContainer *	_userDataContainer
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Additional Inherited Members
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...
static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Detailed Description

ShadowSettings provides the parameters that the ShadowTechnique should use as a guide for setting up shadowing.

Member Enumeration Documentation

enum osgShadow::ShadowSettings::MultipleShadowMapHint

Enumerator
PARALLEL_SPLIT
CASCADED

enum osgShadow::ShadowSettings::ShaderHint

Enumerator
NO_SHADERS
PROVIDE_FRAGMENT_SHADER
PROVIDE_VERTEX_AND_FRAGMENT_SHADER

enum osgShadow::ShadowSettings::ShadowMapProjectionHint

Enumerator
ORTHOGRAPHIC_SHADOW_MAP
PERSPECTIVE_SHADOW_MAP

Constructor & Destructor Documentation

osgShadow::ShadowSettings::ShadowSettings

(

)

osgShadow::ShadowSettings::ShadowSettings	(	const ShadowSettings &	ss,
		const osg::CopyOp &	copyop = osg::CopyOp::SHALLOW_COPY
	)

virtual osgShadow::ShadowSettings::~ShadowSettings ( )

protectedvirtual

Member Function Documentation

unsigned int osgShadow::ShadowSettings::getBaseShadowTextureUnit ( ) const

inline

unsigned int osgShadow::ShadowSettings::getCastsShadowTraversalMask ( ) const

inline

osg::CullSettings::ComputeNearFarMode osgShadow::ShadowSettings::getComputeNearFarModeOverride ( ) const

inline

bool osgShadow::ShadowSettings::getDebugDraw ( ) const

inline

int osgShadow::ShadowSettings::getLightNum ( ) const

inline

double osgShadow::ShadowSettings::getMaximumShadowMapDistance ( ) const

inline

double osgShadow::ShadowSettings::getMinimumShadowMapNearFarRatio ( ) const

inline

MultipleShadowMapHint osgShadow::ShadowSettings::getMultipleShadowMapHint ( ) const

inline

unsigned int osgShadow::ShadowSettings::getNumShadowMapsPerLight ( ) const

inline

double osgShadow::ShadowSettings::getPerspectiveShadowMapCutOffAngle ( ) const

inline

unsigned int osgShadow::ShadowSettings::getReceivesShadowTraversalMask ( ) const

inline

ShaderHint osgShadow::ShadowSettings::getShaderHint ( ) const

inline

ShadowMapProjectionHint osgShadow::ShadowSettings::getShadowMapProjectionHint ( ) const

inline

const osg::Vec2s& osgShadow::ShadowSettings::getTextureSize ( ) const

inline

Get the size of the shadow map textures.

bool osgShadow::ShadowSettings::getUseOverrideForShadowMapTexture ( ) const

inline

Get whether to use osg::StateAttribute::OVERRIDE for the shadow map texture.

osgShadow::ShadowSettings::META_Object	(	osgShadow	,
		ShadowSettings
	)

void osgShadow::ShadowSettings::setBaseShadowTextureUnit ( unsigned int  unit )

inline

void osgShadow::ShadowSettings::setCastsShadowTraversalMask ( unsigned int  mask )

inline

void osgShadow::ShadowSettings::setComputeNearFarModeOverride ( osg::CullSettings::ComputeNearFarMode  cnfn )

inline

void osgShadow::ShadowSettings::setDebugDraw ( bool  debugDraw )

inline

void osgShadow::ShadowSettings::setLightNum ( int  lightNum )

inline

Set the LightNum of the light in the scene to assign a shadow for.

Default value is -1, which signifies that shadow technique should automatically select an active light to assign a shadow, typically this will be the first active light found.

void osgShadow::ShadowSettings::setMaximumShadowMapDistance ( double  distance )

inline

void osgShadow::ShadowSettings::setMinimumShadowMapNearFarRatio ( double  ratio )

inline

void osgShadow::ShadowSettings::setMultipleShadowMapHint ( MultipleShadowMapHint  hint )

inline

void osgShadow::ShadowSettings::setNumShadowMapsPerLight ( unsigned int  numShadowMaps )

inline

void osgShadow::ShadowSettings::setPerspectiveShadowMapCutOffAngle ( double  angle )

inline

Set the cut off angle, in degrees, between the light direction and the view direction that determines whether perspective shadow mapping is appropriate, or thar orthographic shadow map should be used instead.

Default is 2 degrees so that for any angle greater than 2 degrees perspective shadow map will be used, and any angle less than 2 degrees orthographic shadow map will be used. Note, if ShadowMapProjectionHint is set to ORTHOGRAPHIC_SHADOW_MAP then an orthographic shadow map will always be used.

void osgShadow::ShadowSettings::setReceivesShadowTraversalMask ( unsigned int  mask )

inline

void osgShadow::ShadowSettings::setShaderHint ( ShaderHint  shaderHint )

inline

void osgShadow::ShadowSettings::setShadowMapProjectionHint ( ShadowMapProjectionHint  hint )

inline

void osgShadow::ShadowSettings::setTextureSize ( const osg::Vec2s &  textureSize )

inline

Set the size of the shadow map textures.

void osgShadow::ShadowSettings::setUseOverrideForShadowMapTexture ( bool  useOverride )

inline

Set whether to use osg::StateAttribute::OVERRIDE for the shadow map texture.

Enabling override will force the shadow map texture to override any texture set on the shadow maps texture unit.

Member Data Documentation

unsigned int osgShadow::ShadowSettings::_baseShadowTextureUnit

protected

unsigned int osgShadow::ShadowSettings::_castsShadowTraversalMask

protected

osg::CullSettings::ComputeNearFarMode osgShadow::ShadowSettings::_computeNearFearModeOverride

protected

bool osgShadow::ShadowSettings::_debugDraw

protected

int osgShadow::ShadowSettings::_lightNum

protected

double osgShadow::ShadowSettings::_maximumShadowMapDistance

protected

double osgShadow::ShadowSettings::_minimumShadowMapNearFarRatio

protected

MultipleShadowMapHint osgShadow::ShadowSettings::_multipleShadowMapHint

protected

unsigned int osgShadow::ShadowSettings::_numShadowMapsPerLight

protected

double osgShadow::ShadowSettings::_perspectiveShadowMapCutOffAngle

protected

unsigned int osgShadow::ShadowSettings::_receivesShadowTraversalMask

protected

ShaderHint osgShadow::ShadowSettings::_shaderHint

protected

ShadowMapProjectionHint osgShadow::ShadowSettings::_shadowMapProjectionHint

protected

osg::Vec2s osgShadow::ShadowSettings::_textureSize

protected

bool osgShadow::ShadowSettings::_useShadowMapTextureOverride

protected

---

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

• osgShadow/ShadowSettings