openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgGA::EventVisitor Class Reference
Inheritance diagram for osgGA::EventVisitor:
osg::NodeVisitor osg::Object osg::Referenced

Public Member Functions

 EventVisitor ()
 
virtual ~EventVisitor ()
 
 META_NodeVisitor (osgGA, EventVisitor) virtual osgGA
 
virtual const osgGA::EventVisitor * asEventVisitor () const
 
void setActionAdapter (osgGA::GUIActionAdapter *actionAdapter)
 
osgGA::GUIActionAdapter * getActionAdapter ()
 
const osgGA::GUIActionAdapter * getActionAdapter () const
 
void addEvent (Event *event)
 
void removeEvent (Event *event)
 
void setEventHandled (bool handled)
 
bool getEventHandled () const
 
void setEvents (const EventQueue::Events &events)
 
EventQueue::Events & getEvents ()
 
const EventQueue::Events & getEvents () const
 
virtual void reset ()
 
virtual void apply (osg::Node &node)
 
virtual void apply (osg::Drawable &drawable)
 
virtual void apply (osg::Geode &node)
 
virtual void apply (osg::Billboard &node)
 
virtual void apply (osg::LightSource &node)
 
virtual void apply (osg::Group &node)
 
virtual void apply (osg::Transform &node)
 
virtual void apply (osg::Projection &node)
 
virtual void apply (osg::Switch &node)
 
virtual void apply (osg::LOD &node)
 
virtual void apply (osg::OccluderNode &node)
 
- Public Member Functions inherited from osg::NodeVisitor
 NodeVisitor (TraversalMode tm=TRAVERSE_NONE)
 
 NodeVisitor (VisitorType type, TraversalMode tm=TRAVERSE_NONE)
 
 NodeVisitor (const NodeVisitor &nv, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
virtual ~NodeVisitor ()
 
 META_Object (osg, NodeVisitor) virtual NodeVisitor *asNodeVisitor()
 
virtual const NodeVisitor * asNodeVisitor () const
 
virtual osgUtil::UpdateVisitor * asUpdateVisitor ()
 
virtual const osgUtil::UpdateVisitor * asUpdateVisitor () const
 
virtual osgUtil::CullVisitor * asCullVisitor ()
 
virtual const osgUtil::CullVisitor * asCullVisitor () const
 
virtual osgGA::EventVisitor * asEventVisitor ()
 
virtual const osgGA::EventVisitor * asEventVisitor () const
 
virtual osgUtil::IntersectionVisitor * asIntersectionVisitor ()
 
virtual const osgUtil::IntersectionVisitor * asIntersectionVisitor () const
 
virtual osg::CullStack * asCullStack ()
 
virtual const osg::CullStack * asCullStack () const
 
virtual void reset ()
 
void setVisitorType (VisitorType type)
 
VisitorType getVisitorType () const
 
void setTraversalNumber (unsigned int fn)
 
unsigned int getTraversalNumber () const
 
void setFrameStamp (FrameStamp *fs)
 
const FrameStamp * getFrameStamp () const
 
void setTraversalMask (Node::NodeMask mask)
 
Node::NodeMask getTraversalMask () const
 
void setNodeMaskOverride (Node::NodeMask mask)
 
Node::NodeMask getNodeMaskOverride () const
 
bool validNodeMask (const osg::Node &node) const
 
void setTraversalMode (TraversalMode mode)
 
TraversalMode getTraversalMode () const
 
void setValueMap (ValueMap *ps)
 
ValueMap * getValueMap ()
 
const ValueMap * getValueMap () const
 
ValueMap * getOrCreateValueMap ()
 
void setValueStack (ValueStack *ps)
 
ValueStack * getValueStack ()
 
const ValueStack * getValueStack () const
 
ValueStack * getOrCreateValueStack ()
 
void traverse (Node &node)
 
void pushOntoNodePath (Node *node)
 
void popFromNodePath ()
 
NodePath & getNodePath ()
 
const NodePath & getNodePath () const
 
virtual osg::Vec3 getEyePoint () const
 
virtual osg::Vec3 getViewPoint () const
 
virtual float getDistanceToEyePoint (const Vec3 &, bool) const
 
virtual float getDistanceFromEyePoint (const Vec3 &, bool) const
 
virtual float getDistanceToViewPoint (const Vec3 &, bool) const
 
virtual void apply (Drawable &drawable)
 
virtual void apply (Geometry &geometry)
 
virtual void apply (Node &node)
 
virtual void apply (Geode &node)
 
virtual void apply (Billboard &node)
 
virtual void apply (Group &node)
 
virtual void apply (ProxyNode &node)
 
virtual void apply (Projection &node)
 
virtual void apply (CoordinateSystemNode &node)
 
virtual void apply (ClipNode &node)
 
virtual void apply (TexGenNode &node)
 
virtual void apply (LightSource &node)
 
virtual void apply (Transform &node)
 
virtual void apply (Camera &node)
 
virtual void apply (CameraView &node)
 
virtual void apply (MatrixTransform &node)
 
virtual void apply (PositionAttitudeTransform &node)
 
virtual void apply (AutoTransform &node)
 
virtual void apply (Switch &node)
 
virtual void apply (Sequence &node)
 
virtual void apply (LOD &node)
 
virtual void apply (PagedLOD &node)
 
virtual void apply (ClearNode &node)
 
virtual void apply (OccluderNode &node)
 
virtual void apply (OcclusionQueryNode &node)
 
void setDatabaseRequestHandler (DatabaseRequestHandler *handler)
 
DatabaseRequestHandler * getDatabaseRequestHandler ()
 
const DatabaseRequestHandler * getDatabaseRequestHandler () const
 
void setImageRequestHandler (ImageRequestHandler *handler)
 
ImageRequestHandler * getImageRequestHandler ()
 
const ImageRequestHandler * getImageRequestHandler () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual Object * cloneType () const =0
 
virtual Object * clone (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 Node * asNode ()
 
virtual const Node * asNode () const
 
virtual NodeVisitor * asNodeVisitor ()
 
virtual const NodeVisitor * asNodeVisitor () const
 
virtual StateSet * asStateSet ()
 
virtual const StateSet * asStateSet () const
 
virtual StateAttribute * asStateAttribute ()
 
virtual const StateAttribute * asStateAttribute () const
 
virtual Uniform * asUniform ()
 
virtual const Uniform * asUniform () const
 
virtual Camera * asCamera ()
 
virtual const Camera * asCamera () const
 
virtual Drawable * asDrawable ()
 
virtual const Drawable * asDrawable () const
 
virtual Callback * asCallback ()
 
virtual const Callback * asCallback () const
 
virtual CallbackObject * asCallbackObject ()
 
virtual const CallbackObject * asCallbackObject () const
 
virtual UserDataContainer * asUserDataContainer ()
 
virtual const UserDataContainer * asUserDataContainer () const
 
virtual ValueObject * asValueObject ()
 
virtual const ValueObject * asValueObject () const
 
virtual Image * asImage ()
 
virtual const Image * asImage () 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::UserDataContainer * getUserDataContainer ()
 
const osg::UserDataContainer * getUserDataContainer () const
 
osg::UserDataContainer * getOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual Referenced * getUserData ()
 
virtual const Referenced * getUserData () 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 &)
 
Referenced & operator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::Mutex * getRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSet * getObserverSet () const
 
ObserverSet * getOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

EventVisitor & operator= (const EventVisitor &)
 
void handle_callbacks (osg::StateSet *stateset)
 
void handle_callbacks_and_traverse (osg::Node &node)
 
- 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

osgGA::GUIActionAdapter * _actionAdapter
 
osg::ref_ptr< GUIEventAdapter > _accumulateEventState
 
bool _handled
 
EventQueue::Events _events
 
- Protected Attributes inherited from osg::NodeVisitor
VisitorType _visitorType
 
unsigned int _traversalNumber
 
ref_ptr< FrameStamp > _frameStamp
 
TraversalMode _traversalMode
 
Node::NodeMask _traversalMask
 
Node::NodeMask _nodeMaskOverride
 
NodePath _nodePath
 
ref_ptr< DatabaseRequestHandler > _databaseRequestHandler
 
ref_ptr< ImageRequestHandler > _imageRequestHandler
 
osg::ref_ptr< ValueMap > _valueMap
 
osg::ref_ptr< ValueStack > _valueStack
 
- 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::NodeVisitor
enum  TraversalMode { TRAVERSE_NONE , TRAVERSE_PARENTS , TRAVERSE_ALL_CHILDREN , TRAVERSE_ACTIVE_CHILDREN }
 
enum  VisitorType {
  NODE_VISITOR = 0 , UPDATE_VISITOR , EVENT_VISITOR , COLLECT_OCCLUDER_VISITOR ,
  CULL_VISITOR , INTERSECTION_VISITOR
}
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandler * getDeleteHandler ()
 

Detailed Description

Basic EventVisitor implementation for animating a scene. This visitor traverses the scene graph, calling each nodes appCallback if it exists.

Constructor & Destructor Documentation

◆ EventVisitor()

osgGA::EventVisitor::EventVisitor ( )

◆ ~EventVisitor()

virtual osgGA::EventVisitor::~EventVisitor ( )
virtual

Member Function Documentation

◆ addEvent()

void osgGA::EventVisitor::addEvent ( Event *  event)

◆ apply() [1/11]

virtual void osgGA::EventVisitor::apply ( osg::Billboard &  node)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ apply() [2/11]

virtual void osgGA::EventVisitor::apply ( osg::Drawable &  drawable)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ apply() [3/11]

virtual void osgGA::EventVisitor::apply ( osg::Geode &  node)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ apply() [4/11]

virtual void osgGA::EventVisitor::apply ( osg::Group &  node)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ apply() [5/11]

virtual void osgGA::EventVisitor::apply ( osg::LightSource &  node)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ apply() [6/11]

virtual void osgGA::EventVisitor::apply ( osg::LOD &  node)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ apply() [7/11]

virtual void osgGA::EventVisitor::apply ( osg::Node &  node)
inlinevirtual

During traversal each type of node calls its callbacks and its children traversed.

Reimplemented from osg::NodeVisitor.

◆ apply() [8/11]

virtual void osgGA::EventVisitor::apply ( osg::OccluderNode &  node)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ apply() [9/11]

virtual void osgGA::EventVisitor::apply ( osg::Projection &  node)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ apply() [10/11]

virtual void osgGA::EventVisitor::apply ( osg::Switch &  node)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ apply() [11/11]

virtual void osgGA::EventVisitor::apply ( osg::Transform &  node)
inlinevirtual

Reimplemented from osg::NodeVisitor.

◆ asEventVisitor()

virtual const osgGA::EventVisitor * osgGA::EventVisitor::asEventVisitor ( ) const
inlinevirtual

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

Reimplemented from osg::NodeVisitor.

◆ getActionAdapter() [1/2]

osgGA::GUIActionAdapter * osgGA::EventVisitor::getActionAdapter ( )
inline

◆ getActionAdapter() [2/2]

const osgGA::GUIActionAdapter * osgGA::EventVisitor::getActionAdapter ( ) const
inline

◆ getEventHandled()

bool osgGA::EventVisitor::getEventHandled ( ) const
inline

◆ getEvents() [1/2]

EventQueue::Events & osgGA::EventVisitor::getEvents ( )
inline

◆ getEvents() [2/2]

const EventQueue::Events & osgGA::EventVisitor::getEvents ( ) const
inline

◆ handle_callbacks()

void osgGA::EventVisitor::handle_callbacks ( osg::StateSet *  stateset)
inlineprotected

◆ handle_callbacks_and_traverse()

void osgGA::EventVisitor::handle_callbacks_and_traverse ( osg::Node &  node)
inlineprotected

◆ META_NodeVisitor()

osgGA::EventVisitor::META_NodeVisitor ( osgGA  ,
EventVisitor   
)
inline

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

◆ operator=()

EventVisitor & osgGA::EventVisitor::operator= ( const EventVisitor &  )
inlineprotected

Prevent unwanted copy operator.

◆ removeEvent()

void osgGA::EventVisitor::removeEvent ( Event *  event)

◆ reset()

virtual void osgGA::EventVisitor::reset ( )
virtual

Method to call to reset visitor. Useful if your visitor accumulates state during a traversal, and you plan to reuse the visitor. To flush that state for the next traversal: call reset() prior to each traversal.

Reimplemented from osg::NodeVisitor.

◆ setActionAdapter()

void osgGA::EventVisitor::setActionAdapter ( osgGA::GUIActionAdapter *  actionAdapter)
inline

◆ setEventHandled()

void osgGA::EventVisitor::setEventHandled ( bool  handled)
inline

◆ setEvents()

void osgGA::EventVisitor::setEvents ( const EventQueue::Events &  events)
inline

Member Data Documentation

◆ _accumulateEventState

osg::ref_ptr<GUIEventAdapter> osgGA::EventVisitor::_accumulateEventState
protected

◆ _actionAdapter

osgGA::GUIActionAdapter* osgGA::EventVisitor::_actionAdapter
protected

◆ _events

EventQueue::Events osgGA::EventVisitor::_events
protected

◆ _handled

bool osgGA::EventVisitor::_handled
protected

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