src/HYDROData/HYDROData_Quadtree.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 //  HYDROData_Quadtree : Quadtree implementation (from SMESH module)
  24 //  File      : HYDROData_Quadtree.hxx
  25 //  Module    : HYDROData
  26 //
  27 #ifndef _HYDROData_Quadtree_HXX_
  28 #define _HYDROData_Quadtree_HXX_
  29
  30 #include <Standard.hxx>
  31 #include <Standard_Macro.hxx>
  32
  33 #include "HYDROData_Tree.hxx"
  34 #include <Bnd_B2d.hxx>
  35
  36 //================================================================================
  37
  38 /*!
  39  * \brief 2D tree of anything.
  40  * Methods to implement in a descendant are:
  41  * - Bnd_B2d*       buildRootBox(); // box of the whole tree
  42  * - descendant*    newChild() const; // a new child instance
  43  * - void           buildChildrenData(); // Fill in data of the children
  44  */
  45 class Standard_EXPORT HYDROData_Quadtree: public HYDROData_Tree<Bnd_B2d, 4>
  46 {
  47 public:
  48   typedef HYDROData_Tree<Bnd_B2d, 4> TBaseTree;
  49
  50   //! Constructor. limit must be provided at tree root construction.
  51   //! limit will be deleted by HYDROData_Quadtree
  52   HYDROData_Quadtree(HYDROData_TreeLimit* limit = 0);
  53
  54   //! Compute the biggest dimension of my box
  55   double maxSize() const;
  56
  57   //! Return index of a child the given point is in
  58   inline int getChildIndex(double x, double y, const gp_XY& boxMiddle) const
  59   {
  60     return (x > boxMiddle.X()) + (y > boxMiddle.Y()) * 2;
  61   };
  62
  63 protected:
  64
  65   //! Allocate a bndbox according to childIndex. childIndex is zero based
  66   virtual Bnd_B2d* newChildBox(int childIndex) const;
  67 };
  68
  69 #endif