openscenegraph
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
osg::Node Class Reference

#include <Node>

Inheritance diagram for osg::Node:
osg::Object osg::Referenced osg::Drawable osg::Group osgParticle::ParticleProcessor osgParticle::ParticleSystemUpdater osgParticle::PrecipitationEffect osgSim::LightPointNode osg::DispatchCompute osg::DrawPixels osg::Geometry osgParticle::ParticleSystem osgParticle::PrecipitationEffect::PrecipitationDrawable osgTerrain::HeightFieldDrawable osgTerrain::SharedGeometry osgText::TextBase osg::ClearNode osg::ClipNode osg::CoordinateSystemNode osg::Geode osg::LOD osg::LightSource osg::OccluderNode osg::OcclusionQueryNode osg::Projection osg::ProxyNode osg::Sequence osg::Switch osg::TexGenNode osg::Transform osgFX::Effect osgFX::MultiTextureControl osgGA::Widget osgParticle::ParticleEffect osgPresentation::Cursor osgShadow::ShadowedScene osgSim::MultiSwitch osgSim::OverlayNode osgSim::VisibilityGroup osgTerrain::TerrainTile osgUI::Widget osgVolume::Volume osgVolume::VolumeScene osgVolume::VolumeTile osgParticle::Emitter osgParticle::Program

Classes

struct  ComputeBoundingSphereCallback
 

Public Types

typedef std::vector< Group * > ParentList
 
typedef unsigned int NodeMask
 
typedef std::vector< std::string > DescriptionList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 

Public Member Functions

 Node ()
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const
 
virtual Objectclone (const CopyOp &copyop) const
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual GeometryasGeometry ()
 
virtual const GeometryasGeometry () const
 
virtual GroupasGroup ()
 
virtual const GroupasGroup () const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () const
 
virtual void accept (NodeVisitor &nv)
 
virtual void ascend (NodeVisitor &nv)
 
virtual void traverse (NodeVisitor &)
 
const ParentListgetParents () const
 
ParentList getParents ()
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setUpdateCallback (Callback *nc)
 
template<class T >
void setUpdateCallback (const ref_ptr< T > &nc)
 
CallbackgetUpdateCallback ()
 
const CallbackgetUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
template<class T >
void addUpdateCallback (const ref_ptr< T > &nc)
 
void removeUpdateCallback (Callback *nc)
 
template<class T >
void removeUpdateCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
template<class T >
void setEventCallback (const ref_ptr< T > &nc)
 
CallbackgetEventCallback ()
 
const CallbackgetEventCallback () const
 
void addEventCallback (Callback *nc)
 
template<class T >
void addEventCallback (const ref_ptr< T > &nc)
 
void removeEventCallback (Callback *nc)
 
template<class T >
void removeEventCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
template<class T >
void setCullCallback (const ref_ptr< T > &nc)
 
CallbackgetCullCallback ()
 
const CallbackgetCullCallback () const
 
void addCullCallback (Callback *nc)
 
template<class T >
void addCullCallback (const ref_ptr< T > &nc)
 
void removeCullCallback (Callback *nc)
 
template<class T >
void removeCullCallback (const ref_ptr< T > &nc)
 
void setCullingActive (bool active)
 
bool getCullingActive () const
 
unsigned int getNumChildrenWithCullingDisabled () const
 
bool isCullingActive () const
 
unsigned int getNumChildrenWithOccluderNodes () const
 
bool containsOccluderNodes () const
 
void setNodeMask (NodeMask nm)
 
NodeMask getNodeMask () const
 
void setStateSet (osg::StateSet *stateset)
 
template<class T >
void setStateSet (const osg::ref_ptr< T > &stateset)
 
osg::StateSetgetOrCreateStateSet ()
 
osg::StateSetgetStateSet ()
 
const osg::StateSetgetStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionListgetDescriptions ()
 
const DescriptionListgetDescriptions () const
 
const std::string & getDescription (unsigned int i) const
 
std::string & getDescription (unsigned int i)
 
unsigned int getNumDescriptions () const
 
void addDescription (const std::string &desc)
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 
const BoundingSpheregetInitialBound () const
 
void dirtyBound ()
 
const BoundingSpheregetBound () const
 
virtual BoundingSphere computeBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
template<class T >
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (osg::State *=0) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
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 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 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)
 
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 Member Functions

virtual ~Node ()
 
void addParent (osg::Group *parent)
 
void removeParent (osg::Group *parent)
 
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 ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

BoundingSphere _initialBound
 
ref_ptr< ComputeBoundingSphereCallback_computeBoundCallback
 
BoundingSphere _boundingSphere
 
bool _boundingSphereComputed
 
ParentList _parents
 
ref_ptr< Callback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< Callback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< Callback_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
 

Friends

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

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Detailed Description

Base class for all internal nodes in the scene graph. Provides interface for most common node operations (Composite Pattern).

Member Typedef Documentation

◆ DescriptionList

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

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

◆ NodeMask

typedef unsigned int osg::Node::NodeMask

This is a set of bits (flags) that represent the Node. The default value is 0xffffffff (all bits set).

The most common use of these is during traversal of the scene graph. For instance, when traversing the scene graph the osg::NodeVisitor does a bitwise AND of its TraversalMask with the Node's NodeMask to determine if the Node should be processed/traversed.

For example, if a Node has a NodeMask value of 0x02 (only 2nd bit set) and the osg::Camera has a CullMask of 0x4 (2nd bit not set) then during cull traversal, which takes it's TraversalMask from the Camera's CullMask, the node and any children would be ignored and thereby treated as "culled" and thus not rendered. Conversely, if the osg::Camera CullMask were 0x3 (2nd bit set) then the node would be processed and child Nodes would be examined.

◆ ParentList

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

◆ Node() [1/2]

osg::Node::Node ( )

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

◆ Node() [2/2]

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

Copy constructor using CopyOp to manage deep vs shallow copy.

◆ ~Node()

virtual osg::Node::~Node ( )
protectedvirtual

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

◆ accept()

virtual void osg::Node::accept ( NodeVisitor nv)
virtual

Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.

Reimplemented in osgParticle::Emitter, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, osgParticle::PrecipitationEffect, and osgParticle::Program.

◆ addCullCallback() [1/2]

void osg::Node::addCullCallback ( Callback nc)
inline

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

◆ addCullCallback() [2/2]

template<class T >
void osg::Node::addCullCallback ( const ref_ptr< T > &  nc)
inline

◆ addDescription()

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

Add a description string to the node.

◆ addEventCallback() [1/2]

void osg::Node::addEventCallback ( Callback nc)
inline

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

◆ addEventCallback() [2/2]

template<class T >
void osg::Node::addEventCallback ( const ref_ptr< T > &  nc)
inline

◆ addParent()

void osg::Node::addParent ( osg::Group parent)
protected

◆ addUpdateCallback() [1/2]

void osg::Node::addUpdateCallback ( Callback nc)
inline

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

◆ addUpdateCallback() [2/2]

template<class T >
void osg::Node::addUpdateCallback ( const ref_ptr< T > &  nc)
inline

◆ ascend()

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

Traverse upwards : calls parents' accept method with NodeVisitor.

◆ asDrawable() [1/2]

virtual Drawable * osg::Node::asDrawable ( )
inlinevirtual

convert 'this' into a Drawable pointer if Node is a Drawable, otherwise return 0. Equivalent to dynamic_cast<Group*>(this).

Reimplemented from osg::Object.

Reimplemented in osg::Drawable.

◆ asDrawable() [2/2]

virtual const Drawable * osg::Node::asDrawable ( ) const
inlinevirtual

convert 'const this' into a const Drawable pointer if Node is a Drawable, otherwise return 0. Equivalent to dynamic_cast<const Group*>(this).

Reimplemented from osg::Object.

Reimplemented in osg::Drawable.

◆ asGeode() [1/2]

virtual Geode * osg::Node::asGeode ( )
inlinevirtual

Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0. Equivalent to dynamic_cast<Geode*>(this).

Reimplemented in osg::Geode.

◆ asGeode() [2/2]

virtual const Geode * osg::Node::asGeode ( ) const
inlinevirtual

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.

◆ asGeometry() [1/2]

virtual Geometry * osg::Node::asGeometry ( )
inlinevirtual

convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0. Equivalent to dynamic_cast<Group*>(this).

Reimplemented in osg::Geometry.

◆ asGeometry() [2/2]

virtual const Geometry * osg::Node::asGeometry ( ) const
inlinevirtual

convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0. Equivalent to dynamic_cast<const Group*>(this).

Reimplemented in osg::Geometry.

◆ asGroup() [1/2]

virtual Group * osg::Node::asGroup ( )
inlinevirtual

convert 'this' into a Group pointer if Node is a Group, otherwise return 0. Equivalent to dynamic_cast<Group*>(this).

Reimplemented in osg::Group.

◆ asGroup() [2/2]

virtual const Group * osg::Node::asGroup ( ) const
inlinevirtual

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.

◆ asNode() [1/2]

virtual Node * osg::Node::asNode ( )
inlinevirtual

Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. Equivalent to dynamic_cast<Node*>(this).

Reimplemented from osg::Object.

◆ asNode() [2/2]

virtual const Node * osg::Node::asNode ( ) const
inlinevirtual

convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. Equivalent to dynamic_cast<const Node*>(this).

Reimplemented from osg::Object.

◆ asSwitch() [1/2]

virtual Switch * osg::Node::asSwitch ( )
inlinevirtual

Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0. Equivalent to dynamic_cast<Switch*>(this).

Reimplemented in osg::Switch.

◆ asSwitch() [2/2]

virtual const Switch * osg::Node::asSwitch ( ) const
inlinevirtual

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.

◆ asTerrain() [1/2]

virtual osgTerrain::Terrain * osg::Node::asTerrain ( )
inlinevirtual

Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. Equivalent to dynamic_cast<Terrrain*>(this).

Reimplemented in osgTerrain::Terrain.

◆ asTerrain() [2/2]

virtual const osgTerrain::Terrain * osg::Node::asTerrain ( ) const
inlinevirtual

convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. Equivalent to dynamic_cast<const Terrain*>(this).

Reimplemented in osgTerrain::Terrain.

◆ asTransform() [1/2]

virtual Transform * osg::Node::asTransform ( )
inlinevirtual

Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. Equivalent to dynamic_cast<Transform*>(this).

Reimplemented in osg::Transform.

◆ asTransform() [2/2]

virtual const Transform * osg::Node::asTransform ( ) const
inlinevirtual

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.

◆ className()

virtual const char * osg::Node::className ( ) const
inlinevirtual

◆ clone()

virtual Object * osg::Node::clone ( const CopyOp copyop) const
inlinevirtual

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

Implements osg::Object.

Reimplemented in osg::DrawPixels, osg::ShapeDrawable, osgSim::ImpostorSprite, osg::AutoTransform, osgAnimation::MorphGeometry, osgManipulator::AntiSquish, and osgText::Text.

◆ cloneType()

virtual Object * osg::Node::cloneType ( ) const
inlinevirtual

◆ computeBound()

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

◆ containsOccluderNodes()

bool osg::Node::containsOccluderNodes ( ) const

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

◆ dirtyBound()

void osg::Node::dirtyBound ( )

Mark this node's bounding sphere dirty. Forcing it to be computed on the next call to getBound().

◆ getBound()

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

◆ getComputeBoundingSphereCallback() [1/2]

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

Get the compute bound callback.

◆ getComputeBoundingSphereCallback() [2/2]

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

Get the const compute bound callback.

◆ getCullCallback() [1/2]

Callback * osg::Node::getCullCallback ( )
inline

Get cull node callback, called during cull traversal.

◆ getCullCallback() [2/2]

const Callback * osg::Node::getCullCallback ( ) const
inline

Get const cull node callback, called during cull traversal.

◆ getCullingActive()

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.

◆ getDescription() [1/2]

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

Get a single description of the node.

◆ getDescription() [2/2]

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

Get a single const description of the const node.

◆ getDescriptions() [1/2]

DescriptionList & osg::Node::getDescriptions ( )

Get the description list of the node.

◆ getDescriptions() [2/2]

const DescriptionList & osg::Node::getDescriptions ( ) const

Get the const description list of the const node.

◆ getEventCallback() [1/2]

Callback * osg::Node::getEventCallback ( )
inline

Get event node callback, called during event traversal.

◆ getEventCallback() [2/2]

const Callback * osg::Node::getEventCallback ( ) const
inline

Get const event node callback, called during event traversal.

◆ getInitialBound()

const BoundingSphere & osg::Node::getInitialBound ( ) const
inline

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

◆ getNodeMask()

NodeMask osg::Node::getNodeMask ( ) const
inline

Get the node Mask.

◆ getNumChildrenRequiringEventTraversal()

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.

◆ getNumChildrenRequiringUpdateTraversal()

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.

◆ getNumChildrenWithCullingDisabled()

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

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

◆ getNumChildrenWithOccluderNodes()

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

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

◆ getNumDescriptions()

unsigned int osg::Node::getNumDescriptions ( ) const

Get the number of descriptions of the node.

◆ getNumParents()

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

Get the number of parents of node.

Returns
the number of parents of this node.

◆ getOrCreateStateSet()

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.

◆ getParent() [1/2]

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

◆ getParent() [2/2]

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.

◆ getParentalNodePaths()

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 specified node.

◆ getParents() [1/2]

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.

◆ getParents() [2/2]

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

Get the parent list of node.

◆ getStateSet() [1/2]

osg::StateSet * osg::Node::getStateSet ( )
inline

Return the node's StateSet. returns NULL if a stateset is not attached.

◆ getStateSet() [2/2]

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

Return the node's const StateSet. Returns NULL if a stateset is not attached.

◆ getUpdateCallback() [1/2]

Callback * osg::Node::getUpdateCallback ( )
inline

Get update node callback, called during update traversal.

◆ getUpdateCallback() [2/2]

const Callback * osg::Node::getUpdateCallback ( ) const
inline

Get const update node callback, called during update traversal.

◆ getWorldMatrices()

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 specified node.

◆ isCullingActive()

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.

◆ isSameKindAs()

virtual bool osg::Node::isSameKindAs ( const Object obj) const
inlinevirtual

◆ libraryName()

virtual const char * osg::Node::libraryName ( ) const
inlinevirtual

◆ releaseGLObjects()

virtual void osg::Node::releaseGLObjects ( osg::State = 0) const
virtual

◆ removeCullCallback() [1/2]

void osg::Node::removeCullCallback ( Callback 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.

◆ removeCullCallback() [2/2]

template<class T >
void osg::Node::removeCullCallback ( const ref_ptr< T > &  nc)
inline

◆ removeEventCallback() [1/2]

void osg::Node::removeEventCallback ( Callback 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.

◆ removeEventCallback() [2/2]

template<class T >
void osg::Node::removeEventCallback ( const ref_ptr< T > &  nc)
inline

◆ removeParent()

void osg::Node::removeParent ( osg::Group parent)
protected

◆ removeUpdateCallback() [1/2]

void osg::Node::removeUpdateCallback ( Callback 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.

◆ removeUpdateCallback() [2/2]

template<class T >
void osg::Node::removeUpdateCallback ( const ref_ptr< T > &  nc)
inline

◆ resizeGLObjectBuffers()

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

◆ setComputeBoundingSphereCallback() [1/2]

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

Set the compute bound callback to override the default computeBound.

◆ setComputeBoundingSphereCallback() [2/2]

template<class T >
void osg::Node::setComputeBoundingSphereCallback ( const ref_ptr< T > &  callback)
inline

◆ setCullCallback() [1/2]

void osg::Node::setCullCallback ( Callback nc)
inline

Set cull node callback, called during cull traversal.

◆ setCullCallback() [2/2]

template<class T >
void osg::Node::setCullCallback ( const ref_ptr< T > &  nc)
inline

◆ setCullingActive()

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.

◆ setDescriptions()

void osg::Node::setDescriptions ( const DescriptionList descriptions)

Set the list of string descriptions.

◆ setEventCallback() [1/2]

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

Set event node callback, called during event traversal.

◆ setEventCallback() [2/2]

template<class T >
void osg::Node::setEventCallback ( const ref_ptr< T > &  nc)
inline

◆ setInitialBound()

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

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

◆ setNodeMask()

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

Set the node mask.

◆ setNumChildrenRequiringEventTraversal()

void osg::Node::setNumChildrenRequiringEventTraversal ( unsigned int  num)
protected

◆ setNumChildrenRequiringUpdateTraversal()

void osg::Node::setNumChildrenRequiringUpdateTraversal ( unsigned int  num)
protected

◆ setNumChildrenWithCullingDisabled()

void osg::Node::setNumChildrenWithCullingDisabled ( unsigned int  num)
protected

◆ setNumChildrenWithOccluderNodes()

void osg::Node::setNumChildrenWithOccluderNodes ( unsigned int  num)
protected

◆ setStateSet() [1/2]

template<class T >
void osg::Node::setStateSet ( const osg::ref_ptr< T > &  stateset)
inline

◆ setStateSet() [2/2]

void osg::Node::setStateSet ( osg::StateSet stateset)

Set the node's StateSet.

◆ setThreadSafeRefUnref()

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::Object.

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

◆ setUpdateCallback() [1/2]

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

Set update node callback, called during update traversal.

◆ setUpdateCallback() [2/2]

template<class T >
void osg::Node::setUpdateCallback ( const ref_ptr< T > &  nc)
inline

◆ traverse()

virtual void osg::Node::traverse ( NodeVisitor )
inlinevirtual

Friends And Related Symbol Documentation

◆ osg::Drawable

friend class osg::Drawable
friend

◆ osg::Group

friend class osg::Group
friend

◆ osg::StateSet

friend class osg::StateSet
friend

Member Data Documentation

◆ _boundingSphere

BoundingSphere osg::Node::_boundingSphere
mutableprotected

◆ _boundingSphereComputed

bool osg::Node::_boundingSphereComputed
mutableprotected

◆ _computeBoundCallback

ref_ptr<ComputeBoundingSphereCallback> osg::Node::_computeBoundCallback
protected

◆ _cullCallback

ref_ptr<Callback> osg::Node::_cullCallback
protected

◆ _cullingActive

bool osg::Node::_cullingActive
protected

◆ _eventCallback

ref_ptr<Callback> osg::Node::_eventCallback
protected

◆ _initialBound

BoundingSphere osg::Node::_initialBound
protected

◆ _nodeMask

NodeMask osg::Node::_nodeMask
protected

◆ _numChildrenRequiringEventTraversal

unsigned int osg::Node::_numChildrenRequiringEventTraversal
protected

◆ _numChildrenRequiringUpdateTraversal

unsigned int osg::Node::_numChildrenRequiringUpdateTraversal
protected

◆ _numChildrenWithCullingDisabled

unsigned int osg::Node::_numChildrenWithCullingDisabled
protected

◆ _numChildrenWithOccluderNodes

unsigned int osg::Node::_numChildrenWithOccluderNodes
protected

◆ _parents

ParentList osg::Node::_parents
protected

◆ _stateset

ref_ptr<StateSet> osg::Node::_stateset
protected

◆ _updateCallback

ref_ptr<Callback> osg::Node::_updateCallback
protected

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