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