openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Callback Class Reference

#include <Callback>

Inheritance diagram for osg::Callback:
osg::Object osg::Referenced osg::CallbackObject osg::Camera::DrawCallback osg::DrawableCullCallback osg::DrawableEventCallback osg::DrawableUpdateCallback osg::NodeCallback osg::StateAttributeCallback osg::StateSet::Callback osg::UniformCallback osgShadow::MinimalDrawBoundsShadowMap::CameraCullCallback

Public Member Functions

 Callback ()
 
 Callback (const Callback &cb, const CopyOp &copyop)
 
 META_Object (osg, Callback)
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual NodeCallbackasNodeCallback ()
 
virtual const NodeCallbackasNodeCallback () const
 
virtual StateAttributeCallbackasStateAttributeCallback ()
 
virtual const StateAttributeCallbackasStateAttributeCallback () const
 
virtual UniformCallbackasUniformCallback ()
 
virtual const UniformCallbackasUniformCallback () const
 
virtual DrawableUpdateCallbackasDrawableUpdateCallback ()
 
virtual const DrawableUpdateCallbackasDrawableUpdateCallback () const
 
virtual DrawableEventCallbackasDrawableEventCallback ()
 
virtual const DrawableEventCallbackasDrawableEventCallback () const
 
virtual DrawableCullCallbackasDrawableCullCallback ()
 
virtual const DrawableCullCallbackasDrawableCullCallback () const
 
virtual osgGA::EventHandlerasEventHandler ()
 
virtual const osgGA::EventHandlerasEventHandler () const
 
virtual bool run (osg::Object *object, osg::Object *data)
 
bool traverse (osg::Object *object, osg::Object *data)
 
void setNestedCallback (osg::Callback *cb)
 
osg::CallbackgetNestedCallback ()
 
const osg::CallbackgetNestedCallback () const
 
void addNestedCallback (osg::Callback *nc)
 
void removeNestedCallback (osg::Callback *nc)
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 
virtual const char * className () const =0
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (osg::State *=0) const
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~Callback ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

ref_ptr< Callback_nestedCallback
 
- 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 osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Constructor & Destructor Documentation

◆ Callback() [1/2]

osg::Callback::Callback ( )
inline

◆ Callback() [2/2]

osg::Callback::Callback ( const Callback cb,
const CopyOp copyop 
)
inline

◆ ~Callback()

virtual osg::Callback::~Callback ( )
inlineprotectedvirtual

Member Function Documentation

◆ addNestedCallback()

void osg::Callback::addNestedCallback ( osg::Callback nc)
inline

◆ asCallback() [1/2]

virtual Callback * osg::Callback::asCallback ( )
inlinevirtual

Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. Equivalent to dynamic_cast<Callback*>(this).

Reimplemented from osg::Object.

Reimplemented in osgAnimation::AnimationUpdateCallback< osg::NodeCallback >, osgAnimation::AnimationUpdateCallback< osg::StateAttributeCallback >, and osgAnimation::AnimationUpdateCallback< osg::UniformCallback >.

◆ asCallback() [2/2]

virtual const Callback * osg::Callback::asCallback ( ) const
inlinevirtual

convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. Equivalent to dynamic_cast<const Callback*>(this).

Reimplemented from osg::Object.

Reimplemented in osgAnimation::AnimationUpdateCallback< osg::NodeCallback >, osgAnimation::AnimationUpdateCallback< osg::StateAttributeCallback >, and osgAnimation::AnimationUpdateCallback< osg::UniformCallback >.

◆ asCallbackObject() [1/2]

virtual CallbackObject * osg::Callback::asCallbackObject ( )
inlinevirtual

◆ asCallbackObject() [2/2]

virtual const CallbackObject * osg::Callback::asCallbackObject ( ) const
inlinevirtual

convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. Equivalent to dynamic_cast<const CallbackObject*>(this).

Reimplemented from osg::Object.

Reimplemented in osg::CallbackObject, osgAnimation::AnimationUpdateCallback< osg::NodeCallback >, osgAnimation::AnimationUpdateCallback< osg::StateAttributeCallback >, and osgAnimation::AnimationUpdateCallback< osg::UniformCallback >.

◆ asDrawableCullCallback() [1/2]

virtual DrawableCullCallback * osg::Callback::asDrawableCullCallback ( )
inlinevirtual

◆ asDrawableCullCallback() [2/2]

virtual const DrawableCullCallback * osg::Callback::asDrawableCullCallback ( ) const
inlinevirtual

◆ asDrawableEventCallback() [1/2]

virtual DrawableEventCallback * osg::Callback::asDrawableEventCallback ( )
inlinevirtual

◆ asDrawableEventCallback() [2/2]

virtual const DrawableEventCallback * osg::Callback::asDrawableEventCallback ( ) const
inlinevirtual

◆ asDrawableUpdateCallback() [1/2]

virtual DrawableUpdateCallback * osg::Callback::asDrawableUpdateCallback ( )
inlinevirtual

Reimplemented in osg::DrawableUpdateCallback.

◆ asDrawableUpdateCallback() [2/2]

virtual const DrawableUpdateCallback * osg::Callback::asDrawableUpdateCallback ( ) const
inlinevirtual

Reimplemented in osg::DrawableUpdateCallback.

◆ asEventHandler() [1/2]

virtual osgGA::EventHandler * osg::Callback::asEventHandler ( )
inlinevirtual

◆ asEventHandler() [2/2]

virtual const osgGA::EventHandler * osg::Callback::asEventHandler ( ) const
inlinevirtual

◆ asNodeCallback() [1/2]

virtual NodeCallback * osg::Callback::asNodeCallback ( )
inlinevirtual

◆ asNodeCallback() [2/2]

virtual const NodeCallback * osg::Callback::asNodeCallback ( ) const
inlinevirtual

◆ asStateAttributeCallback() [1/2]

virtual StateAttributeCallback * osg::Callback::asStateAttributeCallback ( )
inlinevirtual

Reimplemented in osg::StateAttributeCallback.

◆ asStateAttributeCallback() [2/2]

virtual const StateAttributeCallback * osg::Callback::asStateAttributeCallback ( ) const
inlinevirtual

Reimplemented in osg::StateAttributeCallback.

◆ asUniformCallback() [1/2]

virtual UniformCallback * osg::Callback::asUniformCallback ( )
inlinevirtual

Reimplemented in osg::UniformCallback.

◆ asUniformCallback() [2/2]

virtual const UniformCallback * osg::Callback::asUniformCallback ( ) const
inlinevirtual

Reimplemented in osg::UniformCallback.

◆ getNestedCallback() [1/2]

osg::Callback * osg::Callback::getNestedCallback ( )
inline

◆ getNestedCallback() [2/2]

const osg::Callback * osg::Callback::getNestedCallback ( ) const
inline

◆ META_Object()

osg::Callback::META_Object ( osg  ,
Callback   
)

◆ removeNestedCallback()

void osg::Callback::removeNestedCallback ( osg::Callback nc)
inline

◆ run()

virtual bool osg::Callback::run ( osg::Object object,
osg::Object data 
)
inlinevirtual

Invoke the callback, first parameter is the Object that the callback is attached to, the second parameter, the data, is typically the NodeVisitor that is invoking the callback. The run(..) method may be overridden by users directly, or if the user is using one of the old style callbacks such as NodeCallback or Drawable::UpdateCallback then you can just override the appropriate callback method on those callback subclasses. If you are implementing your own callback then one should call traverse() to make sure nested callbacks and visitor traversal() is completed.

Reimplemented in osg::CallbackObject, osg::NodeCallback, osg::StateAttributeCallback, osg::UniformCallback, osg::DrawableUpdateCallback, osg::DrawableEventCallback, osg::DrawableCullCallback, osg::ClusterCullingCallback, osg::StateSet::Callback, osgGA::EventHandler, osgShadow::MinimalDrawBoundsShadowMap::CameraCullCallback, osgViewer::InteractiveImageHandler, and osgVolume::PropertyAdjustmentCallback.

◆ setNestedCallback()

void osg::Callback::setNestedCallback ( osg::Callback cb)
inline

◆ traverse()

bool osg::Callback::traverse ( osg::Object object,
osg::Object data 
)

traverse the nested callbacks or call NodeVisitor::traverse() if the object is Node, and data is NodeVisitor.

Member Data Documentation

◆ _nestedCallback

ref_ptr<Callback> osg::Callback::_nestedCallback
protected

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