OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
osgGA::EventVisitor Class Reference

Basic EventVisitor implementation for animating a scene. More...

Inheritance diagram for osgGA::EventVisitor:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::list
< osg::ref_ptr
< GUIEventAdapter > > 
EventList
- 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
}

Public Member Functions

 EventVisitor ()
virtual ~EventVisitor ()
 META_NodeVisitor ("osgGA","EventVisitor") void setActionAdapter(osgGA
osgGA::GUIActionAdaptergetActionAdapter ()
const osgGA::GUIActionAdaptergetActionAdapter () const
void addEvent (GUIEventAdapter *event)
void removeEvent (GUIEventAdapter *event)
void setEventHandled (bool handled)
bool getEventHandled () const
void setEvents (const EventQueue::Events &events)
EventQueue::EventsgetEvents ()
const EventQueue::EventsgetEvents () const
virtual void reset ()
 Method to call to reset visitor.
virtual void apply (osg::Node &node)
 During traversal each type of node calls its callbacks and its children traversed.
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)
virtual ~NodeVisitor ()
virtual const char * libraryName () const
 return the library name/namespapce of the visitor's.
virtual const char * className () const
 return the name of the visitor's class type.
void setVisitorType (VisitorType type)
 Set the VisitorType, used to distinguish different visitors during traversal of the scene, typically used in the Node::traverse() method to select which behaviour to use for different types of traversal/visitors.
VisitorType getVisitorType () const
 Get the VisitorType.
void setTraversalNumber (unsigned int fn)
 Set the traversal number.
unsigned int getTraversalNumber () const
 Get the traversal number.
void setFrameStamp (FrameStamp *fs)
 Set the FrameStamp that this traversal is associated with.
const FrameStampgetFrameStamp () const
 Get the FrameStamp that this traversal is associated with.
void setTraversalMask (Node::NodeMask mask)
 Set the TraversalMask of this NodeVisitor.
Node::NodeMask getTraversalMask () const
 Get the TraversalMask.
void setNodeMaskOverride (Node::NodeMask mask)
 Set the NodeMaskOverride mask.
Node::NodeMask getNodeMaskOverride () const
 Get the NodeMaskOverride mask.
bool validNodeMask (const osg::Node &node) const
 Method to called by Node and its subclass' Node::accept() method, if the result is true it is used to cull operations of nodes and their subgraphs.
void setTraversalMode (TraversalMode mode)
 Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse.
TraversalMode getTraversalMode () const
 Get the traversal mode.
void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
ReferencedgetUserData ()
 Get user data.
const ReferencedgetUserData () const
 Get const user data.
void traverse (Node &node)
 Method for handling traversal of a nodes.
void pushOntoNodePath (Node *node)
 Method called by osg::Node::accept() method before a call to the NodeVisitor::apply(..).
void popFromNodePath ()
 Method called by osg::Node::accept() method after a call to NodeVisitor::apply(..).
NodePathgetNodePath ()
 Get the non const NodePath from the top most node applied down to the current Node being visited.
const NodePathgetNodePath () const
 Get the const NodePath from the top most node applied down to the current Node being visited.
virtual osg::Vec3 getEyePoint () const
 Get the eye point in local coordinates.
virtual osg::Vec3 getViewPoint () const
 Get the view point in local coordinates.
virtual float getDistanceToEyePoint (const Vec3 &, bool) const
 Get the distance from a point to the eye point, distance value in local coordinate system.
virtual float getDistanceFromEyePoint (const Vec3 &, bool) const
 Get the distance of a point from the eye point, distance value in the eye coordinate system.
virtual float getDistanceToViewPoint (const Vec3 &, bool) const
 Get the distance from a point to the view point, distance value in local coordinate system.
virtual void apply (ProxyNode &node)
virtual void apply (CoordinateSystemNode &node)
virtual void apply (ClipNode &node)
virtual void apply (TexGenNode &node)
virtual void apply (Camera &node)
virtual void apply (CameraView &node)
virtual void apply (MatrixTransform &node)
virtual void apply (PositionAttitudeTransform &node)
virtual void apply (Sequence &node)
virtual void apply (PagedLOD &node)
virtual void apply (ClearNode &node)
virtual void apply (OcclusionQueryNode &node)
void setDatabaseRequestHandler (DatabaseRequestHandler *handler)
 Set the handler for database requests.
DatabaseRequestHandlergetDatabaseRequestHandler ()
 Get the handler for database requests.
const DatabaseRequestHandlergetDatabaseRequestHandler () const
 Get the const handler for database requests.
void setImageRequestHandler (ImageRequestHandler *handler)
 Set the handler for image requests.
ImageRequestHandlergetImageRequestHandler ()
 Get the handler for image requests.
const ImageRequestHandlergetImageRequestHandler () const
 Get the const handler for image requests.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
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 referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () 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.

Protected Member Functions

EventVisitoroperator= (const EventVisitor &)
 Prevent unwanted copy operator.
void handle_callbacks (osg::StateSet *stateset)
void handle_callbacks_and_traverse (osg::Node &node)
void handle_geode_callbacks (osg::Geode &node)
void traverseGeode (osg::Geode &geode)

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< Referenced_userData
ref_ptr< DatabaseRequestHandler_databaseRequestHandler
ref_ptr< ImageRequestHandler_imageRequestHandler
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Detailed Description

Basic EventVisitor implementation for animating a scene.

This visitor traverses the scene graph, calling each nodes appCallback if it exists.


Member Typedef Documentation


Constructor & Destructor Documentation

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

Member Function Documentation

void osgGA::EventVisitor::addEvent ( GUIEventAdapter event)
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.

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

Reimplemented from osg::NodeVisitor.

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

Reimplemented from osg::NodeVisitor.

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

Reimplemented from osg::NodeVisitor.

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

Reimplemented from osg::NodeVisitor.

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

Reimplemented from osg::NodeVisitor.

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

Reimplemented from osg::NodeVisitor.

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

Reimplemented from osg::NodeVisitor.

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

Reimplemented from osg::NodeVisitor.

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

Reimplemented from osg::NodeVisitor.

osgGA::GUIActionAdapter* osgGA::EventVisitor::getActionAdapter ( )
inline
const osgGA::GUIActionAdapter* osgGA::EventVisitor::getActionAdapter ( ) const
inline
bool osgGA::EventVisitor::getEventHandled ( ) const
inline
EventQueue::Events& osgGA::EventVisitor::getEvents ( )
inline
const EventQueue::Events& osgGA::EventVisitor::getEvents ( ) const
inline
void osgGA::EventVisitor::handle_callbacks ( osg::StateSet stateset)
inlineprotected
void osgGA::EventVisitor::handle_callbacks_and_traverse ( osg::Node node)
inlineprotected
void osgGA::EventVisitor::handle_geode_callbacks ( osg::Geode node)
inlineprotected
osgGA::EventVisitor::META_NodeVisitor ( "osgGA"  ,
"EventVisitor"   
)
inline
EventVisitor& osgGA::EventVisitor::operator= ( const EventVisitor )
inlineprotected

Prevent unwanted copy operator.

void osgGA::EventVisitor::removeEvent ( GUIEventAdapter event)
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.

void osgGA::EventVisitor::setEventHandled ( bool  handled)
inline
void osgGA::EventVisitor::setEvents ( const EventQueue::Events events)
inline
void osgGA::EventVisitor::traverseGeode ( osg::Geode geode)
inlineprotected

Member Data Documentation

osg::ref_ptr<GUIEventAdapter> osgGA::EventVisitor::_accumulateEventState
protected
osgGA::GUIActionAdapter* osgGA::EventVisitor::_actionAdapter
protected
EventQueue::Events osgGA::EventVisitor::_events
protected
bool osgGA::EventVisitor::_handled
protected

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

osg logo
Generated at Thu Oct 4 2012 13:45:13 for the OpenSceneGraph by doxygen 1.8.1.1.