src/GeomAlgoImpl/GEOMAlgo_Splitter.hxx

   1 // Copyright (C) 2007-2015  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 //  File:   GEOMAlgo_Splitter.hxx
  23 //
  24 //  Author: Peter KURNEV
  25
  26 #ifndef GEOMAlgo_Splitter_HeaderFile
  27 #define GEOMAlgo_Splitter_HeaderFile
  28
  29 #include <GeomAlgoImpl.h>
  30
  31 #include <Standard.hxx>
  32 #include <Standard_Macro.hxx>
  33 #include <Standard_Boolean.hxx>
  34 #include <Standard_Integer.hxx>
  35
  36 #include <NCollection_BaseAllocator.hxx>
  37
  38 #include <TopAbs_ShapeEnum.hxx>
  39
  40 #include <TopoDS_Shape.hxx>
  41
  42 #include <BOPCol_ListOfShape.hxx>
  43 #include <BOPCol_MapOfShape.hxx>
  44
  45 #include <BOPAlgo_Builder.hxx>
  46
  47 //=======================================================================
  48 //class    : GEOMAlgo_Splitter
  49 //purpose  :
  50 //=======================================================================
  51 /*!
  52  * \class GEOMAlgo_Splitter
  53  * \ingroup DataAlgo
  54  * A class for shapes partitioning
  55  */
  56  class GEOMAlgo_Splitter : public BOPAlgo_Builder
  57 {
  58  public:
  59   /// Constructor
  60   GEOMALGOIMPL_EXPORT GEOMAlgo_Splitter();
  61
  62   /// Constructor
  63   /// \param theAllocator an allocator object
  64   GEOMALGOIMPL_EXPORT GEOMAlgo_Splitter(const Handle(NCollection_BaseAllocator)& theAllocator);
  65
  66   GEOMALGOIMPL_EXPORT virtual ~GEOMAlgo_Splitter();
  67
  68   /// Add a tool shape
  69   /// \param theShape a tool shape
  70   GEOMALGOIMPL_EXPORT void AddTool(const TopoDS_Shape& theShape);
  71
  72   /// Returns list of tool shapes
  73   GEOMALGOIMPL_EXPORT const BOPCol_ListOfShape& Tools()const;
  74
  75   /// Set type of used shapes
  76   /// \param aLimit a shape type
  77   GEOMALGOIMPL_EXPORT void SetLimit(const TopAbs_ShapeEnum aLimit);
  78
  79   /// Returns defined limit type
  80   GEOMALGOIMPL_EXPORT TopAbs_ShapeEnum Limit()const;
  81
  82   /// Set mode (0 or 1) of limit
  83   /// \param aMode the mode value
  84   GEOMALGOIMPL_EXPORT void SetLimitMode(const Standard_Integer aMode);
  85
  86   /// Returns mode of limit
  87   GEOMALGOIMPL_EXPORT Standard_Integer LimitMode()const;
  88
  89   /// Clears all tool shapes
  90   GEOMALGOIMPL_EXPORT virtual void Clear();
  91
  92  protected:
  93    /// Build result.
  94    /// \param theType a type of limit
  95   GEOMALGOIMPL_EXPORT virtual void BuildResult(const TopAbs_ShapeEnum theType);
  96
  97   /// Post processing of the calculation
  98   GEOMALGOIMPL_EXPORT virtual void PostTreat();
  99
 100  protected:
 101    /// List of tools
 102   BOPCol_ListOfShape myTools;
 103
 104   /// Map of tools
 105   BOPCol_MapOfShape myMapTools;
 106
 107   /// A limit type
 108   TopAbs_ShapeEnum myLimit;
 109
 110   /// A limit mode
 111   Standard_Integer myLimitMode;
 112 };
 113
 114 #endif