src/SMESH/SMESH_Octree.hxx

   1 //  Copyright (C) 2007-2010  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 <Bnd_B3d.hxx>
  33
  34 class SMESH_Octree {
  35
  36 public:
  37
  38   // Data limiting the tree height
  39   struct Limit {
  40     // MaxLevel of the Octree
  41     int    myMaxLevel;
  42     // Minimal size of the Box
  43     double myMinBoxSize;
  44
  45     // Default:
  46     // maxLevel-> 8^8 = 16777216 terminal trees
  47     // minSize -> box size not checked
  48     Limit(int maxLevel=8, double minSize=0.):myMaxLevel(maxLevel),myMinBoxSize(minSize) {}
  49     virtual ~Limit() {} // it can be inherited
  50   };
  51
  52   // Constructor. limit must be provided at tree root construction.
  53   // limit will be deleted by SMESH_Octree
  54   SMESH_Octree (Limit* limit=0);
  55
  56   // Destructor
  57   virtual ~SMESH_Octree ();
  58
  59   // Compute the Octree. Must be called by constructor of inheriting class
  60   void                   compute();
  61
  62   // Tell if Octree is a leaf or not.
  63   // An inheriting class can influence it via myIsLeaf protected field
  64   bool                   isLeaf() const;
  65
  66   // Return its level
  67   int                    level() const { return myLevel; }
  68
  69   // Get box to the 3d Bounding Box of the Octree
  70   const Bnd_B3d&         getBox() const { return *myBox; }
  71
  72   // Compute the bigger dimension of my box
  73   double                 maxSize() const;
  74
  75   // Return index of a child the given point is in
  76   inline int             getChildIndex(double x, double y, double z, const gp_XYZ& boxMiddle)const;
  77
  78 protected:
  79   // Return box of the whole tree
  80   virtual Bnd_B3d*       buildRootBox() = 0;
  81
  82   // Constructor for children
  83   virtual SMESH_Octree*  allocateOctreeChild() const = 0;
  84
  85   // Build the data in the 8 children
  86   virtual void           buildChildrenData() = 0;
  87
  88   // members
  89
  90   // Array of 8 Octree children
  91   SMESH_Octree** myChildren;
  92
  93   // Point the father, set to NULL for the level 0
  94   SMESH_Octree*  myFather;
  95
  96   // Tell us if the Octree is a leaf or not
  97   bool           myIsLeaf;
  98
  99   // Tree limit
 100   const Limit*   myLimit;
 101
 102 private:
 103   // Build the 8 children boxes recursively
 104   void                   buildChildren();
 105
 106   // Level of the Octree
 107   int            myLevel;
 108
 109   Bnd_B3d*       myBox;
 110 };
 111
 112 //================================================================================
 113 /*!
 114  * \brief Return index of a child the given point is in
 115  */
 116 //================================================================================
 117
 118 inline int SMESH_Octree::getChildIndex(double x, double y, double z, const gp_XYZ& mid) const
 119 {
 120   return (x > mid.X()) + ( y > mid.Y())*2 + (z > mid.Z())*4;
 121 }
 122
 123 #endif