SoftShadowMap provides an implementation of soft shadows with shadow maps. More...

Inheritance diagram for osgShadow::SoftShadowMap:

Public Member Functions
	SoftShadowMap ()

	SoftShadowMap (const SoftShadowMap &es, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgShadow, SoftShadowMap)

void	setSoftnessWidth (float softnessWidth)
	Set the values for width of the soft penumbra the shader will use. More...

float	getSoftnessWidth () const
	Get the value used for width of the soft penumbra in the shader. More...

void	setJitteringScale (float jitteringScale)
	Set the values for jittering scale the shader will use. More...

float	getJitteringScale () const
	Get the value used for jittering scale in the shader. More...

void	setJitterTextureUnit (unsigned int jitterTextureUnit)
	Set the texture unit that the jitter texture will be applied on. More...

unsigned int	getJitterTextureUnit () const
	Get the texture unit that the jitter texture will be applied on. More...

void	setBias (float bias)
	Add a small bias to the z-value, this can reduce shadow acne problem. More...

float	getBias () const
	Return the bias value. More...

Public Member Functions inherited from osgShadow::ShadowMap
	ShadowMap ()

	ShadowMap (const ShadowMap &es, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgShadow, ShadowMap)

void	setTextureUnit (unsigned int unit)
	Set the texture unit that the shadow texture will be applied on. More...

unsigned int	getTextureUnit () const
	Get the texture unit that the shadow texture will be applied on. More...

void	setPolygonOffset (const osg::Vec2 &polyOffset)
	set the polygon offset used initially More...

const osg::Vec2 &	getPolygonOffset () const
	get the used polygon offset More...

void	setAmbientBias (const osg::Vec2 &ambientBias)
	Set the values for the ambient bias the shader will use. More...

const osg::Vec2 &	getAmbientBias () const
	Get the values that are used for the ambient bias in the shader. More...

void	setTextureSize (const osg::Vec2s &textureSize)
	set the size in pixels x / y for the shadow texture. More...

const osg::Vec2s &	getTextureSize () const
	Get the values that are used for the ambient bias in the shader. More...

void	setLight (osg::Light *light)
	Set the Light that will cast shadows. More...

void	setLight (osg::LightSource *ls)

void	addShader (osg::Shader *shader)
	Add a shader to internal list, will be used instead of the default ones. More...

template<class T >
void	addShader (const osg::ref_ptr< T > &shader)

void	clearShaderList ()
	Reset internal shader list. More...

virtual void	init ()
	initialize the ShadowedScene and local cached data structures. More...

virtual void	update (osg::NodeVisitor &nv)
	run the update traversal of the ShadowedScene and update any loca chached data structures. More...

virtual void	cull (osgUtil::CullVisitor &cv)
	run the cull traversal of the ShadowedScene and set up the rendering for this ShadowTechnique. More...

virtual void	cleanSceneGraph ()
	Clean scene graph from any shadow technique specific nodes, state and drawables. More...

virtual void	resizeGLObjectBuffers (unsigned int maxSize)
	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...

osg::ref_ptr< osg::Camera >	makeDebugHUD ()

Public Member Functions inherited from osgShadow::ShadowTechnique
	ShadowTechnique ()

	ShadowTechnique (const ShadowTechnique &es, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

virtual bool	isSameKindAs (const osg::Object *obj) const

virtual const char *	libraryName () const
	return the name of the object's library. More...

virtual const char *	className () const
	return the name of the object's class type. More...

virtual void	setShadowedScene (ShadowedScene *ss)

ShadowedScene *	getShadowedScene ()

const ShadowedScene *	getShadowedScene () const

virtual void	traverse (osg::NodeVisitor &nv)

virtual void	dirty ()
	Dirty so that cached data structures are updated. More...

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...

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 StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...

virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, 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 UniformBase *	asUniformBase () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual UniformBase *	asUniformBase ()
	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 Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...

virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...

virtual Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...

virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...

virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...

virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...

virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...

virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...

virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...

virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...

virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...

virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...

virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...

virtual const Image *	asImage () const
	Convert 'this' into a Image pointer if Object is a Image, 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...

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)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...

	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	~SoftShadowMap (void)

void	createUniforms ()
	Create the managed Uniforms. More...

void	createShaders ()

void	initJittering (osg::StateSet *ss)

Protected Member Functions inherited from osgShadow::ShadowMap
virtual	~ShadowMap (void)

Protected Member Functions inherited from osgShadow::ShadowTechnique
osg::Vec3	computeOrthogonalVector (const osg::Vec3 &direction) const

virtual	~ShadowTechnique ()

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
osg::ref_ptr< osg::Uniform >	_softnessWidthUniform

osg::ref_ptr< osg::Uniform >	_jitteringScaleUniform

float	_softnessWidth

float	_jitteringScale

unsigned int	_jitterTextureUnit

Protected Attributes inherited from osgShadow::ShadowMap
osg::ref_ptr< osg::Camera >	_camera

osg::ref_ptr< osg::TexGen >	_texgen

osg::ref_ptr< osg::Texture2D >	_texture

osg::ref_ptr< osg::StateSet >	_stateset

osg::ref_ptr< osg::Program >	_program

osg::ref_ptr< osg::Light >	_light

osg::ref_ptr< osg::LightSource >	_ls

osg::ref_ptr< osg::Uniform >	_ambientBiasUniform

UniformList	_uniformList

ShaderList	_shaderList

unsigned int	_baseTextureUnit

unsigned int	_shadowTextureUnit

osg::Vec2	_polyOffset

osg::Vec2	_ambientBias

osg::Vec2s	_textureSize

Protected Attributes inherited from osgShadow::ShadowTechnique
ShadowedScene *	_shadowedScene

bool	_dirty

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
Public Types inherited from osgShadow::ShadowMap
typedef std::vector< osg::ref_ptr< osg::Uniform > >	UniformList

typedef std::vector< osg::ref_ptr< osg::Shader > >	ShaderList

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

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	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

SoftShadowMap provides an implementation of soft shadows with shadow maps.

Constructor & Destructor Documentation

◆ SoftShadowMap() [1/2]

osgShadow::SoftShadowMap::SoftShadowMap ( )

◆ SoftShadowMap() [2/2]

osgShadow::SoftShadowMap::SoftShadowMap	(	const SoftShadowMap &	es,
		const osg::CopyOp &	copyop = `osg::CopyOp::SHALLOW_COPY`
	)

◆ ~SoftShadowMap()

virtual osgShadow::SoftShadowMap::~SoftShadowMap ( void )

inlineprotectedvirtual

Member Function Documentation

◆ createShaders()

void osgShadow::SoftShadowMap::createShaders ( )

protectedvirtual

Reimplemented from osgShadow::ShadowMap.

◆ createUniforms()

void osgShadow::SoftShadowMap::createUniforms ( )

protectedvirtual

Create the managed Uniforms.

Reimplemented from osgShadow::ShadowMap.

◆ getBias()

float osgShadow::SoftShadowMap::getBias ( ) const

inline

Return the bias value.

◆ getJitteringScale()

float osgShadow::SoftShadowMap::getJitteringScale ( ) const

inline

Get the value used for jittering scale in the shader.

◆ getJitterTextureUnit()

unsigned int osgShadow::SoftShadowMap::getJitterTextureUnit ( ) const

inline

Get the texture unit that the jitter texture will be applied on.

◆ getSoftnessWidth()

float osgShadow::SoftShadowMap::getSoftnessWidth ( ) const

inline

Get the value used for width of the soft penumbra in the shader.

◆ initJittering()

void osgShadow::SoftShadowMap::initJittering ( osg::StateSet * ss )

protected

◆ META_Object()

osgShadow::SoftShadowMap::META_Object	(	osgShadow	,
		SoftShadowMap
	)

◆ setBias()

void osgShadow::SoftShadowMap::setBias ( float bias )

inline

Add a small bias to the z-value, this can reduce shadow acne problem.

This is the same as calling setPolygonOffset(osg::Vec2(bias,0)); Suitable values are 0-0.005 Default is 0.

◆ setJitteringScale()

void osgShadow::SoftShadowMap::setJitteringScale ( float jitteringScale )

Set the values for jittering scale the shader will use.

Zero is no jittering (i.e. see the banding in penumbra) High values (>64) cause 'pixelization' of the penumbra. Usually but not necessarily power of two number. Default is 32.

◆ setJitterTextureUnit()

void osgShadow::SoftShadowMap::setJitterTextureUnit ( unsigned int jitterTextureUnit )

Set the texture unit that the jitter texture will be applied on.

◆ setSoftnessWidth()

void osgShadow::SoftShadowMap::setSoftnessWidth ( float softnessWidth )

Set the values for width of the soft penumbra the shader will use.

Zero is for hard shadow (no penumbra). 0.01 is already very soft penumbra. Default is 0.005.

Member Data Documentation

◆ _jitteringScale

float osgShadow::SoftShadowMap::_jitteringScale

protected

◆ _jitteringScaleUniform

osg::ref_ptr<osg::Uniform> osgShadow::SoftShadowMap::_jitteringScaleUniform

protected

◆ _jitterTextureUnit

unsigned int osgShadow::SoftShadowMap::_jitterTextureUnit

protected

◆ _softnessWidth

float osgShadow::SoftShadowMap::_softnessWidth

protected

◆ _softnessWidthUniform

osg::ref_ptr<osg::Uniform> osgShadow::SoftShadowMap::_softnessWidthUniform

protected

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

osgShadow/SoftShadowMap

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoftShadowMap() [1/2]

◆ SoftShadowMap() [2/2]

◆ ~SoftShadowMap()

Member Function Documentation

◆ createShaders()

◆ createUniforms()

◆ getBias()

◆ getJitteringScale()

◆ getJitterTextureUnit()

◆ getSoftnessWidth()

◆ initJittering()

◆ META_Object()

◆ setBias()

◆ setJitteringScale()

◆ setJitterTextureUnit()

◆ setSoftnessWidth()

Member Data Documentation

◆ _jitteringScale

◆ _jitteringScaleUniform

◆ _jitterTextureUnit

◆ _softnessWidth

◆ _softnessWidthUniform