List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
SMESH_Tree< BND_BOX, NB_CHILDREN > Class Template Referenceabstract

Base class for 2D and 3D trees. More...

#include <SMESH_tree.hxx>

Public Types

typedef BND_BOX box_type
 

Public Member Functions

void compute ()
 Compute the Tree. More...
 
const box_type * getBox () const
 
int getHeight (const bool full=true) const
 Return height of the tree, full or from this level to topest leaf. More...
 
bool isLeaf () const
 Tell if Tree is a leaf or not An inheriting class can influence it via myIsLeaf protected field. More...
 
int level () const
 
virtual double maxSize () const =0
 
 SMESH_Tree (SMESH_TreeLimit *limit=0)
 
virtual ~SMESH_Tree ()
 SMESH_Tree Destructor. More...
 

Static Public Member Functions

static int nbChildren ()
 

Protected Member Functions

void buildChildren ()
 Build the children boxes and call buildChildrenData() More...
 
virtual void buildChildrenData ()=0
 
virtual box_type * buildRootBox ()=0
 
virtual SMESH_Tree * newChild () const =0
 
virtual box_type * newChildBox (int childIndex) const =0
 

Protected Attributes

box_type * myBox
 
SMESH_Tree ** myChildren
 
SMESH_Tree * myFather
 
bool myIsLeaf
 
int myLevel
 
const SMESH_TreeLimit * myLimit
 

Detailed Description

template<class BND_BOX, int NB_CHILDREN>
class SMESH_Tree< BND_BOX, NB_CHILDREN >

Base class for 2D and 3D trees.

Member Typedef Documentation

◆ box_type

template<class BND_BOX , int NB_CHILDREN>
typedef BND_BOX SMESH_Tree< BND_BOX, NB_CHILDREN >::box_type

Constructor & Destructor Documentation

◆ SMESH_Tree()

template<class BND_BOX , int NB_CHILDREN>
SMESH_Tree< BND_BOX, NB_CHILDREN >::SMESH_Tree ( SMESH_TreeLimit *  limit = 0)

Constructor. limit must be provided at tree root construction. limit will be deleted by SMESH_Tree.

◆ ~SMESH_Tree()

template<class BND_BOX , int NB_CHILDREN>
SMESH_Tree< BND_BOX, NB_CHILDREN >::~SMESH_Tree
virtual

SMESH_Tree Destructor.

Member Function Documentation

◆ buildChildren()

template<class BND_BOX , int NB_CHILDREN>
void SMESH_Tree< BND_BOX, NB_CHILDREN >::buildChildren
protected

Build the children boxes and call buildChildrenData()

References SMESH_Tree< BND_BOX, NB_CHILDREN >::maxSize(), SMESH_Tree< BND_BOX, NB_CHILDREN >::myFather, and SMESH_Tree< BND_BOX, NB_CHILDREN >::myLevel.

◆ buildChildrenData()

template<class BND_BOX , int NB_CHILDREN>
virtual void SMESH_Tree< BND_BOX, NB_CHILDREN >::buildChildrenData ( )
protectedpure virtual

Implemented in SMESH_OctreeNode, and VISCOUS_2D::_SegmentTree.

◆ buildRootBox()

template<class BND_BOX , int NB_CHILDREN>
virtual box_type * SMESH_Tree< BND_BOX, NB_CHILDREN >::buildRootBox ( )
protectedpure virtual

Implemented in SMESH_OctreeNode, and VISCOUS_2D::_SegmentTree.

◆ compute()

template<class BND_BOX , int NB_CHILDREN>
void SMESH_Tree< BND_BOX, NB_CHILDREN >::compute

Compute the Tree.

◆ getBox()

template<class BND_BOX , int NB_CHILDREN>
const box_type * SMESH_Tree< BND_BOX, NB_CHILDREN >::getBox ( ) const

References SMESH_Tree< BND_BOX, NB_CHILDREN >::myBox.

Referenced by SMESH_NodeSearcherImpl::FindClosestTo().

◆ getHeight()

template<class BND_BOX , int NB_CHILDREN>
int SMESH_Tree< BND_BOX, NB_CHILDREN >::getHeight ( const bool  full = true) const

Return height of the tree, full or from this level to topest leaf.

◆ isLeaf()

template<class BND_BOX , int NB_CHILDREN>
bool SMESH_Tree< BND_BOX, NB_CHILDREN >::isLeaf

Tell if Tree is a leaf or not An inheriting class can influence it via myIsLeaf protected field.

Referenced by SMESH_NodeSearcherImpl::FindClosestTo(), and SMESH_NodeSearcherImpl::SMESH_NodeSearcherImpl().

◆ level()

template<class BND_BOX , int NB_CHILDREN>
int SMESH_Tree< BND_BOX, NB_CHILDREN >::level ( ) const

References SMESH_Tree< BND_BOX, NB_CHILDREN >::myLevel.

◆ maxSize()

template<class BND_BOX , int NB_CHILDREN>
virtual double SMESH_Tree< BND_BOX, NB_CHILDREN >::maxSize ( ) const
pure virtual

Implemented in SMESH_Octree, and SMESH_Quadtree.

Referenced by SMESH_Tree< BND_BOX, NB_CHILDREN >::buildChildren().

◆ nbChildren()

template<class BND_BOX , int NB_CHILDREN>
static int SMESH_Tree< BND_BOX, NB_CHILDREN >::nbChildren ( )
static

◆ newChild()

template<class BND_BOX , int NB_CHILDREN>
virtual SMESH_Tree * SMESH_Tree< BND_BOX, NB_CHILDREN >::newChild ( ) const
protectedpure virtual

Implemented in SMESH_OctreeNode, and VISCOUS_2D::_SegmentTree.

◆ newChildBox()

template<class BND_BOX , int NB_CHILDREN>
virtual box_type * SMESH_Tree< BND_BOX, NB_CHILDREN >::newChildBox ( int  childIndex) const
protectedpure virtual

Implemented in SMESH_Octree, and SMESH_Quadtree.

Member Data Documentation

◆ myBox

template<class BND_BOX , int NB_CHILDREN>
box_type* SMESH_Tree< BND_BOX, NB_CHILDREN >::myBox
protected

Referenced by SMESH_Tree< BND_BOX, NB_CHILDREN >::getBox().

◆ myChildren

template<class BND_BOX , int NB_CHILDREN>
SMESH_Tree** SMESH_Tree< BND_BOX, NB_CHILDREN >::myChildren
protected

◆ myFather

template<class BND_BOX , int NB_CHILDREN>
SMESH_Tree* SMESH_Tree< BND_BOX, NB_CHILDREN >::myFather
protected

Referenced by SMESH_Tree< BND_BOX, NB_CHILDREN >::buildChildren().

◆ myIsLeaf

template<class BND_BOX , int NB_CHILDREN>
bool SMESH_Tree< BND_BOX, NB_CHILDREN >::myIsLeaf
protected

Referenced by SMESH_OctreeNode::buildChildrenData(), and VISCOUS_2D::_SegmentTree::buildChildrenData().

◆ myLevel

template<class BND_BOX , int NB_CHILDREN>
int SMESH_Tree< BND_BOX, NB_CHILDREN >::myLevel
protected

Referenced by SMESH_Tree< BND_BOX, NB_CHILDREN >::buildChildren(), and SMESH_Tree< BND_BOX, NB_CHILDREN >::level().

◆ myLimit

template<class BND_BOX , int NB_CHILDREN>
const SMESH_TreeLimit* SMESH_Tree< BND_BOX, NB_CHILDREN >::myLimit
protected
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.4