src/HYDROData/HYDROData_Octree.hxx

   1 // Copyright (C) 2007-2014  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, or (at your option) any later version.
  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 //  HYDRO HYDROData_Octree : Octree implementation (from SMESH module)
  24 //  File      : HYDROData_Octree.hxx
  25 //  Created   : Tue Jan 16 16:00:00 2007
  26 //  Author    : Nicolas Geimer & Aurélien Motteux (OCC)
  27 //  Module    : HYDROData
  28 //
  29 #ifndef _HYDROData_OCTREE_HXX_
  30 #define _HYDROData_OCTREE_HXX_
  31
  32 #include <Standard.hxx>
  33 #include <Standard_Macro.hxx>
  34
  35 #include "HYDROData_Tree.hxx"
  36 #include <Bnd_B3d.hxx>
  37
  38 //================================================================================
  39
  40 /*!
  41  * \brief 3D tree of anything.
  42  * Methods to implement in a descendant are:
  43  * - Bnd_B3d*       buildRootBox(); // box of the whole tree
  44  * - descendant*    newChild() const; // a new child instance
  45  * - void           buildChildrenData(); // Fill in data of the children
  46  */
  47 class Standard_EXPORT HYDROData_Octree: public HYDROData_Tree<Bnd_B3d, 8>
  48 {
  49 public:
  50   typedef HYDROData_Tree<Bnd_B3d, 8> TBaseTree;
  51
  52   //! Constructor. limit must be provided at tree root construction.
  53   //! limit will be deleted by HYDROData_Octree
  54   HYDROData_Octree(HYDROData_TreeLimit* limit = 0);
  55   virtual ~HYDROData_Octree() {};
  56
  57   //! Compute the biggest dimension of my box
  58   double maxSize() const;
  59
  60   //! Return index of a child the given point is in
  61   inline static int getChildIndex(double x, double y, double z, const gp_XYZ& boxMiddle)
  62   {
  63     return (x > boxMiddle.X()) + (y > boxMiddle.Y()) * 2 + (z > boxMiddle.Z()) * 4;
  64   };
  65
  66 protected:
  67
  68   //! Allocate a bndbox according to childIndex. childIndex is zero based
  69   virtual Bnd_B3d* newChildBox(int childIndex) const;
  70 };
  71
  72 #endif