Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::OctreeNode Class Reference

#include <itkOctreeNode.h>

Collaboration diagram for itk::OctreeNode:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OctreeNode (void)
virtual ~OctreeNode (void)
OctreeNodeGetChild (const enum LeafIdentifier ChildID) const
OctreeNodeGetChild (const enum LeafIdentifier ChildID)
int GetColor (void) const
void SetColor (int NodeColor)
void SetBranch (OctreeNodeBranch *NewBranch)
bool IsNodeColored (void) const
void SetParentOctree (OctreeBase *parent)

Detailed Description

OctreeNode data structure, OctreeNodes have two states: 1) They are a Colored node and the m_Branch is a sentinal value indicating the color, or 2) they are a branch node, and m_Branch is a dynamically allocated array of 8 pointers to OctreeNodes. In the second state, the 8 child OctreeNodes are instantiated by the parent node.
Author:
Hans J. Johnson This class is the basic building block of an octree. It is rarely used by itself, and commonly used by the Octree class.

Definition at line 27 of file itkOctreeNode.h.


Constructor & Destructor Documentation

itk::OctreeNode::OctreeNode void   ) 
 

Default constructor

Author:
Hans J. Johnson
Postcondition:
After construction, it is assumed all children of this node are colored with values of 0.

virtual itk::OctreeNode::~OctreeNode void   )  [virtual]
 

Default destructor

Author:
Hans J. Johnson


Member Function Documentation

OctreeNode& itk::OctreeNode::GetChild const enum LeafIdentifier  ChildID  ) 
 

OctreeNode& itk::OctreeNode::GetChild const enum LeafIdentifier  ChildID  )  const
 

Returns the value of the specified Child for for this OctreeNode

Author:
Hans J. Johnson
Parameters:
ChildID The numerical identifier of the desired child.
Returns:
A pointer to the Disired child. NOTE: This is always an instance of an OctreeNode.

int itk::OctreeNode::GetColor void   )  const
 

Determines the color value of the specified Child for for this OctreeNode

Author:
Hans J. Johnson
Parameters:
ChildID The numerical identifier of the desired child.
Returns:
A value between 0 and 255 to indicate the color of the Disired child.
Precondition:
Must determine that the specified node is colored (Use IsNodeColored() member function. Behavior is undefined when the child is another Octree.

bool itk::OctreeNode::IsNodeColored void   )  const
 

Determines if the child is a leaf node (colored), or a branch node (uncolored)

Author:
Hans J. Johnson
Parameters:
ChildID The numerical identifier of the desired child.
Returns:
true if it is colored, false if it is not

void itk::OctreeNode::SetBranch OctreeNodeBranch NewBranch  ) 
 

Sets the color value of the specified Child for for this OctreeNode

Author:
Hans J. Johnson
Parameters:
ChildID The numerical identifier of the desired child.
NodeColor The disired color of this node.
Postcondition:
All children of the specified child are removed, and the child is set to the desired value.

void itk::OctreeNode::SetColor int  NodeColor  ) 
 

Sets the color value of the specified Child for for this OctreeNode

Author:
Hans J. Johnson
Parameters:
ChildID The numerical identifier of the desired child.
NodeColor The disired color of this node.
Postcondition:
All children of the specified child are removed, and the child is set to the desired value.

void itk::OctreeNode::SetParentOctree OctreeBase parent  )  [inline]
 

Definition at line 95 of file itkOctreeNode.h.


The documentation for this class was generated from the following file:
Generated at Thu May 25 01:59:35 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000