OpenSceneGraph  3.0.1
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::OcclusionQueryNode Class Reference
Inheritance diagram for osg::OcclusionQueryNode:
Inheritance graph
[legend]

Public Member Functions

 OcclusionQueryNode ()
 OcclusionQueryNode (const OcclusionQueryNode &oqn, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Node (osg, OcclusionQueryNode)
virtual osg::BoundingSphere computeBound () const
 Compute the bounding sphere around Node's geometry or children.
virtual void releaseGLObjects (osg::State *state=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
void setQueriesEnabled (bool enable=true)
bool getQueriesEnabled () const
void setVisibilityThreshold (unsigned int pixels)
unsigned int getVisibilityThreshold () const
void setQueryFrameCount (unsigned int frames)
unsigned int getQueryFrameCount () const
void setDebugDisplay (bool enable)
bool getDebugDisplay () const
void setQueryStateSet (osg::StateSet *ss)
osg::StateSetgetQueryStateSet ()
const osg::StateSetgetQueryStateSet () const
void setDebugStateSet (osg::StateSet *ss)
osg::StateSetgetDebugStateSet ()
const osg::StateSetgetDebugStateSet () const
bool getPassed () const
virtual bool getPassed (const osg::Camera *camera, osg::NodeVisitor &nv)
void traverseQuery (const osg::Camera *camera, osg::NodeVisitor &nv)
void traverseDebug (osg::NodeVisitor &nv)
- Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Node (osg, Group)
virtual GroupasGroup ()
 convert 'this' into a Group pointer if Node is a Group, otherwise return 0.
virtual const GroupasGroup () const
 convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.
virtual void traverse (NodeVisitor &nv)
 Traverse downwards : calls children's accept method with NodeVisitor.
virtual bool addChild (Node *child)
 Add Node to Group.
virtual bool insertChild (unsigned int index, Node *child)
 Insert Node to Group at specific location.
bool removeChild (Node *child)
 Remove Node from Group.
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
 Remove Node from Group.
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
 Remove children from Group.
virtual bool replaceChild (Node *origChild, Node *newChild)
 Replace specified Node with another Node.
unsigned int getNumChildren () const
 Return the number of children nodes.
virtual bool setChild (unsigned int i, Node *node)
 Set child node at position i.
NodegetChild (unsigned int i)
 Return child node at position i.
const NodegetChild (unsigned int i) const
 Return child node at position i.
bool containsNode (const Node *node) const
 Return true if node is contained within Group.
unsigned int getChildIndex (const Node *node) const
 Get the index number of child, return a value between 0 and _children.size()-1 if found, if not found then return _children.size().
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
- Public Member Functions inherited from osg::Node
 Node ()
 Construct a node.
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual ObjectcloneType () const
 clone an object of the same type as the node.
virtual Objectclone (const CopyOp &copyop) const
 return a clone of a node, with Object* return type.
virtual bool isSameKindAs (const Object *obj) const
 return true if this and obj are of the same kind of object.
virtual const char * libraryName () const
 return the name of the node's library.
virtual const char * className () const
 return the name of the node's class type.
virtual TransformasTransform ()
 Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.
virtual const TransformasTransform () const
 convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.
virtual SwitchasSwitch ()
 Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0.
virtual const SwitchasSwitch () const
 convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0.
virtual GeodeasGeode ()
 Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.
virtual const GeodeasGeode () const
 convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.
virtual osgTerrain::TerrainasTerrain ()
 Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0.
virtual const osgTerrain::TerrainasTerrain () const
 convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0.
virtual void accept (NodeVisitor &nv)
 Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
virtual void ascend (NodeVisitor &nv)
 Traverse upwards : calls parents' accept method with NodeVisitor.
const ParentListgetParents () const
 Get the parent list of node.
ParentList getParents ()
 Get the a copy of parent list of node.
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
 Get a single const parent of node.
unsigned int getNumParents () const
 Get the number of parents of node.
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 Get the list of node paths parent paths.
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates.
void setUpdateCallback (NodeCallback *nc)
 Set update node callback, called during update traversal.
NodeCallbackgetUpdateCallback ()
 Get update node callback, called during update traversal.
const NodeCallbackgetUpdateCallback () const
 Get const update node callback, called during update traversal.
void addUpdateCallback (NodeCallback *nc)
 Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one.
void removeUpdateCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
unsigned int getNumChildrenRequiringUpdateTraversal () const
 Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children.
void setEventCallback (NodeCallback *nc)
 Set event node callback, called during event traversal.
NodeCallbackgetEventCallback ()
 Get event node callback, called during event traversal.
const NodeCallbackgetEventCallback () const
 Get const event node callback, called during event traversal.
void addEventCallback (NodeCallback *nc)
 Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one.
void removeEventCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
unsigned int getNumChildrenRequiringEventTraversal () const
 Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children.
void setCullCallback (NodeCallback *nc)
 Set cull node callback, called during cull traversal.
NodeCallbackgetCullCallback ()
 Get cull node callback, called during cull traversal.
const NodeCallbackgetCullCallback () const
 Get const cull node callback, called during cull traversal.
void addCullCallback (NodeCallback *nc)
 Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one.
void removeCullCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
void setCullingActive (bool active)
 Set the view frustum/small feature culling of this node to be active or inactive.
bool getCullingActive () const
 Get the view frustum/small feature _cullingActive flag for this node.
unsigned int getNumChildrenWithCullingDisabled () const
 Get the number of Children of this node which have culling disabled.
bool isCullingActive () const
 Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal.
unsigned int getNumChildrenWithOccluderNodes () const
 Get the number of Children of this node which are or have OccluderNode's.
bool containsOccluderNodes () const
 return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes.
void setNodeMask (NodeMask nm)
 Set the node mask.
NodeMask getNodeMask () const
 Get the node Mask.
void setStateSet (osg::StateSet *stateset)
 Set the node's StateSet.
osg::StateSetgetOrCreateStateSet ()
 return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.
osg::StateSetgetStateSet ()
 Return the node's StateSet.
const osg::StateSetgetStateSet () const
 Return the node's const StateSet.
void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions.
DescriptionListgetDescriptions ()
 Get the description list of the node.
const DescriptionListgetDescriptions () const
 Get the const description list of the const node.
const std::string & getDescription (unsigned int i) const
 Get a single const description of the const node.
std::string & getDescription (unsigned int i)
 Get a single description of the node.
unsigned int getNumDescriptions () const
 Get the number of descriptions of the node.
void addDescription (const std::string &desc)
 Add a description string to the node.
void setInitialBound (const osg::BoundingSphere &bsphere)
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingSpheregetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume.
void dirtyBound ()
 Mark this node's bounding sphere dirty.
const BoundingSpheregetBound () const
 Get the bounding sphere of node.
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 Set the compute bound callback to override the default computeBound.
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 Get the compute bound callback.
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
 Get the const compute bound callback.
- 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 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.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience 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.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience 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)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (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 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.

Static Public Member Functions

static void flushDeletedQueryObjects (unsigned int contextID, double currentTime, double &availableTime)
static void discardDeletedQueryObjects (unsigned int contextID)

Protected Types

typedef std::map< const
osg::Camera *, unsigned int > 
FrameCountMap

Protected Member Functions

virtual ~OcclusionQueryNode ()
virtual void createSupportNodes ()
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
virtual void childRemoved (unsigned int, unsigned int)
virtual void childInserted (unsigned int)
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 Node destructor.
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
- 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

Protected Attributes

osg::ref_ptr< osg::Geode_queryGeode
osg::ref_ptr< osg::Geode_debugGeode
bool _enabled
FrameCountMap _frameCountMap
OpenThreads::Mutex _frameCountMutex
bool _passed
unsigned int _visThreshold
unsigned int _queryFrameCount
bool _debugBB
OpenThreads::Mutex _computeBoundMutex
- Protected Attributes inherited from osg::Group
NodeList _children
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
ref_ptr
< ComputeBoundingSphereCallback
_computeBoundCallback
BoundingSphere _boundingSphere
bool _boundingSphereComputed
ParentList _parents
ref_ptr< NodeCallback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< NodeCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< NodeCallback_cullCallback
bool _cullingActive
unsigned int _numChildrenWithCullingDisabled
unsigned int _numChildrenWithOccluderNodes
NodeMask _nodeMask
ref_ptr< StateSet_stateset
- 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::Node
typedef std::vector< Group * > ParentList
 A vector of osg::Group pointers which is used to store the parent(s) of node.
typedef unsigned int NodeMask
 This is a set of bits (flags) that represent the Node.
typedef std::vector< std::string > DescriptionList
 A vector of std::string's which are used to describe the object.

Member Typedef Documentation

typedef std::map< const osg::Camera*, unsigned int > osg::OcclusionQueryNode::FrameCountMap
protected

Constructor & Destructor Documentation

osg::OcclusionQueryNode::OcclusionQueryNode ( )
osg::OcclusionQueryNode::OcclusionQueryNode ( const OcclusionQueryNode oqn,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osg::OcclusionQueryNode::~OcclusionQueryNode ( )
protectedvirtual

Member Function Documentation

virtual osg::BoundingSphere osg::OcclusionQueryNode::computeBound ( ) const
virtual

Compute the bounding sphere around Node's geometry or children.

This method is automatically called by getBound() when the bounding sphere has been marked dirty via dirtyBound().

Reimplemented from osg::Group.

virtual void osg::OcclusionQueryNode::createSupportNodes ( )
protectedvirtual
static void osg::OcclusionQueryNode::discardDeletedQueryObjects ( unsigned int  contextID)
static
static void osg::OcclusionQueryNode::flushDeletedQueryObjects ( unsigned int  contextID,
double  currentTime,
double &  availableTime 
)
static
bool osg::OcclusionQueryNode::getDebugDisplay ( ) const
osg::StateSet* osg::OcclusionQueryNode::getDebugStateSet ( )
const osg::StateSet* osg::OcclusionQueryNode::getDebugStateSet ( ) const
bool osg::OcclusionQueryNode::getPassed ( ) const
virtual bool osg::OcclusionQueryNode::getPassed ( const osg::Camera camera,
osg::NodeVisitor nv 
)
virtual
bool osg::OcclusionQueryNode::getQueriesEnabled ( ) const
inline
unsigned int osg::OcclusionQueryNode::getQueryFrameCount ( ) const
inline
osg::StateSet* osg::OcclusionQueryNode::getQueryStateSet ( )
const osg::StateSet* osg::OcclusionQueryNode::getQueryStateSet ( ) const
unsigned int osg::OcclusionQueryNode::getVisibilityThreshold ( ) const
inline
osg::OcclusionQueryNode::META_Node ( osg  ,
OcclusionQueryNode   
)
virtual void osg::OcclusionQueryNode::releaseGLObjects ( osg::State = 0) const
virtual

If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.

Otherwise, releases OpenGL objects for all graphics contexts.

Reimplemented from osg::Group.

void osg::OcclusionQueryNode::setDebugDisplay ( bool  enable)
void osg::OcclusionQueryNode::setDebugStateSet ( osg::StateSet ss)
void osg::OcclusionQueryNode::setQueriesEnabled ( bool  enable = true)
void osg::OcclusionQueryNode::setQueryFrameCount ( unsigned int  frames)
inline
void osg::OcclusionQueryNode::setQueryStateSet ( osg::StateSet ss)
void osg::OcclusionQueryNode::setVisibilityThreshold ( unsigned int  pixels)
inline
void osg::OcclusionQueryNode::traverseDebug ( osg::NodeVisitor nv)
void osg::OcclusionQueryNode::traverseQuery ( const osg::Camera camera,
osg::NodeVisitor nv 
)

Member Data Documentation

OpenThreads::Mutex osg::OcclusionQueryNode::_computeBoundMutex
mutableprotected
bool osg::OcclusionQueryNode::_debugBB
protected
osg::ref_ptr< osg::Geode > osg::OcclusionQueryNode::_debugGeode
protected
bool osg::OcclusionQueryNode::_enabled
protected
FrameCountMap osg::OcclusionQueryNode::_frameCountMap
protected
OpenThreads::Mutex osg::OcclusionQueryNode::_frameCountMutex
mutableprotected
bool osg::OcclusionQueryNode::_passed
protected
unsigned int osg::OcclusionQueryNode::_queryFrameCount
protected
osg::ref_ptr< osg::Geode > osg::OcclusionQueryNode::_queryGeode
protected
unsigned int osg::OcclusionQueryNode::_visThreshold
protected

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

osg logo
Generated at Tue Sep 4 2012 16:27:02 for the OpenSceneGraph by doxygen 1.8.1.2.