osg::CallbackObject Class Reference

Callback for attaching a script to a Node's via there UserDataContainer for the purpose of overriding class methods within scripts. More...

#include <Callback>

Inheritance diagram for osg::CallbackObject:

Public Member Functions
	CallbackObject ()
	CallbackObject (const std::string &name)
	CallbackObject (const CallbackObject &co, const osg::CopyOp copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osg, CallbackObject)
virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
bool	run (osg::Object *object, osg::Object *data)
	override Callback::run() entry point to adapt to CallbackObject::run(..) method.
bool	run (osg::Object *object) const
virtual bool	run (osg::Object *object, osg::Parameters &inputParameters, osg::Parameters &outputParameters) const
Public Member Functions inherited from osg::Callback
	Callback ()
	Callback (const Callback &cb, const CopyOp &copyop)
	META_Object (osg, Callback)
virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual NodeCallback *	asNodeCallback ()
virtual const NodeCallback *	asNodeCallback () const
virtual StateAttributeCallback *	asStateAttributeCallback ()
virtual const StateAttributeCallback *	asStateAttributeCallback () const
virtual UniformCallback *	asUniformCallback ()
virtual const UniformCallback *	asUniformCallback () const
virtual DrawableUpdateCallback *	asDrawableUpdateCallback ()
virtual const DrawableUpdateCallback *	asDrawableUpdateCallback () const
virtual DrawableEventCallback *	asDrawableEventCallback ()
virtual const DrawableEventCallback *	asDrawableEventCallback () const
virtual DrawableCullCallback *	asDrawableCullCallback ()
virtual const DrawableCullCallback *	asDrawableCullCallback () const
virtual osgGA::EventHandler *	asEventHandler ()
virtual const osgGA::EventHandler *	asEventHandler () const
bool	traverse (osg::Object *object, osg::Object *data)
	traverse the nested callbacks or call NodeVisitor::traverse() if the object is Node, and data is NodeVisitor.
void	setNestedCallback (osg::Callback *cb)
osg::Callback *	getNestedCallback ()
const osg::Callback *	getNestedCallback () const
void	addNestedCallback (osg::Callback *nc)
void	removeNestedCallback (osg::Callback *nc)
Public Member Functions inherited from osg::Object
	Object ()
	Construct an object.
	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.
virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type.
virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type.
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
	return the name of the object's library.
virtual const char *	className () const =0
	return the name of the object's class type.
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name.
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const Image *	asImage () const
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string.
void	setName (const char *name)
	Set the name of object using a C style string.
const std::string &	getName () const
	Get the name of object.
void	setDataVariance (DataVariance dv)
	Set the data variance of this object.
DataVariance	getDataVariance () const
	Get the data variance of this object.
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc.
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object.
template<class T>
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object.
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object.
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.
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling.
template<class T>
void	setUserData (const ref_ptr< T > &ud)
virtual Referenced *	getUserData ()
	Get user data.
virtual const Referenced *	getUserData () const
	Get const user data.
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.
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.
virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size.
virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
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
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.
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref().
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int	referenceCount () const
	Return the number of pointers currently referencing this object.
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object.

Additional Inherited Members
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.
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler.
Protected Member Functions inherited from osg::Callback
virtual	~Callback ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor.
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const
Protected Attributes inherited from osg::Callback
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

Detailed Description

Callback for attaching a script to a Node's via there UserDataContainer for the purpose of overriding class methods within scripts.

Constructor & Destructor Documentation

CallbackObject() [1/3]

osg::CallbackObject::CallbackObject ( )

inline

Referenced by asCallbackObject(), asCallbackObject(), CallbackObject(), and META_Object().

CallbackObject() [2/3]

osg::CallbackObject::CallbackObject ( const std::string & name )

inline

References osg::Object::setName().

CallbackObject() [3/3]

osg::CallbackObject::CallbackObject ( const CallbackObject & co, const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY )

inline

References osg::Callback::Callback(), CallbackObject(), and osg::CopyOp::SHALLOW_COPY.

Member Function Documentation

asCallbackObject() [1/2]

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

inlinevirtual

Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.

Equivalent to dynamic_cast<CallbackObject*>(this).

Reimplemented from osg::Callback.

References CallbackObject().

asCallbackObject() [2/2]

virtual const CallbackObject * osg::CallbackObject::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::Callback.

References CallbackObject().

META_Object()

osg::CallbackObject::META_Object	(	osg	,
		CallbackObject	)

References CallbackObject().

run() [1/3]

bool osg::CallbackObject::run ( osg::Object * object ) const

inline

References run().

run() [2/3]

bool osg::CallbackObject::run ( osg::Object * object, osg::Object * data )

virtual

override Callback::run() entry point to adapt to CallbackObject::run(..) method.

Reimplemented from osg::Callback.

Referenced by osgGA::EventVisitor::apply(), run(), and osg::runNamedCallbackObjects().

run() [3/3]

virtual bool osg::CallbackObject::run ( osg::Object * object, osg::Parameters & inputParameters, osg::Parameters & outputParameters ) const

virtual

Reimplemented in osgUI::CloseCallback, and osgUI::HandleCallback.

---

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

• osg/Callback