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

Inheritance diagram for osg::Node:

[legend]

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. More...

typedef unsigned int	NodeMask
	This is a set of bits (flags) that represent the Node. More...

typedef std::vector< std::string >	DescriptionList
	A vector of std::string's which are used to describe the object. More...

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
	Node ()
	Construct a node. More...

	Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

virtual Object *	cloneType () const
	clone an object of the same type as the node. More...

virtual Object *	clone (const CopyOp &copyop) const
	return a clone of a node, with Object* return type. More...

virtual bool	isSameKindAs (const Object *obj) const
	return true if this and obj are of the same kind of object. More...

virtual const char *	libraryName () const
	return the name of the node's library. More...

virtual const char *	className () const
	return the name of the node's class type. More...

virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual Drawable *	asDrawable ()
	convert 'this' into a Drawable pointer if Node is a Drawable, otherwise return 0. More...

virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Node is a Drawable, otherwise return 0. More...

virtual Geometry *	asGeometry ()
	convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0. More...

virtual const Geometry *	asGeometry () const
	convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0. More...

virtual Group *	asGroup ()
	convert 'this' into a Group pointer if Node is a Group, otherwise return 0. More...

virtual const Group *	asGroup () const
	convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. More...

virtual Transform *	asTransform ()
	Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. More...

virtual const Transform *	asTransform () const
	convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. More...

virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...

virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...

virtual Switch *	asSwitch ()
	Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0. More...

virtual const Switch *	asSwitch () const
	convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0. More...

virtual Geode *	asGeode ()
	Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0. More...

virtual const Geode *	asGeode () const
	convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0. More...

virtual osgTerrain::Terrain *	asTerrain ()
	Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. More...

virtual const osgTerrain::Terrain *	asTerrain () const
	convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. More...

virtual void	accept (NodeVisitor &nv)
	Visitor Pattern : calls the apply method of a NodeVisitor with this node's type. More...

virtual void	ascend (NodeVisitor &nv)
	Traverse upwards : calls parents' accept method with NodeVisitor. More...

virtual void	traverse (NodeVisitor &)
	Traverse downwards : calls children's accept method with NodeVisitor. More...

const ParentList &	getParents () const
	Get the parent list of node. More...

ParentList	getParents ()
	Get the a copy of parent list of node. More...

Group *	getParent (unsigned int i)

const Group *	getParent (unsigned int i) const
	Get a single const parent of node. More...

unsigned int	getNumParents () const
	Get the number of parents of node. More...

NodePathList	getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
	Get the list of node paths parent paths. More...

MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
	Get the list of matrices that transform this node from local coordinates to world coordinates. More...

void	setUpdateCallback (Callback *nc)
	Set update node callback, called during update traversal. More...

template<class T >
void	setUpdateCallback (const ref_ptr< T > &nc)

Callback *	getUpdateCallback ()
	Get update node callback, called during update traversal. More...

const Callback *	getUpdateCallback () const
	Get const update node callback, called during update traversal. More...

void	addUpdateCallback (Callback *nc)
	Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one. More...

template<class T >
void	addUpdateCallback (const ref_ptr< T > &nc)

void	removeUpdateCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

template<class T >
void	removeUpdateCallback (const ref_ptr< T > &nc)

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. More...

void	setEventCallback (Callback *nc)
	Set event node callback, called during event traversal. More...

template<class T >
void	setEventCallback (const ref_ptr< T > &nc)

Callback *	getEventCallback ()
	Get event node callback, called during event traversal. More...

const Callback *	getEventCallback () const
	Get const event node callback, called during event traversal. More...

void	addEventCallback (Callback *nc)
	Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one. More...

template<class T >
void	addEventCallback (const ref_ptr< T > &nc)

void	removeEventCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

template<class T >
void	removeEventCallback (const ref_ptr< T > &nc)

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. More...

void	setCullCallback (Callback *nc)
	Set cull node callback, called during cull traversal. More...

template<class T >
void	setCullCallback (const ref_ptr< T > &nc)

Callback *	getCullCallback ()
	Get cull node callback, called during cull traversal. More...

const Callback *	getCullCallback () const
	Get const cull node callback, called during cull traversal. More...

void	addCullCallback (Callback *nc)
	Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one. More...

template<class T >
void	addCullCallback (const ref_ptr< T > &nc)

void	removeCullCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

template<class T >
void	removeCullCallback (const ref_ptr< T > &nc)

void	setCullingActive (bool active)
	Set the view frustum/small feature culling of this node to be active or inactive. More...

bool	getCullingActive () const
	Get the view frustum/small feature _cullingActive flag for this node. More...

unsigned int	getNumChildrenWithCullingDisabled () const
	Get the number of Children of this node which have culling disabled. More...

bool	isCullingActive () const
	Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. More...

unsigned int	getNumChildrenWithOccluderNodes () const
	Get the number of Children of this node which are or have OccluderNode's. More...

bool	containsOccluderNodes () const
	return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes. More...

void	setNodeMask (NodeMask nm)
	Set the node mask. More...

NodeMask	getNodeMask () const
	Get the node Mask. More...

void	setStateSet (osg::StateSet *stateset)
	Set the node's StateSet. More...

template<class T >
void	setStateSet (const osg::ref_ptr< T > &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. More...

osg::StateSet *	getStateSet ()
	Return the node's StateSet. More...

const osg::StateSet *	getStateSet () const
	Return the node's const StateSet. More...

void	setDescriptions (const DescriptionList &descriptions)
	Set the list of string descriptions. More...

DescriptionList &	getDescriptions ()
	Get the description list of the node. More...

const DescriptionList &	getDescriptions () const
	Get the const description list of the const node. More...

const std::string &	getDescription (unsigned int i) const
	Get a single const description of the const node. More...

std::string &	getDescription (unsigned int i)
	Get a single description of the node. More...

unsigned int	getNumDescriptions () const
	Get the number of descriptions of the node. More...

void	addDescription (const std::string &desc)
	Add a description string to the node. More...

void	setInitialBound (const osg::BoundingSphere &bsphere)
	Set the initial bounding volume to use when computing the overall bounding volume. More...

const BoundingSphere &	getInitialBound () const
	Set the initial bounding volume to use when computing the overall bounding volume. More...

void	dirtyBound ()
	Mark this node's bounding sphere dirty. More...

const BoundingSphere &	getBound () const

virtual BoundingSphere	computeBound () const
	Compute the bounding sphere around Node's geometry or children. More...

void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
	Set the compute bound callback to override the default computeBound. More...

template<class T >
void	setComputeBoundingSphereCallback (const ref_ptr< T > &callback)

ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()
	Get the compute bound callback. More...

const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const
	Get the const compute bound callback. More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...

virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...

Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...

	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. More...

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...

void	setName (const char *name)
	Set the name of object using a C style string. More...

const std::string &	getName () const
	Get the name of object. More...

void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...

DataVariance	getDataVariance () const
	Get the data variance of this object. More...

virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...

void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience 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. More...

virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...

template<class T >
void	setUserData (const ref_ptr< T > &ud)

virtual Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () const
	Get const user data. More...

template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...

template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template More...

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Protected Member Functions
virtual	~Node ()
	Node destructor. More...

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 ()
	Object destructor. More...

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::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

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

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.

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 ( )

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

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::ParticleProcessor, osgParticle::Program, osgParticle::Emitter, osgParticle::ParticleEffect, osg::AutoTransform, and osgParticle::PrecipitationEffect.

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.

template<class T >

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

inline

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

Add a description string to the node.

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.

template<class T >

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

inline

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

protected

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.

template<class T >

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

inline

virtual Camera* osg::Node::asCamera ( )

inlinevirtual

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

Equivalent to dynamic_cast<Camera*>(this).

Reimplemented in osg::Camera.

virtual const Camera* osg::Node::asCamera ( ) const

inlinevirtual

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

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

Reimplemented in osg::Camera.

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

virtual

Traverse upwards : calls parents' accept method with NodeVisitor.

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 in osg::Drawable.

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 in osg::Drawable.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

inlinevirtual

return the name of the node's class type.

Implements osg::Object.

Reimplemented in osgShadow::ShadowVolumeGeometry, osg::ShapeDrawable, osgFX::Effect, osgAnimation::MorphGeometry, osgSim::ImpostorSprite, osgParticle::ParticleProcessor, osgShadow::OccluderGeometry, osgManipulator::AntiSquish, osgParticle::Program, osg::DrawPixels, osgParticle::Emitter, osgParticle::ParticleEffect, osg::AutoTransform, osgText::Text, osgParticle::PrecipitationEffect, and osgText::TextBase.

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 osgShadow::ShadowVolumeGeometry, osg::ShapeDrawable, osgAnimation::MorphGeometry, osgSim::ImpostorSprite, osgShadow::OccluderGeometry, osgManipulator::AntiSquish, osg::DrawPixels, osg::AutoTransform, and osgText::Text.

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

inlinevirtual

clone an object of the same type as the node.

Implements osg::Object.

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

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 osgTerrain::TerrainTile, osg::Group, osg::Drawable, osg::Transform, osg::Geode, osgParticle::ParticleProcessor, osgVolume::VolumeTile, osg::LOD, osg::ProxyNode, osg::OcclusionQueryNode, osg::AutoTransform, osgSim::Impostor, osg::Billboard, osg::ClipNode, osgSim::LightPointNode, osg::Switch, osg::LightSource, osgParticle::ParticleSystemUpdater, osgGA::Widget, and osg::OccluderNode.

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

ComputeBoundingSphereCallback* osg::Node::getComputeBoundingSphereCallback ( )

inline

Get the compute bound callback.

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

inline

Get the const compute bound callback.

Callback* osg::Node::getCullCallback ( )

inline

Get cull node callback, called during cull traversal.

const Callback* 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

Get a single const description of the const node.

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

Get a single description of the node.

DescriptionList& osg::Node::getDescriptions ( )

Get the description list of the node.

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

Get the const description list of the const node.

Callback* osg::Node::getEventCallback ( )

inline

Get event node callback, called during event traversal.

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

inline

Get const event node callback, called during event traversal.

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

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

Get the number of descriptions of the node.

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

i	index 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.

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

inline

Get the parent list of 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.

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

inline

Return the node's StateSet.

returns NULL if a stateset is not attached.

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

inline

Return the node's const StateSet.

Returns NULL if a stateset is not attached.

Callback* osg::Node::getUpdateCallback ( )

inline

Get update node callback, called during update traversal.

const Callback* 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.

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

inlinevirtual

return true if this and obj are of the same kind of object.

Reimplemented from osg::Object.

Reimplemented in osgShadow::ShadowVolumeGeometry, osg::ShapeDrawable, osgFX::Effect, osgAnimation::MorphGeometry, osgParticle::ParticleProcessor, osgSim::ImpostorSprite, osgParticle::Program, osgShadow::OccluderGeometry, osgParticle::Emitter, osgParticle::ParticleEffect, osgManipulator::AntiSquish, osg::DrawPixels, osgParticle::PrecipitationEffect, osg::AutoTransform, osgText::Text, and osgText::TextBase.

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

inlinevirtual

return the name of the node's library.

Implements osg::Object.

Reimplemented in osgShadow::ShadowVolumeGeometry, osg::ShapeDrawable, osgFX::Effect, osgAnimation::MorphGeometry, osgSim::ImpostorSprite, osgParticle::ParticleProcessor, osgShadow::OccluderGeometry, osgManipulator::AntiSquish, osgParticle::Program, osg::DrawPixels, osgParticle::Emitter, osgParticle::ParticleEffect, osg::AutoTransform, osgText::Text, osgText::TextBase, and osgParticle::PrecipitationEffect.

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, osgText::Text, osg::Drawable, osgText::TextBase, osgTerrain::TerrainTile, osgTerrain::HeightFieldDrawable, osg::Group, osg::Geometry, osgSim::OverlayNode, osgText::Text3D, osg::OcclusionQueryNode, osg::QueryGeometry, osgTerrain::SharedGeometry, and osgShadow::ShadowedScene.

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.

template<class T >

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

inline

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.

template<class T >

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

inline

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

protected

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.

template<class T >

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

inline

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, osgText::Text, osg::Drawable, osgText::TextBase, osgTerrain::HeightFieldDrawable, osg::Group, osg::Geometry, osgSim::OverlayNode, osgText::Text3D, osgTerrain::SharedGeometry, and osgShadow::ShadowedScene.

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

inline

Set the compute bound callback to override the default computeBound.

template<class T >

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

inline

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

inline

Set cull node callback, called during cull traversal.

template<class T >

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

inline

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 )

Set the list of string descriptions.

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

Set event node callback, called during event traversal.

template<class T >

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

inline

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.

template<class T >

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

inline

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 osgText::Text, osg::Drawable, osgText::TextBase, osg::Group, osgSim::OverlayNode, osgText::Text3D, osg::LightSource, and osg::TexGenNode.

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

Set update node callback, called during update traversal.

template<class T >

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

inline

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

inlinevirtual

Traverse downwards : calls children's accept method with NodeVisitor.

Reimplemented in osgManipulator::Dragger, osgFX::Effect, osgParticle::ParticleProcessor, osgVolume::VolumeTile, osgTerrain::TerrainTile, osgParticle::ParticleSystemUpdater, osgSim::Impostor, osg::LOD, osgSim::OverlayNode, osgSim::LightPointNode, osg::Group, osg::Switch, osgSim::VisibilityGroup, osgParticle::PrecipitationEffect, osgShadow::ShadowedScene, osgTerrain::Terrain, osg::ProxyNode, osgSim::MultiSwitch, osgVolume::Volume, osgVolume::VolumeScene, osg::Sequence, osgSim::DOFTransform, osg::PagedLOD, and osgGA::Widget.

Friends And Related Function Documentation

friend class osg::Drawable

friend

friend class osg::Group

friend

friend class osg::StateSet

friend

Member Data Documentation

BoundingSphere osg::Node::_boundingSphere

mutableprotected

bool osg::Node::_boundingSphereComputed

mutableprotected

ref_ptr<ComputeBoundingSphereCallback> osg::Node::_computeBoundCallback

protected

ref_ptr<Callback> osg::Node::_cullCallback

protected

bool osg::Node::_cullingActive

protected

ref_ptr<Callback> 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<Callback> osg::Node::_updateCallback

protected

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

osg/Node

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation