1 // Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SMESH SMESH_Tree : tree implementation
24 // File : SMESH_Tree.hxx
25 // Created : Tue Jan 16 16:00:00 2007
26 // Author : Nicolas Geimer & Aurélien Motteux (OCC)
29 #ifndef _SMESH_Tree_HXX_
30 #define _SMESH_Tree_HXX_
32 #include "SMESH_Utils.hxx"
34 //================================================================================
35 // Data limiting the tree height
36 struct SMESH_TreeLimit {
37 // MaxLevel of the Tree
39 // Minimal size of the Box
43 // maxLevel-> 8^8 = 16777216 terminal trees at most
44 // minSize -> box size not checked
45 SMESH_TreeLimit(int maxLevel=8, double minSize=0.):myMaxLevel(maxLevel),myMinBoxSize(minSize) {}
46 virtual ~SMESH_TreeLimit() {} // it can be inherited
49 //================================================================================
51 * \brief Base class for 2D and 3D trees
53 //================================================================================
55 template< class BND_BOX,
61 typedef BND_BOX box_type;
63 // Constructor. limit must be provided at tree root construction.
64 // limit will be deleted by SMESH_Tree
65 SMESH_Tree (SMESH_TreeLimit* limit=0);
68 virtual ~SMESH_Tree ();
70 // Compute the Tree. Must be called by constructor of inheriting class
73 // Tell if Tree is a leaf or not.
74 // An inheriting class can influence it via myIsLeaf protected field
78 int level() const { return myLevel; }
80 // Return Bounding Box of the Tree
81 const box_type* getBox() const { return myBox; }
83 // Return height of the tree, full or from this level to topest leaf
84 int getHeight(const bool full=true) const;
86 static int nbChildren() { return NB_CHILDREN; }
88 // Compute the biggest dimension of my box
89 virtual double maxSize() const = 0;
92 // Return box of the whole tree
93 virtual box_type* buildRootBox() = 0;
96 virtual SMESH_Tree* newChild() const = 0;
98 // Allocate a bndbox according to childIndex. childIndex is zero based
99 virtual box_type* newChildBox(int childIndex) const = 0;
101 // Fill in data of the children
102 virtual void buildChildrenData() = 0;
107 SMESH_Tree** myChildren;
109 // Point the father, NULL for the level 0
110 SMESH_Tree* myFather;
112 // Tell us if the Tree is a leaf or not
116 const SMESH_TreeLimit* myLimit;
118 // Bounding box of a tree
124 // Build the children recursively
125 void buildChildren();
128 //===========================================================================
130 * Constructor. limit must be provided at tree root construction.
131 * limit will be deleted by SMESH_Tree.
133 //===========================================================================
135 template< class BND_BOX, int NB_CHILDREN>
136 SMESH_Tree<BND_BOX,NB_CHILDREN>::SMESH_Tree (SMESH_TreeLimit* limit):
144 //if ( !myLimit ) myLimit = new SMESH_TreeLimit();
147 //================================================================================
149 * \brief Compute the Tree
151 //================================================================================
153 template< class BND_BOX, int NB_CHILDREN>
154 void SMESH_Tree<BND_BOX,NB_CHILDREN>::compute()
158 if ( !myLimit ) myLimit = new SMESH_TreeLimit();
159 myBox = buildRootBox();
160 if ( myLimit->myMinBoxSize > 0. && maxSize() <= myLimit->myMinBoxSize )
167 //======================================
169 * \brief SMESH_Tree Destructor
171 //======================================
173 template< class BND_BOX, int NB_CHILDREN>
174 SMESH_Tree<BND_BOX,NB_CHILDREN>::~SMESH_Tree ()
180 for(int i = 0; i<NB_CHILDREN; i++)
181 delete myChildren[i];
194 //=================================================================
196 * \brief Build the children boxes and call buildChildrenData()
198 //=================================================================
200 template< class BND_BOX, int NB_CHILDREN>
201 void SMESH_Tree<BND_BOX,NB_CHILDREN>::buildChildren()
203 if ( isLeaf() ) return;
205 myChildren = new SMESH_Tree*[NB_CHILDREN];
207 // get the whole model size
210 SMESH_Tree* root = this;
211 while ( root->myLevel > 0 )
212 root = root->myFather;
213 rootSize = root->maxSize();
215 for (int i = 0; i < NB_CHILDREN; i++)
217 // The child is of the same type than its father (For instance, a SMESH_OctreeNode)
218 // We allocate the memory we need for the child
219 myChildren[i] = newChild();
220 // and we assign to him its box.
221 myChildren[i]->myFather = this;
222 if (myChildren[i]->myLimit)
223 delete myChildren[i]->myLimit;
224 myChildren[i]->myLimit = myLimit;
225 myChildren[i]->myLevel = myLevel + 1;
226 myChildren[i]->myBox = newChildBox( i );
227 myChildren[i]->myBox->Enlarge( rootSize * 1e-10 );
228 if ( myLimit->myMinBoxSize > 0. && myChildren[i]->maxSize() <= myLimit->myMinBoxSize )
229 myChildren[i]->myIsLeaf = true;
232 // After building the NB_CHILDREN boxes, we put the data into the children.
235 //After we pass to the next level of the Tree
236 for (int i = 0; i<NB_CHILDREN; i++)
237 myChildren[i]->buildChildren();
240 //================================================================================
242 * \brief Tell if Tree is a leaf or not
243 * An inheriting class can influence it via myIsLeaf protected field
245 //================================================================================
247 template< class BND_BOX, int NB_CHILDREN>
248 bool SMESH_Tree<BND_BOX,NB_CHILDREN>::isLeaf() const
250 return myIsLeaf || ((myLimit->myMaxLevel > 0) ? (level() >= myLimit->myMaxLevel) : false );
253 //================================================================================
255 * \brief Return height of the tree, full or from this level to topest leaf
257 //================================================================================
259 template< class BND_BOX, int NB_CHILDREN>
260 int SMESH_Tree<BND_BOX,NB_CHILDREN>::getHeight(const bool full) const
262 if ( full && myFather )
263 return myFather->getHeight( true );
269 for (int i = 0; i<NB_CHILDREN; i++)
271 int h = myChildren[i]->getHeight( false );