eng::Graph Class Reference

Graph class. More...

#include <eng_graph.hh>

List of all members.

Public Member Functions
	Graph (void)
	~Graph ()
void	AttachRootNode (Node::Ptr rootNode)
	LIMITED-USE.
Node::Ptr	GetRootNode (void)
	LIMITED-USE.
SharedPtr< Graph >	Fork (void)
void	CloneNode (Node::Ptr node)
void	Traverse (Visitor &visitor)
void	Draw (SharedPtr< Object > object)
void	SetLod (const ObjectLod objectLod)
bool	IfMinimal (void)
bool	IfCloneNode (const Node &node) const
bool	Check (void)
Static Public Member Functions
static shptr< Graph >	MakeMinimalGraph (void)
static SharedPtr< Graph >	MakeMinimalGraph (SharedPtr< Matrix > matrix)
Static Public Attributes
static bool	msDrawWorldBoxVolume
Private Member Functions
	Graph (const Graph &src)
	Forks graph (not for clients).
void	RecursiveDetach (Node::Ptr node)
Private Attributes
Node::Ptr	mRootNode
	initially points to NULL_NODE
NodeClones	mNodeClones
	every Graph has clone of the first transform
bool	mMinimal
	necessary to produce an tiny Object BoxVolume for acceptance by BSP
Friends
class	Node
class	GraphMaker
class	VisitorCloner

---

Detailed Description

Graph class.

See design and implementation.

---

Constructor & Destructor Documentation

eng::Graph::Graph

(

void

)

ctor. Constructing an empty Graph is normal in certain cases (Eye), but rendering shouldn't encounter them.

eng::Graph::Graph

(

const Graph &

src

)

[private]

Forks graph (not for clients).

Copy ctor forks a Graph. See Graph::Fork(). Copying is done simply by making another reference to the parent's root node. Yet, a cloned Graph isn't exactly a verbatim copy. Clone Nodes (private Nodes) is where they will diverge.

eng::Graph::~Graph

(

)

dtor.

A Graph is freed in an orderly fashion: bottom-up leaf-by-leaf. Eventually every node will become a leaf and will be detached. Deleting Nodes is done implicitly by nullifying SharedPtr<Node> links so that SharedPtr will auto-delete Nodes.

---

Member Function Documentation

SharedPtr< Graph > eng::Graph::MakeMinimalGraph

(

void

)

[static]

Make a minimal-but-usable Graph for use with an Object. Object construction depends on a TransformNode being present.

static SharedPtr<Graph> eng::Graph::MakeMinimalGraph

(

SharedPtr< Matrix >

matrix

)

[static]

void eng::Graph::RecursiveDetach

(

Node::Ptr

node

)

[private]

void eng::Graph::AttachRootNode

(

Node::Ptr

rootNode

)

LIMITED-USE.

Node::Ptr eng::Graph::GetRootNode

(

void

)

LIMITED-USE.

Get root node.

SharedPtr< Graph > eng::Graph::Fork

(

void

)

Fork a Graph.

Forking a Graph is similar to forking a UNIX process. Most nodes will be shared while a few become private to every Graph.

For each node:

• If the parent's node isn't a clone, both parent and child Graphs will share it.
• If the parent's node is a clone, the child Graph will receive a private copy of it (will be recloned).

A "clone node" is a node passed to Graph::CloneNode(Node::Ptr) which turns a shared node into a private node. The clone attribute is sticky.

void eng::Graph::CloneNode

(

Node::Ptr

node

)

void eng::Graph::Traverse

(

Visitor &

visitor

)

Traverse a Graph using a Visitor. A guide is at Traversing Graphs.

 * 1. Visit node.
 * 2. If child and younger sibling exist, push younger sibling.
 * 3. If child exists, traverse to it, recurse.
 * 4. If younger sibling exists, traverse to it, recurse.
 * 5. If stack isn't empty: pop node, traverse to it.
 *    Else stop.
 * 

void eng::Graph::Draw

(

SharedPtr< Object >

object

)

void eng::Graph::SetLod

(

const ObjectLod

objectLod

)

Set the level-of-detail (ObjectLod) of this Graph.

bool eng::Graph::IfMinimal

(

void

)

[inline]

bool eng::Graph::IfCloneNode

(

const Node &

node

)

const [inline]

bool eng::Graph::Check

(

void

)

---

Friends And Related Function Documentation

friend class Node [friend]

friend class GraphMaker [friend]

friend class VisitorCloner [friend]

---

Member Data Documentation

Node::Ptr eng::Graph::mRootNode [private]

initially points to NULL_NODE

NodeClones eng::Graph::mNodeClones [private]

every Graph has clone of the first transform

bool eng::Graph::mMinimal [private]

necessary to produce an tiny Object BoxVolume for acceptance by BSP

bool eng::Graph::msDrawWorldBoxVolume [static]

---

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

• eng_graph.hh
• eng_graph.cc

Palomino 3D Engine documents generated by doxygen 1.5.3 on Fri Nov 23 11:26:21 2007