OpenWalnut
1.4.0
|
This callback allows you a simple usage of callbacks in your module. More...
#include <WGEFunctorCallback.h>
Public Types | |
typedef osg::ref_ptr < WGEFunctorCallback > | SPtr |
Shared pointer. | |
typedef osg::ref_ptr< const WGEFunctorCallback > | ConstSPtr |
Const shared pointer. | |
typedef boost::function< void(Type *) | FunctorType ) |
The type of functor supported in this callback. | |
Public Member Functions | |
WGEFunctorCallback (FunctorType functor) | |
Default constructor. | |
virtual | ~WGEFunctorCallback () |
Destructor. | |
virtual void | operator() (Type *handled, osg::NodeVisitor *nv) |
This operator gets called by OSG every update cycle. | |
virtual void | update (osg::NodeVisitor *nv, Type *handled) |
This gets called by OSG every update cycle. | |
Private Attributes | |
FunctorType | m_functor |
The functor getting called each callback. |
This callback allows you a simple usage of callbacks in your module.
The callback uses function pointers and calls them every update cycle. This is especially useful if you want to use a callback in a module without the need of writing subclasses providing a shared_ptr to the parent module.
Type | the callback type. You can specify every class that has a nested class called "Callback". |
Definition at line 44 of file WGEFunctorCallback.h.
typedef osg::ref_ptr< const WGEFunctorCallback > WGEFunctorCallback< Type >::ConstSPtr |
Const shared pointer.
Definition at line 55 of file WGEFunctorCallback.h.
typedef boost::function< void ( Type* ) WGEFunctorCallback< Type >::FunctorType) |
The type of functor supported in this callback.
Definition at line 60 of file WGEFunctorCallback.h.
typedef osg::ref_ptr< WGEFunctorCallback > WGEFunctorCallback< Type >::SPtr |
Shared pointer.
Definition at line 50 of file WGEFunctorCallback.h.
WGEFunctorCallback< Type >::WGEFunctorCallback | ( | FunctorType | functor | ) | [explicit] |
Default constructor.
Creates the callback and sets the specified functor instance.
functor | the function pointer. |
Definition at line 100 of file WGEFunctorCallback.h.
WGEFunctorCallback< Type >::~WGEFunctorCallback | ( | ) | [virtual] |
Destructor.
Definition at line 108 of file WGEFunctorCallback.h.
void WGEFunctorCallback< Type >::operator() | ( | Type * | handled, |
osg::NodeVisitor * | nv | ||
) | [virtual] |
This operator gets called by OSG every update cycle.
It calls the specified functor.
handled | the osg node, stateset or whatever |
nv | the node visitor |
Definition at line 114 of file WGEFunctorCallback.h.
References WGECallbackTraits< Type >::traverse().
void WGEFunctorCallback< Type >::update | ( | osg::NodeVisitor * | nv, |
Type * | handled | ||
) | [virtual] |
This gets called by OSG every update cycle.
It calls the specified functor.
handled | the osg node, stateset or whatever |
nv | the node visitor |
Definition at line 122 of file WGEFunctorCallback.h.
FunctorType WGEFunctorCallback< Type >::m_functor [private] |
The functor getting called each callback.
Definition at line 96 of file WGEFunctorCallback.h.