OpenSceneGraph
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
osgShadow::ShadowTechnique Class Referenceabstract

ShadowTechnique is the base class for different shadow implementations. More...

Inheritance diagram for osgShadow::ShadowTechnique:
Inheritance graph
[legend]

Classes

class  CameraCullCallback
 

Public Member Functions

 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)
 
ShadowedScenegetShadowedScene ()
 
const ShadowedScenegetShadowedScene () const
 
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 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)
 
virtual void dirty ()
 Dirty so that cached data structures are updated. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)=0
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const =0
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. 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 ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (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 NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () 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 UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 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 CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () 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::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 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 ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () 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 &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () 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...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () 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

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

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
 

Friends

class ShadowedScene
 

Additional Inherited Members

- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 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 DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

ShadowTechnique is the base class for different shadow implementations.

Constructor & Destructor Documentation

◆ ShadowTechnique() [1/2]

osgShadow::ShadowTechnique::ShadowTechnique ( )

◆ ShadowTechnique() [2/2]

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

◆ ~ShadowTechnique()

virtual osgShadow::ShadowTechnique::~ShadowTechnique ( )
protectedvirtual

Member Function Documentation

◆ className()

virtual const char* osgShadow::ShadowTechnique::className ( ) const
inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Implements osg::Object.

◆ cleanSceneGraph()

virtual void osgShadow::ShadowTechnique::cleanSceneGraph ( )
virtual

Clean scene graph from any shadow technique specific nodes, state and drawables.

Reimplemented in osgShadow::ViewDependentShadowTechnique, osgShadow::ShadowMap, osgShadow::ParallelSplitShadowMap, osgShadow::ViewDependentShadowMap, and osgShadow::ShadowTexture.

◆ computeOrthogonalVector()

osg::Vec3 osgShadow::ShadowTechnique::computeOrthogonalVector ( const osg::Vec3 direction) const
protected

◆ cull()

virtual void osgShadow::ShadowTechnique::cull ( osgUtil::CullVisitor cv)
virtual

◆ dirty()

virtual void osgShadow::ShadowTechnique::dirty ( )
inlinevirtual

Dirty so that cached data structures are updated.

Reimplemented in osgShadow::ViewDependentShadowTechnique.

References osg::releaseGLObjects(), and osg::resizeGLObjectBuffers().

◆ getShadowedScene() [1/2]

ShadowedScene* osgShadow::ShadowTechnique::getShadowedScene ( )
inline

◆ getShadowedScene() [2/2]

const ShadowedScene* osgShadow::ShadowTechnique::getShadowedScene ( ) const
inline

◆ init()

virtual void osgShadow::ShadowTechnique::init ( )
virtual

◆ isSameKindAs()

virtual bool osgShadow::ShadowTechnique::isSameKindAs ( const osg::Object obj) const
inlinevirtual

Reimplemented from osg::Object.

References NULL.

◆ libraryName()

virtual const char* osgShadow::ShadowTechnique::libraryName ( ) const
inlinevirtual

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

◆ releaseGLObjects()

virtual void osgShadow::ShadowTechnique::releaseGLObjects ( osg::State = 0) const
pure virtual

If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.

Otherwise, releases OpenGL objects for all graphics contexts.

Reimplemented from osg::Object.

Implemented in osgShadow::ViewDependentShadowTechnique, osgShadow::ParallelSplitShadowMap, osgShadow::StandardShadowMap, osgShadow::ShadowMap, osgShadow::DebugShadowMap, osgShadow::ShadowTexture, and osgShadow::ViewDependentShadowMap.

◆ resizeGLObjectBuffers()

virtual void osgShadow::ShadowTechnique::resizeGLObjectBuffers ( unsigned int  maxSize)
pure virtual

◆ setShadowedScene()

virtual void osgShadow::ShadowTechnique::setShadowedScene ( ShadowedScene ss)
virtual

◆ traverse()

virtual void osgShadow::ShadowTechnique::traverse ( osg::NodeVisitor nv)
virtual

◆ update()

virtual void osgShadow::ShadowTechnique::update ( osg::NodeVisitor nv)
virtual

run the update traversal of the ShadowedScene and update any local cached data structures.

Reimplemented in osgShadow::ViewDependentShadowTechnique, osgShadow::ShadowMap, osgShadow::ParallelSplitShadowMap, osgShadow::ShadowTexture, and osgShadow::ViewDependentShadowMap.

Friends And Related Function Documentation

◆ ShadowedScene

friend class ShadowedScene
friend

Member Data Documentation

◆ _dirty

bool osgShadow::ShadowTechnique::_dirty
protected

◆ _shadowedScene

ShadowedScene* osgShadow::ShadowTechnique::_shadowedScene
protected

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