Inheritance diagram for osg::Node:
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 ©op=CopyOp::SHALLOW_COPY) | |
| Copy constructor using CopyOp to manage deep vs shallow copy. | |
| virtual Object * | cloneType () const |
| clone an object of the same type as the node. | |
| virtual Object * | clone (const CopyOp ©op) 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 Group * | asGroup () |
| convert 'this' into a Group pointer if Node is a Group, otherwise return 0. | |
| virtual const Group * | asGroup () const |
| convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. | |
| virtual Transform * | asTransform () |
| Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. | |
| virtual const Transform * | asTransform () const |
| convert 'const this' into a const Transform pointer if Node is a Transform, 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 ParentList & | getParents () const |
| Get the parent list of node. | |
| ParentList | getParents () |
| Get the a copy of parent list of node. | |
| Group * | getParent (unsigned int i) |
| const Group * | getParent (unsigned int i) const |
| Get a single const parent of node. | |
| unsigned int | getNumParents () const |
| Get the number of parents of node. | |
| void | setUpdateCallback (NodeCallback *nc) |
| Set update node callback, called during update traversal. | |
| NodeCallback * | getUpdateCallback () |
| Get update node callback, called during update traversal. | |
| const NodeCallback * | getUpdateCallback () const |
| Get const update node callback, called during update traversal. | |
| 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 update node callback, called during update traversal. | |
| NodeCallback * | getEventCallback () |
| Get update node callback, called during update traversal. | |
| const NodeCallback * | getEventCallback () const |
| Get const update node callback, called during update traversal. | |
| 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. | |
| NodeCallback * | getCullCallback () |
| Get cull node callback, called during cull traversal. | |
| const NodeCallback * | getCullCallback () const |
| Get const cull node callback, called during cull traversal. | |
| 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. | |
| DescriptionList & | getDescriptions () |
| Get the description list of the node. | |
| const DescriptionList & | getDescriptions () 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::StateSet * | getOrCreateStateSet () |
| return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet. | |
| osg::StateSet * | getStateSet () |
| Return the node's StateSet. | |
| const osg::StateSet * | getStateSet () const |
| Return the node's const StateSet. | |
| void | setInitialBound (const osg::BoundingSphere &bsphere) |
| Set the intial bounding volume to use when computing the overall bounding volume. | |
| const BoundingSphere & | getInitialBound () const |
| Set the intial bounding volume to use when computing the overall bounding volume. | |
| void | dirtyBound () |
| Mark this node's bounding sphere dirty. | |
| const BoundingSphere & | getBound () 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. | |
| ComputeBoundingSphereCallback * | getComputeBoundingSphereCallback () |
| Get the compute bound callback. | |
| const ComputeBoundingSphereCallback * | getComputeBoundingSphereCallback () const |
| Get the const compute bound callback. | |
| 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 |
Provides interface for most common node operations (Composite Pattern).
|
|
A vector of std::string's which are used to describe the object.
|
|
|
|
|
|
A vector of osg::Group pointers which is used to store the parent(s) of node.
|
|
|
Construct a node. Initialize the parent list to empty, node name to "" and bounding sphere dirty flag to true. |
|
||||||||||||
|
Copy constructor using CopyOp to manage deep vs shallow copy.
|
|
|
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(). |
|
|
Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
Reimplemented in osg::AutoTransform, osgParticle::Emitter, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, and osgParticle::Program. |
|
|
Add a description string to the node.
|
|
|
|
|
|
Traverse upwards : calls parents' accept method with NodeVisitor.
|
|
|
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. |
|
|
convert 'this' into a Group pointer if Node is a Group, otherwise return 0. Equivalent to dynamic_cast<Group*>(this). Reimplemented in osg::Group. |
|
|
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. |
|
|
Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. Equivalent to dynamic_cast<Transform*>(this). Reimplemented in osg::Transform. |
|
|
return the name of the node's class type.
Implements osg::Object. Reimplemented in osg::AutoTransform, osgFX::Effect, osgParticle::Emitter, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, and osgParticle::Program. |
|
|
return a clone of a node, with Object* return type.
Implements osg::Object. |
|
|
clone an object of the same type as the node.
Implements osg::Object. Reimplemented in osg::AutoTransform. |
|
|
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 in osg::Billboard, osg::ClipNode, osg::Geode, osg::Group, osg::LightSource, osg::LOD, osg::OccluderNode, osg::ProxyNode, osg::Switch, osg::Transform, osgParticle::ParticleProcessor, osgParticle::ParticleSystemUpdater, osgSim::Impostor, and osgSim::LightPointNode. |
|
|
return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes.
|
|
|
Mark this node's bounding sphere dirty. Forcing it to be computed on the next call to getBound(). |
|
|
Get the bounding sphere of node. Using lazy evaluation computes the bounding sphere if it is 'dirty'. |
|
|
Get the const compute bound callback.
|
|
|
Get the compute bound callback.
|
|
|
Get const cull node callback, called during cull traversal.
|
|
|
Get cull node callback, called during cull traversal.
|
|
|
Get the view frustum/small feature _cullingActive flag for this node. Used as a guide to the cull traversal. |
|
|
Get a single description of the node.
|
|
|
Get a single const description of the const node.
|
|
|
Get the const description list of the const node.
|
|
|
Get the description list of the node.
|
|
|
Get const update node callback, called during update traversal.
|
|
|
Get update node callback, called during update traversal.
|
|
|
Set the intial bounding volume to use when computing the overall bounding volume.
|
|
|
Get the node Mask.
|
|
|
Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children.
|
|
|
Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children.
|
|
|
Get the number of Children of this node which have culling disabled.
|
|
|
Get the number of Children of this node which are or have OccluderNode's.
|
|
|
Get the number of descriptions of the node.
|
|
|
Get the number of parents of node.
|
|
|
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. |
|
|
Get a single const parent of node.
|
|
|
|
|
|
Get the a copy of parent list of node. A copy is returned to prevent modification of the parent list. |
|
|
Get the parent list of node.
|
|
|
Return the node's const StateSet. Returns NULL if a stateset is not attached. |
|
|
Return the node's StateSet. returns NULL if a stateset is not attached. |
|
|
Get const update node callback, called during update traversal.
|
|
|
Get update node callback, called during update traversal.
|
|
|
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. |
|
|
return true if this and obj are of the same kind of object.
Reimplemented from osg::Object. |
|
|
return the name of the node's library.
Implements osg::Object. Reimplemented in osg::AutoTransform, osgFX::Effect, osgParticle::Emitter, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, and osgParticle::Program. |
|
|
If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. Otherwise, releases OpenGL objexts for all graphics contexts. Reimplemented from osg::Object. Reimplemented in osg::Geode, and osg::Group. |
|
|
|
|
|
Set the compute bound callback to override the default computeBound.
|
|
|
Set cull node callback, called during cull traversal.
|
|
|
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. |
|
|
Set the description list of the node.
|
|
|
Set update node callback, called during update traversal.
|
|
|
Set the intial bounding volume to use when computing the overall bounding volume.
|
|
|
Set the node mask.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Set the node's StateSet.
|
|
|
Set update node callback, called during update traversal.
|
|
|
Traverse downwards : calls children's accept method with NodeVisitor.
Reimplemented in osg::Group, osg::LOD, osg::PagedLOD, osg::ProxyNode, osg::Sequence, osg::Switch, osgFX::Effect, osgParticle::ParticleProcessor, osgParticle::ParticleSystemUpdater, osgSim::DOFTransform, osgSim::Impostor, osgSim::LightPointNode, osgSim::MultiSwitch, osgSim::OverlayNode, osgSim::VisibilityGroup, and osgTerrain::HeightFieldNode. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|