class SG_EXPORT osg::Node

class SG_EXPORT osg::Node: public Object

Base class for all internal nodes in the scene graph.

Inheritance:

Public Methods
Node(): Construct a node.
virtual Object* clone() const: return a shallow copy of a node, with Object* return type
Node* cloneNode() const: return a shallow copy of a node, with Node* return type
virtual bool isSameKindAs(Object* obj): return true if this and obj are of the same kind of object
virtual const char* className() const: return the name of the node's class type
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
void setName( const std::string& name ): Set the name of node using C++ style string
void setName( const char* name ): Set the name of node using a C style string
const std::string& getName( void ): Get the name of node
const ParentList& getParents() const: Get the parent list of node.
Group* getParent(int i) const: Get a single parent of node.
int getNumParents() const: Get the number of parents of node.
void setUserData(void* data, MemoryAdapter* ma=0L): Set user data.
void* getUserData() const: Get user data
MemoryAdapter* getMemoryAdapter() const: Get the memory adapter associated with _userData
void setNodeMask(NodeMask nm): Set the node mask.
NodeMask getNodeMask(): Get the node Mask.
const DescriptionList& getDescriptions() const: Get the description list of the const node
DescriptionList& getDescriptions(): Get the description list of the const node
const std::string& getDescription(int i) const: Get a single const description of the const node
std::string& getDescription(int i): Get a single description of the node
int getNumDescriptions() const: Get the number of descriptions of the node
void addDescription(const std::string& desc): Add a description string to the node
const BoundingSphere& getBound(): get the bounding sphere of node.
void dirtyBound(): Mark this node's bounding sphere dirty.

Public
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

Protected Fields
BoundingSphere _bsphere
bool _bsphere_computed
std::string _name
ParentList _parents
friend Group
void* _userData
ref_ptr<MemoryAdapter> _memoryAdapter
NodeMask _nodeMask
DescriptionList _descriptions

Protected Methods
virtual ~Node(): Node destructor.
virtual bool readLocalData(Input& fr): Template Method Pattern : read local data from osg file.
virtual bool writeLocalData(Output& fw): Template Method Pattern : read local data from osg file.
virtual bool computeBound( void ): Compute the bounding sphere around Node's geometry or children.

Inherited from Object:

Public Methods
virtual Object* readClone(Input& fr)
virtual bool write(Output& fw)

Inherited from Referenced:

Public Methods
Referenced& operator = (Referenced&)
void ref()
void unref()
int referenceCount()

Protected Fields
int _refCount

Documentation

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

Node()

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

virtual Object* clone() const

return a shallow copy of a node, with Object* return type

Node* cloneNode() const

return a shallow copy of a node, with Node* return type

virtual bool isSameKindAs(Object* obj)

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

virtual const char* className() const

return the name of the node's class type

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

void setName( const std::string& name )

Set the name of node using C++ style string

void setName( const char* name )

Set the name of node using a C style string

const std::string& getName( void )

Get the name of node

typedef std::vector<Group*> ParentList

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

const ParentList& getParents() const

Get the parent list of node.

Group* getParent(int i) const

Get a single parent of node.


Parameters:: i - index of the parent to get.
Returns:: the parent i.

int getNumParents() const

Get the number of parents of node.


Returns:: the number of parents of this node.

void setUserData(void* data, MemoryAdapter* ma=0L)

Set user data. See MemoryAdapter documention for details of how to specify memory managament of _userData.

void* getUserData() const

Get user data

MemoryAdapter* getMemoryAdapter() const

Get the memory adapter associated with _userData

typedef unsigned int NodeMask

void setNodeMask(NodeMask nm)

Set the node mask. Note, node mask is will be replaced by TraversalMask.

NodeMask getNodeMask()

Get the node Mask. Note, node mask is will be replaced by TraversalMask.

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

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

const DescriptionList& getDescriptions() const

Get the description list of the const node

DescriptionList& getDescriptions()

Get the description list of the const node

const std::string& getDescription(int i) const

Get a single const description of the const node

std::string& getDescription(int i)

Get a single description of the node

int getNumDescriptions() const

Get the number of descriptions of the node

void addDescription(const std::string& desc)

Add a description string to the node

const BoundingSphere& getBound()

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

void dirtyBound()

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

virtual ~Node()

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 Node's 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 bool readLocalData(Input& fr)

Template Method Pattern : read local data from osg file. Note should be implemented in derived classes, which call their parent class's readLocalData.


Returns:: true if the input iterator has been advanced, otherwise false.

virtual bool writeLocalData(Output& fw)

Template Method Pattern : read local data from osg file. Note should be implemented in derivied classes, which call their parent class's writeLocalData.