]> SALOME platform Git repositories - modules/smesh.git/blob - src/SMESHUtils/SMESH_Octree.hxx
Salome HOME
0020833: EDF 1361 SMESH : Graphical Selection of the boundary faces in one clic
[modules/smesh.git] / src / SMESHUtils / SMESH_Octree.hxx
1 // Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
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.
10 //
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.
15 //
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
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 //  SMESH SMESH_Octree : global Octree implementation
24 //  File      : SMESH_Octree.hxx
25 //  Created   : Tue Jan 16 16:00:00 2007
26 //  Author    : Nicolas Geimer & Aurélien Motteux (OCC)
27 //  Module    : SMESH
28 //
29 #ifndef _SMESH_OCTREE_HXX_
30 #define _SMESH_OCTREE_HXX_
31
32 #include "SMESH_Utils.hxx"
33 #include <Bnd_B3d.hxx>
34
35 class SMESHUtils_EXPORT SMESH_Octree {
36
37 public:
38
39   // Data limiting the tree height
40   struct Limit {
41     // MaxLevel of the Octree
42     int    myMaxLevel;
43     // Minimal size of the Box
44     double myMinBoxSize;
45
46     // Default:
47     // maxLevel-> 8^8 = 16777216 terminal trees
48     // minSize -> box size not checked
49     Limit(int maxLevel=8, double minSize=0.):myMaxLevel(maxLevel),myMinBoxSize(minSize) {}
50     virtual ~Limit() {} // it can be inherited
51   };
52
53   // Constructor. limit must be provided at tree root construction.
54   // limit will be deleted by SMESH_Octree
55   SMESH_Octree (Limit* limit=0);
56
57   // Destructor
58   virtual ~SMESH_Octree ();
59
60   // Compute the Octree. Must be called by constructor of inheriting class
61   void                   compute();
62
63   // Tell if Octree is a leaf or not.
64   // An inheriting class can influence it via myIsLeaf protected field
65   bool                   isLeaf() const;
66
67   // Return its level
68   int                    level() const { return myLevel; }
69
70   // Get box to the 3d Bounding Box of the Octree
71   const Bnd_B3d&         getBox() const { return *myBox; }
72
73   // Compute the bigger dimension of my box
74   double                 maxSize() const;
75
76   // Return index of a child the given point is in
77   inline int             getChildIndex(double x, double y, double z, const gp_XYZ& boxMiddle)const;
78
79   // Return height of the tree, full or from this level to topest leaf
80   int                    getHeight(const bool full=true) const;
81
82 protected:
83   // Return box of the whole tree
84   virtual Bnd_B3d*       buildRootBox() = 0;
85
86   // Constructor for children
87   virtual SMESH_Octree*  allocateOctreeChild() const = 0;
88
89   // Build the data in the 8 children
90   virtual void           buildChildrenData() = 0;
91
92   // members
93
94   // Array of 8 Octree children
95   SMESH_Octree** myChildren;
96
97   // Point the father, set to NULL for the level 0
98   SMESH_Octree*  myFather;
99
100   // Tell us if the Octree is a leaf or not
101   bool           myIsLeaf;
102
103   // Tree limit
104   const Limit*   myLimit;
105
106 private:
107   // Build the 8 children boxes recursively
108   void                   buildChildren();
109
110   // Level of the Octree
111   int            myLevel;
112
113   Bnd_B3d*       myBox;
114 };
115
116 //================================================================================
117 /*!
118  * \brief Return index of a child the given point is in
119  */
120 //================================================================================
121
122 inline int SMESH_Octree::getChildIndex(double x, double y, double z, const gp_XYZ& mid) const
123 {
124   return (x > mid.X()) + ( y > mid.Y())*2 + (z > mid.Z())*4;
125 }
126
127 #endif