src/GEOMAlgo/GEOMAlgo_BuilderShape.hxx

   1 // Copyright (C) 2007-2023  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 // File:        GEOMAlgo_BuilderShape.hxx
  24 // Created:
  25 // Author:      Peter KURNEV
  26 //
  27 #ifndef _GEOMAlgo_BuilderShape_HeaderFile
  28 #define _GEOMAlgo_BuilderShape_HeaderFile
  29
  30 #include <Standard.hxx>
  31 #include <Standard_Macro.hxx>
  32 #include <Standard_Boolean.hxx>
  33
  34 #include <TopoDS_Shape.hxx>
  35
  36 #include <TopTools_ListOfShape.hxx>
  37 #include <TopTools_MapOfShape.hxx>
  38 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
  39
  40 #include <GEOMAlgo_Algo.hxx>
  41
  42
  43 //! Root class for algorithms that has shape as result <br>
  44 //=======================================================================
  45 //class    : GEOMAlgo_BuilderShape
  46 //purpose  :
  47 //=======================================================================
  48 class GEOMAlgo_BuilderShape  : public GEOMAlgo_Algo
  49 {
  50  public:
  51   //!  Returns the result of algorithm <br>
  52   Standard_EXPORT
  53     const TopoDS_Shape& Shape() const;
  54
  55   //! Returns the list of shapes generated from the <br>
  56   //!          shape theS. <br>
  57   Standard_EXPORT
  58     virtual const TopTools_ListOfShape& Generated(const TopoDS_Shape& theS) ;
  59
  60   //! Returns the list of shapes modified from the <br>
  61   //!          shape theS. <br>
  62   Standard_EXPORT
  63     virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& theS) ;
  64
  65   //! Returns true if the shape theS has been deleted. <br>
  66   Standard_EXPORT
  67     virtual  Standard_Boolean IsDeleted(const TopoDS_Shape& theS) ;
  68
  69   //! Returns true if the at least one shape(or sub-shape) <br>
  70   //!          of arguments has been deleted. <br>
  71   Standard_EXPORT
  72     Standard_Boolean HasDeleted() const;
  73
  74   //! Returns true if the at least one shape(or sub-shape) <br>
  75   //!          of arguments has generated shapes. <br>
  76   Standard_EXPORT
  77     Standard_Boolean HasGenerated() const;
  78
  79   //! Returns true if the at least one shape(or sub-shape) <br>
  80   //!          of arguments has modified shapes. <br>
  81   Standard_EXPORT
  82     Standard_Boolean HasModified() const;
  83
  84   Standard_EXPORT
  85     const TopTools_IndexedDataMapOfShapeListOfShape& ImagesResult() const;
  86
  87 protected:
  88   //! Empty constructor <br>
  89   Standard_EXPORT
  90     GEOMAlgo_BuilderShape();
  91
  92   Standard_EXPORT
  93     virtual ~GEOMAlgo_BuilderShape();
  94
  95   //!  Prepare information for history support <br>
  96   Standard_EXPORT
  97     virtual  void PrepareHistory() ;
  98
  99
 100   TopoDS_Shape myShape;
 101   TopTools_ListOfShape myHistShapes;
 102   TopTools_MapOfShape myMapShape;
 103   Standard_Boolean myHasDeleted;
 104   Standard_Boolean myHasGenerated;
 105   Standard_Boolean myHasModified;
 106   TopTools_IndexedDataMapOfShapeListOfShape myImagesResult;
 107 };
 108 #endif