openscenegraph
osgUtil::GLObjectsVisitor Class Reference

#include <GLObjectsVisitor>

Inheritance diagram for osgUtil::GLObjectsVisitor:
osg::NodeVisitor osg::Object osg::Referenced

Public Types

enum  ModeValues {
  SWITCH_ON_DISPLAY_LISTS = 0x1 , SWITCH_OFF_DISPLAY_LISTS = 0x2 , COMPILE_DISPLAY_LISTS = 0x4 , COMPILE_STATE_ATTRIBUTES = 0x8 ,
  RELEASE_DISPLAY_LISTS = 0x10 , RELEASE_STATE_ATTRIBUTES = 0x20 , SWITCH_ON_VERTEX_BUFFER_OBJECTS = 0x40 , SWITCH_OFF_VERTEX_BUFFER_OBJECTS = 0x80 ,
  CHECK_BLACK_LISTED_MODES = 0x100
}
typedef unsigned int Mode
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 }

Public Member Functions

 GLObjectsVisitor (Mode mode=COMPILE_DISPLAY_LISTS|COMPILE_STATE_ATTRIBUTES|CHECK_BLACK_LISTED_MODES)
 META_NodeVisitor (osgUtil, GLObjectsVisitor) virtual void reset()
void setMode (Mode mode)
Mode getMode () const
void setState (osg::State *state)
osg::StategetState ()
void setRenderInfo (osg::RenderInfo &renderInfo)
osg::RenderInfogetRenderInfo ()
void setCheckForGLErrors (osg::State::CheckForGLErrors check)
osg::State::CheckForGLErrors getCheckForGLErrors () const
virtual void apply (osg::Node &node)
void apply (osg::Drawable &drawable)
void apply (osg::StateSet &stateset)
void compile (osg::Node &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 NodeVisitorasNodeVisitor () const
virtual osgUtil::UpdateVisitorasUpdateVisitor ()
virtual const osgUtil::UpdateVisitorasUpdateVisitor () const
virtual osgUtil::CullVisitorasCullVisitor ()
virtual const osgUtil::CullVisitorasCullVisitor () const
virtual osgGA::EventVisitorasEventVisitor ()
virtual const osgGA::EventVisitorasEventVisitor () const
virtual osgUtil::IntersectionVisitorasIntersectionVisitor ()
virtual const osgUtil::IntersectionVisitorasIntersectionVisitor () const
virtual osg::CullStackasCullStack ()
virtual const osg::CullStackasCullStack () 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 FrameStampgetFrameStamp () 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)
ValueMapgetValueMap ()
const ValueMapgetValueMap () const
ValueMapgetOrCreateValueMap ()
void setValueStack (ValueStack *ps)
ValueStackgetValueStack ()
const ValueStackgetValueStack () const
ValueStackgetOrCreateValueStack ()
void traverse (Node &node)
void pushOntoNodePath (Node *node)
void popFromNodePath ()
NodePathgetNodePath ()
const NodePathgetNodePath () 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 (Geometry &geometry)
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)
DatabaseRequestHandlergetDatabaseRequestHandler ()
const DatabaseRequestHandlergetDatabaseRequestHandler () const
void setImageRequestHandler (ImageRequestHandler *handler)
ImageRequestHandlergetImageRequestHandler ()
const ImageRequestHandlergetImageRequestHandler () const
Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const =0
virtual Objectclone (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 NodeasNode ()
virtual const NodeasNode () const
virtual NodeVisitorasNodeVisitor ()
virtual StateSetasStateSet ()
virtual const StateSetasStateSet () const
virtual StateAttributeasStateAttribute ()
virtual const StateAttributeasStateAttribute () const
virtual UniformasUniform ()
virtual const UniformasUniform () const
virtual CameraasCamera ()
virtual const CameraasCamera () const
virtual DrawableasDrawable ()
virtual const DrawableasDrawable () const
virtual CallbackasCallback ()
virtual const CallbackasCallback () const
virtual CallbackObjectasCallbackObject ()
virtual const CallbackObjectasCallbackObject () const
virtual UserDataContainerasUserDataContainer ()
virtual const UserDataContainerasUserDataContainer () const
virtual ValueObjectasValueObject ()
virtual const ValueObjectasValueObject () const
virtual ImageasImage ()
virtual const ImageasImage () 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::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
template<class T>
void setUserData (const ref_ptr< T > &ud)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () 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 &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Protected Types

typedef std::set< osg::Drawable * > DrawableAppliedSet
typedef std::set< osg::StateSet * > StatesSetAppliedSet

Protected Attributes

Mode _mode
osg::RenderInfo _renderInfo
osg::State::CheckForGLErrors _checkGLErrors
DrawableAppliedSet _drawablesAppliedSet
StatesSetAppliedSet _stateSetAppliedSet
osg::ref_ptr< osg::Program_lastCompiledProgram
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

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
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

Detailed Description

Visitor for traversing scene graph and setting each osg::Drawable's _useDisplayList flag, with option to immediately compile osg::Drawable OpenGL Display lists and osg::StateAttribute's.

Member Typedef Documentation

◆ DrawableAppliedSet

◆ Mode

typedef unsigned int osgUtil::GLObjectsVisitor::Mode

◆ StatesSetAppliedSet

Member Enumeration Documentation

◆ ModeValues

Operation modes of the.

Enumerator
SWITCH_ON_DISPLAY_LISTS 
SWITCH_OFF_DISPLAY_LISTS 
COMPILE_DISPLAY_LISTS 
COMPILE_STATE_ATTRIBUTES 
RELEASE_DISPLAY_LISTS 
RELEASE_STATE_ATTRIBUTES 
SWITCH_ON_VERTEX_BUFFER_OBJECTS 
SWITCH_OFF_VERTEX_BUFFER_OBJECTS 
CHECK_BLACK_LISTED_MODES 

Constructor & Destructor Documentation

◆ GLObjectsVisitor()

osgUtil::GLObjectsVisitor::GLObjectsVisitor ( Mode mode = COMPILE_DISPLAY_LISTS|COMPILE_STATE_ATTRIBUTES|CHECK_BLACK_LISTED_MODES)

Construct a GLObjectsVisitor to traverse all children, operating on node according to specified mode, such as to compile or release display list/texture objects etc. Default mode is to compile GL objects.

References CHECK_BLACK_LISTED_MODES, COMPILE_DISPLAY_LISTS, and COMPILE_STATE_ATTRIBUTES.

Referenced by META_NodeVisitor().

Member Function Documentation

◆ apply() [1/3]

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

Reimplemented from osg::NodeVisitor.

◆ apply() [2/3]

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

Simply traverse using standard NodeVisitor traverse method.

Reimplemented from osg::NodeVisitor.

◆ apply() [3/3]

void osgUtil::GLObjectsVisitor::apply ( osg::StateSet & stateset)

◆ compile()

void osgUtil::GLObjectsVisitor::compile ( osg::Node & node)

Do a compile traversal and then reset any state,

◆ getCheckForGLErrors()

osg::State::CheckForGLErrors osgUtil::GLObjectsVisitor::getCheckForGLErrors ( ) const
inline

Get whether and how often OpenGL errors should be checked for.

References _checkGLErrors.

◆ getMode()

Mode osgUtil::GLObjectsVisitor::getMode ( ) const
inline

Get the operational mode.

References _mode.

◆ getRenderInfo()

osg::RenderInfo & osgUtil::GLObjectsVisitor::getRenderInfo ( )
inline

References _renderInfo.

◆ getState()

osg::State * osgUtil::GLObjectsVisitor::getState ( )
inline

References _renderInfo.

◆ META_NodeVisitor()

osgUtil::GLObjectsVisitor::META_NodeVisitor ( osgUtil ,
GLObjectsVisitor  )
inline

◆ setCheckForGLErrors()

void osgUtil::GLObjectsVisitor::setCheckForGLErrors ( osg::State::CheckForGLErrors check)
inline

Set whether and how often OpenGL errors should be checked for, defaults to osg::State::ONCE_PER_ATTRIBUTE.

References _checkGLErrors.

◆ setMode()

void osgUtil::GLObjectsVisitor::setMode ( Mode mode)
inline

Set the operational mode of what operations to do on the scene graph.

References _mode.

◆ setRenderInfo()

void osgUtil::GLObjectsVisitor::setRenderInfo ( osg::RenderInfo & renderInfo)
inline

References _renderInfo.

◆ setState()

void osgUtil::GLObjectsVisitor::setState ( osg::State * state)
inline

Set the State to use during traversal.

References _renderInfo.

Member Data Documentation

◆ _checkGLErrors

osg::State::CheckForGLErrors osgUtil::GLObjectsVisitor::_checkGLErrors
protected

◆ _drawablesAppliedSet

DrawableAppliedSet osgUtil::GLObjectsVisitor::_drawablesAppliedSet
protected

Referenced by META_NodeVisitor().

◆ _lastCompiledProgram

osg::ref_ptr<osg::Program> osgUtil::GLObjectsVisitor::_lastCompiledProgram
protected

◆ _mode

Mode osgUtil::GLObjectsVisitor::_mode
protected

Referenced by getMode(), and setMode().

◆ _renderInfo

osg::RenderInfo osgUtil::GLObjectsVisitor::_renderInfo
protected

◆ _stateSetAppliedSet

StatesSetAppliedSet osgUtil::GLObjectsVisitor::_stateSetAppliedSet
protected

Referenced by META_NodeVisitor().


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