src/SMESH/SMESH_OctreeNode.hxx

   1 //  SMESH SMESH_OctreeNode : Octree with Nodes set
   2 //  inherites global class SMESH_Octree
   3 //
   4 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   5 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   6 //
   7 //  This library is free software; you can redistribute it and/or
   8 //  modify it under the terms of the GNU Lesser General Public
   9 //  License as published by the Free Software Foundation; either
  10 //  version 2.1 of the License.
  11 //
  12 //  This library is distributed in the hope that it will be useful,
  13 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 //  Lesser General Public License for more details.
  16 //
  17 //  You should have received a copy of the GNU Lesser General Public
  18 //  License along with this library; if not, write to the Free Software
  19 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20 //
  21 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 //
  23 //
  24 //
  25 // File      : SMESH_OctreeNode.hxx
  26 // Created   : Tue Jan 16 16:00:00 2007
  27 // Author    : Nicolas Geimer & Aurélien Motteux  (OCC)
  28 // Module    : SMESH
  29
  30 using namespace std;
  31
  32 #ifndef _SMESH_OCTREENODE_HXX_
  33 #define _SMESH_OCTREENODE_HXX_
  34
  35 #include "SMESH_Octree.hxx"
  36
  37 #include <list>
  38 #include <set>
  39
  40 #include "SMDS_ElemIterator.hxx"
  41
  42 //forward declaration
  43 class SMDS_MeshNode;
  44 class SMESH_OctreeNode;
  45
  46 typedef SMDS_Iterator<SMESH_OctreeNode*>            SMESH_OctreeNodeIterator;
  47 typedef boost::shared_ptr<SMESH_OctreeNodeIterator> SMESH_OctreeNodeIteratorPtr;
  48
  49 class SMESH_OctreeNode : public SMESH_Octree{
  50
  51 public:
  52
  53   // Constructor
  54   SMESH_OctreeNode (const set<const SMDS_MeshNode*>& theNodes, const int maxLevel = -1,
  55                     const int maxNbNodes = 5 , const double minBoxSize = 0.);
  56
  57 //=============================
  58 /*!
  59  * \brief Empty destructor
  60  */
  61 //=============================
  62   virtual ~SMESH_OctreeNode () {};
  63
  64   // Tells us if SMESH_OctreeNode is a leaf or not (-1 = not initialiazed)
  65   virtual const bool isLeaf();
  66
  67   // Tells us if Node is inside the current box with the precision "precision"
  68   virtual const bool isInside(const SMDS_MeshNode * Node, const double precision = 0. );
  69
  70   // Return in Result a list of Nodes potentials to be near Node
  71   void               NodesAround( const SMDS_MeshNode * Node , list<const SMDS_MeshNode*>* Result,
  72                                   const double precision = 0. );
  73
  74   // Return in theGroupsOfNodes a list of group of nodes close to each other within theTolerance
  75   // Search for all the nodes in nodes
  76   void               FindCoincidentNodes ( set<const SMDS_MeshNode*>* nodes,
  77                                            const double                theTolerance,
  78                                            list< list< const SMDS_MeshNode*> >* theGroupsOfNodes);
  79
  80   // Static method that return in theGroupsOfNodes a list of group of nodes close to each other within
  81   // theTolerance search for all the nodes in nodes
  82   static void        FindCoincidentNodes ( set<const SMDS_MeshNode*> nodes,
  83                                            list< list< const SMDS_MeshNode*> >* theGroupsOfNodes,
  84                                            const double theTolerance = 0.00001, const int maxLevel = -1,
  85                                            const int maxNbNodes = 5);
  86   /*!
  87    * \brief Return iterator over children
  88    */
  89   SMESH_OctreeNodeIteratorPtr GetChildrenIterator();
  90   /*!
  91    * \brief Return nodes iterator
  92    */
  93   SMDS_NodeIteratorPtr        GetNodeIterator();
  94   /*!
  95    * \brief Return nb nodes in a tree
  96    */
  97   int                         NbNodes() const { return myNbNodes; }
  98
  99 protected:
 100
 101 //=============================
 102 /*!
 103  * \brief Empty constructor
 104  */
 105 //=============================
 106   SMESH_OctreeNode (){};
 107
 108   // Shares the father's data with each of his child
 109   virtual void          buildChildrenData();
 110
 111   // Compute the bounding box of the whole set of nodes myNodes (only used for OctreeNode level 0)
 112   void                  computeBoxForFather();
 113
 114   // Construct an empty SMESH_OctreeNode used by SMESH_Octree::buildChildren()
 115   virtual SMESH_Octree* allocateOctreeChild();
 116
 117   // Return in result a list of nodes closed to Node and remove it from SetOfNodes
 118   void                  FindCoincidentNodes( const SMDS_MeshNode * Node,
 119                                              set<const SMDS_MeshNode*>* SetOfNodes,
 120                                              list<const SMDS_MeshNode*>* Result,
 121                                              const double precision);
 122
 123   // The max number of nodes a leaf box can contain
 124   int                         myMaxNbNodes;
 125
 126   // The set of nodes inside the box of the Octree (Empty if Octree is not a leaf)
 127   set<const SMDS_MeshNode*>   myNodes;
 128
 129   // The number of nodes I have inside the box
 130   int                         myNbNodes;
 131 };
 132 #endif