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

#include <UpdateVisitor>

Inheritance diagram for osgUtil::UpdateVisitor:

[legend]

Public Member Functions
	UpdateVisitor ()
virtual	~UpdateVisitor ()
	META_NodeVisitor (osgUtil, UpdateVisitor) virtual osgUtil
	Convert 'this' into a osgUtil::UpdateVisitor pointer if Object is a osgUtil::UpdateVisitor, otherwise return 0.
virtual const osgUtil::UpdateVisitor *	asUpdateVisitor () const
	convert 'const this' into a const osgUtil::UpdateVisitor pointer if Object is a osgUtil::UpdateVisitor, otherwise return 0.
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::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()
	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 osgUtil::UpdateVisitor *	asUpdateVisitor ()
	Convert 'this' into a osgUtil::UpdateVisitor pointer if Object is a osgUtil::UpdateVisitor, otherwise return 0.
virtual osgUtil::CullVisitor *	asCullVisitor ()
	Convert 'this' into a osgUtil::CullVisitor pointer if Object is a osgUtil::CullVisitor, otherwise return 0.
virtual const osgUtil::CullVisitor *	asCullVisitor () const
	convert 'const this' into a const osgUtil::CullVisitor pointer if Object is a osgUtil::CullVisitor, otherwise return 0.
virtual osgGA::EventVisitor *	asEventVisitor ()
	Convert 'this' into a osgGA::EventVisitor pointer if Object is a osgGA::EventVisitor, otherwise return 0.
virtual const osgGA::EventVisitor *	asEventVisitor () const
	convert 'const this' into a const osgGA::EventVisitor pointer if Object is a osgGA::EventVisitor, otherwise return 0.
virtual osgUtil::IntersectionVisitor *	asIntersectionVisitor ()
	Convert 'this' into a osgUtil::IntersectionVisitor pointer if Object is a IntersectionVisitor, otherwise return 0.
virtual const osgUtil::IntersectionVisitor *	asIntersectionVisitor () const
	convert 'const this' into a const osgUtil::IntersectionVisitor pointer if Object is a IntersectionVisitor, otherwise return 0.
virtual osg::CullStack *	asCullStack ()
	Convert 'this' into a osg::CullStack pointer if Object is a osg::CullStack, otherwise return 0.
virtual const osg::CullStack *	asCullStack () const
	convert 'const this' into a const osg::CullStack pointer if Object is a osg::CullStack, otherwise return 0.
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 FrameStamp *	getFrameStamp () 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	setValueMap (ValueMap *ps)
	Set the ValueMap used to store Values that can be reused over a series of traversals.
ValueMap *	getValueMap ()
	Get the ValueMap.
const ValueMap *	getValueMap () const
	Get the ValueMap.
ValueMap *	getOrCreateValueMap ()
	Get the ValueMap.
void	setValueStack (ValueStack *ps)
	Set the ValueStack used to stack Values during traversal.
ValueStack *	getValueStack ()
	Get the ValueStack.
const ValueStack *	getValueStack () const
	Get the const ValueStack.
ValueStack *	getOrCreateValueStack ()
	Get the ValueStack.
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(..).
NodePath &	getNodePath ()
	Get the non const NodePath from the top most node applied down to the current Node being visited.
const NodePath &	getNodePath () 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 (Geometry &geometry)
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 (AutoTransform &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.
DatabaseRequestHandler *	getDatabaseRequestHandler ()
	Get the handler for database requests.
const DatabaseRequestHandler *	getDatabaseRequestHandler () const
	Get the const handler for database requests.
void	setImageRequestHandler (ImageRequestHandler *handler)
	Set the handler for image requests.
ImageRequestHandler *	getImageRequestHandler ()
	Get the handler for image requests.
const ImageRequestHandler *	getImageRequestHandler () const
	Get the const handler for image requests.
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 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 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 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.
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.

Protected Member Functions
UpdateVisitor &	operator= (const UpdateVisitor &)
	Prevent unwanted copy construction.
void	handle_callbacks (osg::StateSet *stateset)
void	handle_callbacks_and_traverse (osg::Node &node)
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

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 ()
	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 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

Detailed Description

Basic UpdateVisitor implementation for animating a scene.

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

Constructor & Destructor Documentation

◆ UpdateVisitor()

osgUtil::UpdateVisitor::UpdateVisitor ( )

Referenced by META_NodeVisitor(), and operator=().

◆ ~UpdateVisitor()

virtual osgUtil::UpdateVisitor::~UpdateVisitor ( )

virtual

Member Function Documentation

◆ apply() [1/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::Billboard & node )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ apply() [2/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::Drawable & drawable )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References osg::Callback::asDrawableUpdateCallback(), osg::Callback::asNodeCallback(), osg::Node::getStateSet(), osg::Node::getUpdateCallback(), handle_callbacks(), osg::Callback::run(), and osg::DrawableUpdateCallback::update().

◆ apply() [3/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::Geode & node )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ apply() [4/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::Group & node )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ apply() [5/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::LightSource & node )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ apply() [6/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::LOD & node )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ apply() [7/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::Node & node )

inlinevirtual

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

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ apply() [8/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::OccluderNode & node )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ apply() [9/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::Projection & node )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ apply() [10/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::Switch & node )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ apply() [11/11]

virtual void osgUtil::UpdateVisitor::apply ( osg::Transform & node )

inlinevirtual

Reimplemented from osg::NodeVisitor.

References handle_callbacks_and_traverse().

◆ asUpdateVisitor()

virtual const osgUtil::UpdateVisitor * osgUtil::UpdateVisitor::asUpdateVisitor ( ) const

inlinevirtual

convert 'const this' into a const osgUtil::UpdateVisitor pointer if Object is a osgUtil::UpdateVisitor, otherwise return 0.

Equivalent to dynamic_cast<const osgUtil::UpdateVisitor*>(this).

Reimplemented from osg::NodeVisitor.

Referenced by META_NodeVisitor().

◆ handle_callbacks()

void osgUtil::UpdateVisitor::handle_callbacks ( osg::StateSet * stateset )

inlineprotected

References osg::StateSet::requiresUpdateTraversal(), and osg::StateSet::runUpdateCallbacks().

Referenced by apply(), and handle_callbacks_and_traverse().

◆ handle_callbacks_and_traverse()

void osgUtil::UpdateVisitor::handle_callbacks_and_traverse ( osg::Node & node )

inlineprotected

References osg::Node::getNumChildrenRequiringUpdateTraversal(), osg::Node::getStateSet(), osg::Node::getUpdateCallback(), handle_callbacks(), osg::Callback::run(), and osg::NodeVisitor::traverse().

Referenced by apply(), apply(), apply(), apply(), apply(), apply(), apply(), apply(), apply(), and apply().

◆ META_NodeVisitor()

osgUtil::UpdateVisitor::META_NodeVisitor	(	osgUtil	,
		UpdateVisitor	)

inline

Convert 'this' into a osgUtil::UpdateVisitor pointer if Object is a osgUtil::UpdateVisitor, otherwise return 0.

Equivalent to dynamic_cast<osgUtil::UpdateVisitor*>(this).

References asUpdateVisitor(), and UpdateVisitor().

◆ operator=()

UpdateVisitor & osgUtil::UpdateVisitor::operator= ( const UpdateVisitor & )

inlineprotected

Prevent unwanted copy construction.

Prevent unwanted copy operator.

References UpdateVisitor().

◆ reset()

virtual void osgUtil::UpdateVisitor::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.

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

osgUtil/UpdateVisitor

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UpdateVisitor()

◆ ~UpdateVisitor()

Member Function Documentation

◆ apply() [1/11]

◆ apply() [2/11]

◆ apply() [3/11]

◆ apply() [4/11]

◆ apply() [5/11]

◆ apply() [6/11]

◆ apply() [7/11]

◆ apply() [8/11]

◆ apply() [9/11]

◆ apply() [10/11]

◆ apply() [11/11]

◆ asUpdateVisitor()

◆ handle_callbacks()

◆ handle_callbacks_and_traverse()

◆ META_NodeVisitor()

◆ operator=()

◆ reset()