src/ShHealOper/ShHealOper_Tool.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:      ShHealOper_Tool.hxx
  24 // Created:   26.04.04 11:36:04
  25 // Author:    Galina KULIKOVA
  26 //
  27 #ifndef ShHealOper_Tool_HeaderFile
  28 #define ShHealOper_Tool_HeaderFile
  29
  30 #include <MMgt_TShared.hxx>
  31 #include <ShapeBuild_ReShape.hxx>
  32 #include <TopoDS_Shape.hxx>
  33
  34 ///  Class ShHealOper_Tool
  35 //
  36 //enumeration for definition of the status of the error if operation failed
  37 enum ShHealOper_Error {
  38   ShHealOper_NotError,
  39   ShHealOper_InvalidParameters,
  40   ShHealOper_ErrorExecution
  41 };
  42
  43 class ShHealOper_Tool
  44 {
  45  public:
  46   // ---------- PUBLIC METHODS ----------
  47
  48   /// Empty constructor
  49   Standard_EXPORT ShHealOper_Tool () ;
  50
  51   Standard_EXPORT ShHealOper_Tool (const TopoDS_Shape& theShape);
  52   // Constructor initialized by shape from which faces will be removed.
  53
  54   Standard_EXPORT virtual void Init(const TopoDS_Shape& theShape);
  55   //Method for initalization by whole shape.
  56
  57   inline const TopoDS_Shape& GetResultShape() const
  58   {
  59     return myResultShape;
  60
  61   }
  62   //Returns result shape.
  63
  64   inline Standard_Boolean GetModifiedShape(const TopoDS_Shape& theOldShape,
  65                                            TopoDS_Shape& theNewShape) const
  66   {
  67     theNewShape = myContext->Apply(theOldShape);
  68     return (!theNewShape.IsSame(theOldShape));
  69   }
  70   //Returns modified shape obtained after operation from initial shape.
  71
  72   inline Standard_Boolean IsDone() const
  73   {
  74     return myDone;
  75   }
  76   //Returns status of the operation.
  77
  78   inline void SetContext(Handle(ShapeBuild_ReShape)& theContext)
  79   {
  80     myContext = theContext;
  81   }
  82   //Initialization by context keeping modification of sub-shapes.
  83
  84   inline Handle(ShapeBuild_ReShape) Context()
  85   {
  86     return myContext;
  87   }
  88   //Returns context keeping modification of sub-shapes
  89
  90   inline Standard_Integer GetErrorStatus()
  91   {
  92     return myErrorStatus;
  93   }
  94  protected:
  95   // ---------- PROTECTED FIELDS ----------
  96
  97   Handle(ShapeBuild_ReShape) myContext;
  98   TopoDS_Shape myInitShape;
  99   TopoDS_Shape myResultShape;
 100   Standard_Boolean myDone;
 101   ShHealOper_Error myErrorStatus;
 102  public:
 103 // Declaration of CASCADE RTTI
 104 //DEFINE_STANDARD_RTTI (ShHealOper_Tool)
 105 };
 106
 107 // Definition of HANDLE object using Standard_DefineHandle.hxx
 108 //DEFINE_STANDARD_HANDLE (ShHealOper_Tool, )
 109
 110
 111 #endif