FlowVis.Data.TreeNode Class Reference

Node used for the quadtree partioning the geometry grid. More...

List of all members.

Public Member Functions

 TreeNode (Math.Vector3f boundaryMin, Math.Vector3f boundaryMax, Math.Vector2i iMin, Math.Vector2i iMax)
 Constructor defines node with the passed parameters. Children list is empty.
void SetChildren (TreeNode lt, TreeNode rt, TreeNode lb, TreeNode rb)
 Defines the children of this node.
Math.Vector3f GetBoundaryCenter ()
 Calculates the center of this nodes boundary.
Math.Vector2i GetIndexCenter ()
 Calculates the center of this nodes indices.
Math.Vector3f GetBoundaryMin ()
 returns the minimum position stored in this node
Math.Vector3f GetBoundaryMax ()
 returns the maximum position stored in this node
bool ContainsPosition (Math.Vector3f position)
 Checks if the position lies within the area of this tree node.
TreeNode GetSmallestNode (Math.Vector3f position)
 Traverses all children and returns the smallest node containing the position.
LinkedList< Math.Vector2iGetGridCoordinates ()
 Returns a list of all grid cells which belong to this quadtree node.

Properties

Math.Vector2i IndexMin [get, set]
 Get or set the minimum index of this node.
Math.Vector2i IndexMax [get, set]
 Get or set the maximum index of this node.
Math.Vector3f BoundarySize [get]
 Returns the boundary size of this node (maximum boundary - minimum boundary).


Detailed Description

Node used for the quadtree partioning the geometry grid.


Constructor & Destructor Documentation

FlowVis.Data.TreeNode.TreeNode ( Math.Vector3f  boundaryMin,
Math.Vector3f  boundaryMax,
Math.Vector2i  iMin,
Math.Vector2i  iMax 
)

Constructor defines node with the passed parameters. Children list is empty.

Parameters:
boundaryMin miminum boundary of quad
boundaryMax maximum boundary of quad
iMin index of minimum grid cell
iMax index of maximum grid cell


Member Function Documentation

void FlowVis.Data.TreeNode.SetChildren ( TreeNode  lt,
TreeNode  rt,
TreeNode  lb,
TreeNode  rb 
)

Defines the children of this node.

Parameters:
lt child at left top position
rt child at right top position
lb child at left bottom position
rb child at right bottom position

Math.Vector3f FlowVis.Data.TreeNode.GetBoundaryCenter (  ) 

Calculates the center of this nodes boundary.

Returns:
center between minimum boundary and maximum boundary

Math.Vector2i FlowVis.Data.TreeNode.GetIndexCenter (  ) 

Calculates the center of this nodes indices.

Returns:
center between minimum cell index and maximum cell index

Math.Vector3f FlowVis.Data.TreeNode.GetBoundaryMin (  ) 

returns the minimum position stored in this node

Returns:
minimum boundary

Math.Vector3f FlowVis.Data.TreeNode.GetBoundaryMax (  ) 

returns the maximum position stored in this node

Returns:
maximum boundary

bool FlowVis.Data.TreeNode.ContainsPosition ( Math.Vector3f  position  ) 

Checks if the position lies within the area of this tree node.

Parameters:
position position which is searched for in the quad
Returns:
true if the position is within the minimum boundary and the maximum boundary

TreeNode FlowVis.Data.TreeNode.GetSmallestNode ( Math.Vector3f  position  ) 

Traverses all children and returns the smallest node containing the position.

Parameters:
position position for which the quad tree should be traversed
Returns:
finest level node containing the positon

LinkedList<Math.Vector2i> FlowVis.Data.TreeNode.GetGridCoordinates (  ) 

Returns a list of all grid cells which belong to this quadtree node.

Returns:
list of all grid cell coordinates which belong to this tree node


Property Documentation

Math.Vector2i FlowVis.Data.TreeNode.IndexMin [get, set]

Get or set the minimum index of this node.

Returns:
index of minimum cell

Math.Vector2i FlowVis.Data.TreeNode.IndexMax [get, set]

Get or set the maximum index of this node.

Returns:
index of maximum cell

Math.Vector3f FlowVis.Data.TreeNode.BoundarySize [get]

Returns the boundary size of this node (maximum boundary - minimum boundary).


The documentation for this class was generated from the following file:
Generated on Mon Jan 21 16:09:36 2008 for FlowVis by  doxygen 1.5.1-p1