OpenSceneGraph 2.8.4
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
osg::Node Class Reference

Base class for all internal nodes in the scene graph. More...

Inheritance diagram for osg::Node:
Inheritance graph
[legend]

List of all members.

Classes

struct  ComputeBoundingSphereCallback
 Callback to allow users to override the default computation of bounding volume. More...

Public Types

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
typedef std::vector< std::string > DescriptionList
 A vector of std::string's which are used to describe the object.

Public Member Functions

 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 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 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 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.
virtual void traverse (NodeVisitor &)
 Traverse downwards : calls children's 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 setDescriptions (const DescriptionList &descriptions)
 Set the description list of the node.
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 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 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.
virtual BoundingSphere computeBound () const
 Compute the bounding sphere around Node's geometry or children.
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.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
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.

Protected Member Functions

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 Attributes

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
DescriptionList _descriptions
ref_ptr< StateSet_stateset

Friends

class osg::Group
class osg::Drawable
class osg::StateSet

Detailed Description

Base class for all internal nodes in the scene graph.

Provides interface for most common node operations (Composite Pattern).


Member Typedef Documentation

typedef std::vector<std::string> osg::Node::DescriptionList

A vector of std::string's which are used to describe the object.

typedef unsigned int osg::Node::NodeMask
typedef std::vector<Group*> osg::Node::ParentList

A vector of osg::Group pointers which is used to store the parent(s) of node.


Constructor & Destructor Documentation

osg::Node::Node ( )

Construct a node.

Initialize the parent list to empty, node name to "" and bounding sphere dirty flag to true.

osg::Node::Node ( const Node ,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Node::~Node ( ) [protected, virtual]

Node destructor.

Note, is protected so that Nodes cannot be deleted other than by being dereferenced and the reference count being zero (see osg::Referenced), preventing the deletion of nodes which are still in use. This also means that Nodes cannot be created on stack i.e Node node will not compile, forcing all nodes to be created on the heap i.e Node* node = new Node().


Member Function Documentation

virtual void osg::Node::accept ( NodeVisitor nv) [virtual]
void osg::Node::addCullCallback ( NodeCallback nc) [inline]

Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one.

References NULL.

void osg::Node::addDescription ( const std::string &  desc) [inline]

Add a description string to the node.

void osg::Node::addEventCallback ( NodeCallback nc) [inline]

Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one.

References NULL.

void osg::Node::addParent ( osg::Group node) [protected]
void osg::Node::addUpdateCallback ( NodeCallback nc) [inline]

Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one.

References NULL.

virtual void osg::Node::ascend ( NodeVisitor nv) [virtual]

Traverse upwards : calls parents' accept method with NodeVisitor.

Referenced by osg::NodeVisitor::traverse().

virtual Geode* osg::Node::asGeode ( ) [inline, virtual]

Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.

Equivalent to dynamic_cast<Geode*>(this).

Reimplemented in osg::Geode.

virtual const Geode* osg::Node::asGeode ( ) const [inline, virtual]

convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.

Equivalent to dynamic_cast<const Geode*>(this).

Reimplemented in osg::Geode.

virtual Group* osg::Node::asGroup ( ) [inline, virtual]

convert 'this' into a Group pointer if Node is a Group, otherwise return 0.

Equivalent to dynamic_cast<Group*>(this).

Reimplemented in osg::Group.

virtual const Group* osg::Node::asGroup ( ) const [inline, virtual]

convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.

Equivalent to dynamic_cast<const Group*>(this).

Reimplemented in osg::Group.

virtual Switch* osg::Node::asSwitch ( ) [inline, virtual]

Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0.

Equivalent to dynamic_cast<Switch*>(this).

Reimplemented in osg::Switch.

virtual const Switch* osg::Node::asSwitch ( ) const [inline, virtual]

convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0.

Equivalent to dynamic_cast<const Switch*>(this).

Reimplemented in osg::Switch.

virtual const Transform* osg::Node::asTransform ( ) const [inline, virtual]

convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.

Equivalent to dynamic_cast<const Transform*>(this).

Reimplemented in osg::Transform.

virtual Transform* osg::Node::asTransform ( ) [inline, virtual]

Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.

Equivalent to dynamic_cast<Transform*>(this).

Reimplemented in osg::Transform.

virtual const char* osg::Node::className ( ) const [inline, virtual]
virtual Object* osg::Node::clone ( const CopyOp copyop) const [inline, virtual]

return a clone of a node, with Object* return type.

Implements osg::Object.

Reimplemented in osg::AutoTransform, and osgManipulator::AntiSquish.

virtual Object* osg::Node::cloneType ( ) const [inline, virtual]

clone an object of the same type as the node.

Implements osg::Object.

Reimplemented in osg::AutoTransform, and osgManipulator::AntiSquish.

virtual BoundingSphere osg::Node::computeBound ( ) const [virtual]
bool osg::Node::containsOccluderNodes ( ) const

return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes.

void osg::Node::dirtyBound ( )

Mark this node's bounding sphere dirty.

Forcing it to be computed on the next call to getBound().

const BoundingSphere& osg::Node::getBound ( ) const [inline]

Get the bounding sphere of node.

Using lazy evaluation computes the bounding sphere if it is 'dirty'.

References osg::BoundingSphereImpl< VT >::expandBy().

Referenced by osg::CullStack::isCulled().

ComputeBoundingSphereCallback* osg::Node::getComputeBoundingSphereCallback ( ) [inline]

Get the compute bound callback.

const ComputeBoundingSphereCallback* osg::Node::getComputeBoundingSphereCallback ( ) const [inline]

Get the const compute bound callback.

NodeCallback* osg::Node::getCullCallback ( ) [inline]
const NodeCallback* osg::Node::getCullCallback ( ) const [inline]

Get const cull node callback, called during cull traversal.

bool osg::Node::getCullingActive ( ) const [inline]

Get the view frustum/small feature _cullingActive flag for this node.

Used as a guide to the cull traversal.

const std::string& osg::Node::getDescription ( unsigned int  i) const [inline]

Get a single const description of the const node.

std::string& osg::Node::getDescription ( unsigned int  i) [inline]

Get a single description of the node.

DescriptionList& osg::Node::getDescriptions ( ) [inline]

Get the description list of the node.

const DescriptionList& osg::Node::getDescriptions ( ) const [inline]

Get the const description list of the const node.

const NodeCallback* osg::Node::getEventCallback ( ) const [inline]

Get const event node callback, called during event traversal.

NodeCallback* osg::Node::getEventCallback ( ) [inline]
const BoundingSphere& osg::Node::getInitialBound ( ) const [inline]

Set the initial bounding volume to use when computing the overall bounding volume.

NodeMask osg::Node::getNodeMask ( ) const [inline]
unsigned int osg::Node::getNumChildrenRequiringEventTraversal ( ) const [inline]

Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children.

unsigned int osg::Node::getNumChildrenRequiringUpdateTraversal ( ) const [inline]

Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children.

unsigned int osg::Node::getNumChildrenWithCullingDisabled ( ) const [inline]

Get the number of Children of this node which have culling disabled.

unsigned int osg::Node::getNumChildrenWithOccluderNodes ( ) const [inline]

Get the number of Children of this node which are or have OccluderNode's.

Referenced by osg::CollectOccludersVisitor::handle_cull_callbacks_and_accept(), and osg::CollectOccludersVisitor::handle_cull_callbacks_and_traverse().

unsigned int osg::Node::getNumDescriptions ( ) const [inline]

Get the number of descriptions of the node.

Referenced by osgUtil::Optimizer::isOperationPermissibleForObjectImplementation().

unsigned int osg::Node::getNumParents ( ) const [inline]

Get the number of parents of node.

Returns:
the number of parents of this node.
osg::StateSet* osg::Node::getOrCreateStateSet ( )

return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.

This ensures that a valid StateSet is always returned and can be used directly.

Group* osg::Node::getParent ( unsigned int  i) [inline]
const Group* osg::Node::getParent ( unsigned int  i) const [inline]

Get a single const parent of node.

Parameters:
iindex of the parent to get.
Returns:
the parent i.
NodePathList osg::Node::getParentalNodePaths ( osg::Node haltTraversalAtNode = 0) const

Get the list of node paths parent paths.

The optional Node* haltTraversalAtNode allows the user to prevent traversal beyond a specifed node.

ParentList osg::Node::getParents ( ) [inline]

Get the a copy of parent list of node.

A copy is returned to prevent modification of the parent list.

const ParentList& osg::Node::getParents ( ) const [inline]

Get the parent list of node.

const osg::StateSet* osg::Node::getStateSet ( ) const [inline]

Return the node's const StateSet.

Returns NULL if a stateset is not attached.

osg::StateSet* osg::Node::getStateSet ( ) [inline]
NodeCallback* osg::Node::getUpdateCallback ( ) [inline]
const NodeCallback* osg::Node::getUpdateCallback ( ) const [inline]

Get const update node callback, called during update traversal.

MatrixList osg::Node::getWorldMatrices ( const osg::Node haltTraversalAtNode = 0) const

Get the list of matrices that transform this node from local coordinates to world coordinates.

The optional Node* haltTraversalAtNode allows the user to prevent traversal beyond a specifed node.

bool osg::Node::isCullingActive ( ) const [inline]

Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal.

Note, returns true only if no children have culling disabled, and the local _cullingActive flag is true.

Referenced by osg::CullStack::isCulled().

virtual bool osg::Node::isSameKindAs ( const Object obj) const [inline, virtual]
virtual const char* osg::Node::libraryName ( ) const [inline, virtual]
virtual void osg::Node::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::Object.

Reimplemented in osg::Camera, osg::Geode, osg::Group, osg::OcclusionQueryNode, and osgSim::OverlayNode.

void osg::Node::removeCullCallback ( NodeCallback nc) [inline]

Convenience method that removes a given callback from a node, even if that callback is nested.

There is no error return in case the given callback is not found.

References osg::NodeCallback::getNestedCallback(), and NULL.

void osg::Node::removeEventCallback ( NodeCallback nc) [inline]

Convenience method that removes a given callback from a node, even if that callback is nested.

There is no error return in case the given callback is not found.

References osg::NodeCallback::getNestedCallback(), and NULL.

void osg::Node::removeParent ( osg::Group node) [protected]
void osg::Node::removeUpdateCallback ( NodeCallback nc) [inline]

Convenience method that removes a given callback from a node, even if that callback is nested.

There is no error return in case the given callback is not found.

References osg::NodeCallback::getNestedCallback(), and NULL.

virtual void osg::Node::resizeGLObjectBuffers ( unsigned  int) [virtual]

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

Reimplemented in osg::Camera, osg::Geode, osg::Group, and osgSim::OverlayNode.

void osg::Node::setComputeBoundingSphereCallback ( ComputeBoundingSphereCallback callback) [inline]

Set the compute bound callback to override the default computeBound.

void osg::Node::setCullCallback ( NodeCallback nc) [inline]

Set cull node callback, called during cull traversal.

void osg::Node::setCullingActive ( bool  active)

Set the view frustum/small feature culling of this node to be active or inactive.

The default value is true for _cullingActive. Used as a guide to the cull traversal.

void osg::Node::setDescriptions ( const DescriptionList descriptions) [inline]

Set the description list of the node.

void osg::Node::setEventCallback ( NodeCallback nc)

Set event node callback, called during event traversal.

void osg::Node::setInitialBound ( const osg::BoundingSphere bsphere) [inline]

Set the initial bounding volume to use when computing the overall bounding volume.

void osg::Node::setNodeMask ( NodeMask  nm) [inline]

Set the node mask.

void osg::Node::setNumChildrenRequiringEventTraversal ( unsigned int  num) [protected]
void osg::Node::setNumChildrenRequiringUpdateTraversal ( unsigned int  num) [protected]
void osg::Node::setNumChildrenWithCullingDisabled ( unsigned int  num) [protected]
void osg::Node::setNumChildrenWithOccluderNodes ( unsigned int  num) [protected]
void osg::Node::setStateSet ( osg::StateSet stateset)

Set the node's StateSet.

virtual void osg::Node::setThreadSafeRefUnref ( bool  threadSafe) [virtual]

Set whether to use a mutex to ensure ref() and unref() are thread safe.

Reimplemented from osg::Referenced.

Reimplemented in osg::Geode, osg::Group, osg::LightSource, osg::TexGenNode, and osgSim::OverlayNode.

void osg::Node::setUpdateCallback ( NodeCallback nc)

Set update node callback, called during update traversal.

virtual void osg::Node::traverse ( NodeVisitor ) [inline, virtual]

Friends And Related Function Documentation

friend class osg::Drawable [friend]
friend class osg::Group [friend]
friend class osg::StateSet [friend]

Member Data Documentation

bool osg::Node::_boundingSphereComputed [mutable, protected]
bool osg::Node::_cullingActive [protected]
unsigned int osg::Node::_numChildrenWithOccluderNodes [protected]

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

osg logo
Generated at Sun Jan 8 2012 13:16:15 for the OpenSceneGraph by doxygen 1.7.4.