sofa::core::objectmodel::BaseNode Class Reference

#include <BaseNode.h>

Inheritance diagram for sofa::core::objectmodel::BaseNode:

[legend]

Collaboration diagram for sofa::core::objectmodel::BaseNode:

[legend]

---

Detailed Description

Base class for simulation nodes.

A Node is a class defining the main scene data structure of a simulation. It defined hierarchical relations between elements. Each node can have parent and child nodes (potentially defining a tree), as well as attached objects (the leaves of the tree).

Author:

Jeremie Allard

Definition at line 51 of file BaseNode.h.

Public Member Functions
virtual	~BaseNode ()
Scene hierarchy
virtual BaseNode *	getParent ()=0
	Get parent node (or NULL if no hierarchy or for root node).
virtual const BaseNode *	getParent () const =0
	Get parent node (or NULL if no hierarchy or for root node).
virtual void	addChild (BaseNode *node)=0
	Add a child node.
virtual void	removeChild (BaseNode *node)=0
	Remove a child node.
virtual bool	addObject (BaseObject *obj)=0
	Add a generic object.
virtual bool	removeObject (BaseObject *obj)=0
	Remove a generic object.
virtual BaseContext *	getContext ()=0
	Get this node context.
virtual const BaseContext *	getContext () const =0
	Get this node context.

---

Constructor & Destructor Documentation

virtual sofa::core::objectmodel::BaseNode::~BaseNode

(

)

[inline, virtual]

Definition at line 54 of file BaseNode.h.

---

Member Function Documentation

virtual BaseNode* sofa::core::objectmodel::BaseNode::getParent

(

)

[pure virtual]

Get parent node (or NULL if no hierarchy or for root node).

Implemented in sofa::simulation::tree::GNode.

Referenced by sofa::core::objectmodel::DetachNodeEvent::contains(), and sofa::component::collision::DefaultCollisionGroupManager::createGroups().

virtual const BaseNode* sofa::core::objectmodel::BaseNode::getParent

(

)

const [pure virtual]

Get parent node (or NULL if no hierarchy or for root node).

Implemented in sofa::simulation::tree::GNode.

virtual void sofa::core::objectmodel::BaseNode::addChild

(

BaseNode *

node

)

[pure virtual]

Add a child node.

Implemented in sofa::simulation::tree::GNode.

virtual void sofa::core::objectmodel::BaseNode::removeChild

(

BaseNode *

node

)

[pure virtual]

Remove a child node.

Implemented in sofa::simulation::tree::GNode.

Referenced by sofa::gui::qt::RealGUI::graphRemoveObject(), and sofa::simulation::tree::Simulation::unload().

virtual bool sofa::core::objectmodel::BaseNode::addObject

(

BaseObject *

obj

)

[pure virtual]

Add a generic object.

Implemented in sofa::simulation::tree::GNode.

virtual bool sofa::core::objectmodel::BaseNode::removeObject

(

BaseObject *

obj

)

[pure virtual]

Remove a generic object.

Implemented in sofa::simulation::tree::GNode.

virtual BaseContext* sofa::core::objectmodel::BaseNode::getContext

(

)

[pure virtual]

Get this node context.

Implemented in sofa::simulation::tree::GNode.

virtual const BaseContext* sofa::core::objectmodel::BaseNode::getContext

(

)

const [pure virtual]

Get this node context.

Implemented in sofa::simulation::tree::GNode.

---

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

• framework/sofa/core/objectmodel/BaseNode.h

---