osgShadow::DebugShadowMap Class Reference

Class used as a layer for debuging resources used by derived xxxShadowMap classes. More...

Inheritance diagram for osgShadow::DebugShadowMap:

Classes
struct	ViewData

Public Types
typedef DebugShadowMap	ThisClass
	Convenient typedef used in definition of ViewData struct and methods. More...
typedef ViewDependentShadowTechnique	BaseClass
	Convenient typedef used in definition of ViewData struct and methods. More...
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
	DebugShadowMap ()
	Classic OSG constructor. More...
	DebugShadowMap (const DebugShadowMap &dsm, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	Classic OSG cloning constructor. More...
	META_Object (osgShadow, DebugShadowMap)
	Declaration of standard OSG object methods. More...
void	setDebugDraw (bool draw)
	Turn on/off debuging hud & rendering of debug volumes in main view. More...
bool	getDebugDraw (void) const
	Tell if debuging hud & rendering of debug volumes is active. More...
std::string	getDebugDump (void) const
	Get the file name of debuging dump. More...
void	setDebugDump (const std::string &debugDumpFile)
	Set the file name of debuging dump. More...
Public Member Functions inherited from osgShadow::ViewDependentShadowTechnique
	ViewDependentShadowTechnique (void)
	osgShadow::ShadowTechnique equivalent methods for view dependent techniques More...
	ViewDependentShadowTechnique (const ViewDependentShadowTechnique &vdst, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	Classic OSG cloning constructor. More...
	META_Object (osgShadow, ViewDependentShadowTechnique)
	Declaration of standard OSG object methods. More...
virtual void	dirty ()
	Dirty view data bits and force update of view data resources. More...
virtual void	init ()
	Initialize the ShadowedScene and some data structures. More...
virtual void	update (osg::NodeVisitor &nv)
	Run the update traversal of the ShadowedScene and update any local cached 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	traverse (osg::NodeVisitor &nv)
	Traverse shadow scene graph. More...
Public Member Functions inherited from osgShadow::ShadowTechnique
	ShadowTechnique ()
	ShadowTechnique (const ShadowTechnique &es, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgShadow, ShadowTechnique)
ShadowedScene *	getShadowedScene ()
const ShadowedScene *	getShadowedScene () 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	~DebugShadowMap ()
	Classic protected OSG destructor. More...
Protected Member Functions inherited from osgShadow::ViewDependentShadowTechnique
	~ViewDependentShadowTechnique (void)
	Classic protected OSG destructor. More...
virtual ViewDependentShadowTechnique::ViewData *	getViewDependentData (osgUtil::CullVisitor *cv)
	Return view dependent data for the cull visitor. More...
virtual void	setViewDependentData (osgUtil::CullVisitor *cv, ViewDependentShadowTechnique::ViewData *data)
	Define view dependent data for the cull visitor. More...
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::Vec2s	_hudSize
osg::Vec2s	_hudOrigin
osg::Vec2s	_viewportSize
osg::Vec2s	_viewportOrigin
osg::Vec2s	_orthoSize
osg::Vec2s	_orthoOrigin
bool	_doDebugDraw
std::string	_debugDump
osg::ref_ptr< osg::Shader >	_depthColorFragmentShader
Protected Attributes inherited from osgShadow::ViewDependentShadowTechnique
ViewDataMap	_viewDataMap
OpenThreads::Mutex	_viewDataMapMutex
	Mutex used to serialize accesses to ViewDataMap. More...
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
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...
Protected Types inherited from osgShadow::ViewDependentShadowTechnique
typedef std::map< osg::ref_ptr< osgUtil::CullVisitor >, osg::ref_ptr< ViewData > >	ViewDataMap
	Map of view dependent data per view cull visitor (CVs are used as indices) ViewDependentShadowTechnique uses this map to find VieData for each cull vitior. More...

Detailed Description

Class used as a layer for debuging resources used by derived xxxShadowMap classes.

As designed by its base ViewDepndentShadowTechnique, DebugShadowMap serves mainly as container of DebugShadowMap::ViewData objects. Most of the debuging support work is done by these objects. DebugShadowMap technique only initializes them in initViewDependentData method.

Debuging outputs present: Shadow maps (pseudo colored to improve readability) Shadow and related volumes (represented as convex polyhedra)

Member Typedef Documentation

typedef ViewDependentShadowTechnique osgShadow::DebugShadowMap::BaseClass

Convenient typedef used in definition of ViewData struct and methods.

typedef DebugShadowMap osgShadow::DebugShadowMap::ThisClass

Convenient typedef used in definition of ViewData struct and methods.

Constructor & Destructor Documentation

osgShadow::DebugShadowMap::DebugShadowMap

(

)

Classic OSG constructor.

osgShadow::DebugShadowMap::DebugShadowMap	(	const DebugShadowMap &	dsm,
		const osg::CopyOp &	copyop = osg::CopyOp::SHALLOW_COPY
	)

Classic OSG cloning constructor.

virtual osgShadow::DebugShadowMap::~DebugShadowMap ( )

protectedvirtual

Classic protected OSG destructor.

Member Function Documentation

bool osgShadow::DebugShadowMap::getDebugDraw ( void  ) const

inline

Tell if debuging hud & rendering of debug volumes is active.

std::string osgShadow::DebugShadowMap::getDebugDump ( void  ) const

inline

Get the file name of debuging dump.

osgShadow::DebugShadowMap::META_Object	(	osgShadow	,
		DebugShadowMap
	)

Declaration of standard OSG object methods.

void osgShadow::DebugShadowMap::setDebugDraw ( bool  draw )

inline

Turn on/off debuging hud & rendering of debug volumes in main view.

void osgShadow::DebugShadowMap::setDebugDump ( const std::string &  debugDumpFile )

inline

Set the file name of debuging dump.

Member Data Documentation

std::string osgShadow::DebugShadowMap::_debugDump

protected

osg::ref_ptr< osg::Shader > osgShadow::DebugShadowMap::_depthColorFragmentShader

protected

bool osgShadow::DebugShadowMap::_doDebugDraw

protected

osg::Vec2s osgShadow::DebugShadowMap::_hudOrigin

protected

osg::Vec2s osgShadow::DebugShadowMap::_hudSize

protected

osg::Vec2s osgShadow::DebugShadowMap::_orthoOrigin

protected

osg::Vec2s osgShadow::DebugShadowMap::_orthoSize

protected

osg::Vec2s osgShadow::DebugShadowMap::_viewportOrigin

protected

osg::Vec2s osgShadow::DebugShadowMap::_viewportSize

protected

---

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

• osgShadow/DebugShadowMap