Inheritance diagram for osg::Node:
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.
osg::Node::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.
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().
virtual void osg::Node::accept | ( | NodeVisitor & | nv | ) | [virtual] |
Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
Reimplemented in osg::AutoTransform, osgParticle::Emitter, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, osgParticle::PrecipitationEffect, and osgParticle::Program.
void osg::Node::addDescription | ( | const std::string & | desc | ) | [inline] |
Add a description string to the node.
void osg::Node::addParent | ( | osg::Group * | node | ) | [protected] |
virtual void osg::Node::ascend | ( | NodeVisitor & | nv | ) | [virtual] |
Traverse upwards : calls parents' accept method with NodeVisitor.
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 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 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] |
return the name of the node's class type.
Implements osg::Object.
Reimplemented in osg::AutoTransform, osgFX::Effect, osgParticle::Emitter, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, osgParticle::PrecipitationEffect, and osgParticle::Program.
return a clone of a node, with Object* return type.
Implements osg::Object.
Reimplemented in osg::AutoTransform.
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.
virtual BoundingSphere osg::Node::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 in osg::AutoTransform, 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.
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'.
const ComputeBoundingSphereCallback* osg::Node::getComputeBoundingSphereCallback | ( | ) | const [inline] |
Get the const compute bound callback.
ComputeBoundingSphereCallback* osg::Node::getComputeBoundingSphereCallback | ( | ) | [inline] |
Get the compute bound callback.
const NodeCallback* osg::Node::getCullCallback | ( | ) | const [inline] |
Get const cull node callback, called during cull traversal.
NodeCallback* osg::Node::getCullCallback | ( | ) | [inline] |
Get 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.
std::string& osg::Node::getDescription | ( | unsigned int | i | ) | [inline] |
Get a single description of the node.
const std::string& osg::Node::getDescription | ( | unsigned int | i | ) | const [inline] |
Get a single const description of the const node.
const DescriptionList& osg::Node::getDescriptions | ( | ) | const [inline] |
Get the const description list of the const node.
DescriptionList& osg::Node::getDescriptions | ( | ) | [inline] |
Get the description list of the node.
const NodeCallback* osg::Node::getEventCallback | ( | ) | const [inline] |
Get const update node callback, called during update traversal.
NodeCallback* osg::Node::getEventCallback | ( | ) | [inline] |
Get update node callback, called during update traversal.
const BoundingSphere& osg::Node::getInitialBound | ( | ) | const [inline] |
Set the intial bounding volume to use when computing the overall bounding volume.
NodeMask osg::Node::getNodeMask | ( | ) | const [inline] |
Get the node Mask.
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.
unsigned int osg::Node::getNumDescriptions | ( | ) | const [inline] |
Get the number of descriptions of the node.
unsigned int osg::Node::getNumParents | ( | ) | const [inline] |
Get the number of parents of node.
osg::StateSet* osg::Node::getOrCreateStateSet | ( | ) |
const Group* osg::Node::getParent | ( | unsigned int | i | ) | const [inline] |
Get a single const parent of node.
i | index of the parent to get. |
Group* osg::Node::getParent | ( | unsigned int | i | ) | [inline] |
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] |
Return the node's StateSet. returns NULL if a stateset is not attached.
const NodeCallback* osg::Node::getUpdateCallback | ( | ) | const [inline] |
Get const update node callback, called during update traversal.
NodeCallback* osg::Node::getUpdateCallback | ( | ) | [inline] |
Get update node callback, called during update traversal.
MatrixList osg::Node::getWorldMatrices | ( | 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.
virtual bool osg::Node::isSameKindAs | ( | const Object * | obj | ) | const [inline, virtual] |
return true if this and obj are of the same kind of object.
Reimplemented from osg::Object.
Reimplemented in osg::AutoTransform, osgFX::Effect, osgParticle::Emitter, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, osgParticle::PrecipitationEffect, and osgParticle::Program.
virtual const char* osg::Node::libraryName | ( | ) | const [inline, virtual] |
return the name of the node's library.
Implements osg::Object.
Reimplemented in osg::AutoTransform, osgFX::Effect, osgParticle::Emitter, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, osgParticle::PrecipitationEffect, and osgParticle::Program.
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 objexts for all graphics contexts.
Reimplemented from osg::Object.
Reimplemented in osg::CameraNode, osg::Geode, and osg::Group.
void osg::Node::removeParent | ( | osg::Group * | node | ) | [protected] |
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 update node callback, called during update traversal.
void osg::Node::setInitialBound | ( | const osg::BoundingSphere & | bsphere | ) | [inline] |
Set the intial 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.
void osg::Node::setUpdateCallback | ( | NodeCallback * | nc | ) |
Set update node callback, called during update traversal.
virtual void osg::Node::traverse | ( | NodeVisitor & | ) | [inline, virtual] |
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, osgParticle::PrecipitationEffect, osgSim::DOFTransform, osgSim::Impostor, osgSim::LightPointNode, osgSim::MultiSwitch, osgSim::OverlayNode, osgSim::VisibilityGroup, and osgTerrain::HeightFieldNode.
friend class osg::Drawable [friend] |
friend class osg::Group [friend] |
friend class osg::StateSet [friend] |
BoundingSphere osg::Node::_boundingSphere [mutable, protected] |
bool osg::Node::_boundingSphereComputed [mutable, protected] |
ref_ptr<NodeCallback> osg::Node::_cullCallback [protected] |
bool osg::Node::_cullingActive [protected] |
DescriptionList osg::Node::_descriptions [protected] |
ref_ptr<NodeCallback> osg::Node::_eventCallback [protected] |
BoundingSphere osg::Node::_initialBound [protected] |
NodeMask osg::Node::_nodeMask [protected] |
unsigned int osg::Node::_numChildrenRequiringEventTraversal [protected] |
unsigned int osg::Node::_numChildrenRequiringUpdateTraversal [protected] |
unsigned int osg::Node::_numChildrenWithCullingDisabled [protected] |
unsigned int osg::Node::_numChildrenWithOccluderNodes [protected] |
ParentList osg::Node::_parents [protected] |
ref_ptr<StateSet> osg::Node::_stateset [protected] |
ref_ptr<NodeCallback> osg::Node::_updateCallback [protected] |