src/BRepBuilderAPI/BRepBuilderAPI_MakeShape.hxx

   1 // Created on: 1993-07-21
   2 // Created by: Remi LEQUETTE
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _BRepBuilderAPI_MakeShape_HeaderFile
  18 #define _BRepBuilderAPI_MakeShape_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <TopoDS_Shape.hxx>
  25 #include <TopTools_ListOfShape.hxx>
  26 #include <BRepBuilderAPI_Command.hxx>
  27 #include <Message_ProgressRange.hxx>
  28
  29
  30 //! This    is  the  root     class for     all  shape
  31 //! constructions.  It stores the result.
  32 //!
  33 //! It  provides deferred methods to trace the history
  34 //! of sub-shapes.
  35 class BRepBuilderAPI_MakeShape  : public BRepBuilderAPI_Command
  36 {
  37 public:
  38
  39   DEFINE_STANDARD_ALLOC
  40
  41   //! This is  called by  Shape().  It does  nothing but
  42   //! may be redefined.
  43   Standard_EXPORT virtual void Build(const Message_ProgressRange& theRange = Message_ProgressRange());
  44
  45   //! Returns a shape built by the shape construction algorithm.
  46   //! Raises exception StdFail_NotDone if the shape was not built.
  47   Standard_EXPORT virtual const TopoDS_Shape& Shape();
  48   Standard_EXPORT operator TopoDS_Shape();
  49
  50   //! Returns the  list   of shapes generated   from the
  51   //! shape <S>.
  52   Standard_EXPORT virtual const TopTools_ListOfShape& Generated (const TopoDS_Shape& S);
  53
  54   //! Returns the list  of shapes modified from the shape
  55   //! <S>.
  56   Standard_EXPORT virtual const TopTools_ListOfShape& Modified (const TopoDS_Shape& S);
  57
  58   //! Returns true if the shape S has been deleted.
  59   Standard_EXPORT virtual Standard_Boolean IsDeleted (const TopoDS_Shape& S);
  60
  61
  62
  63
  64 protected:
  65
  66
  67   Standard_EXPORT BRepBuilderAPI_MakeShape();
  68
  69
  70   TopoDS_Shape myShape;
  71   TopTools_ListOfShape myGenerated;
  72
  73
  74 private:
  75
  76
  77
  78
  79
  80 };
  81
  82
  83
  84
  85
  86
  87
  88 #endif // _BRepBuilderAPI_MakeShape_HeaderFile