src/GEOMAlgo/GEOMAlgo_BuilderShape.hxx

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