include/opencascade/BRepBuilderAPI_MakeShape.hxx

0001 // Created on: 1993-07-21
0002 // Created by: Remi LEQUETTE
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _BRepBuilderAPI_MakeShape_HeaderFile
0018 #define _BRepBuilderAPI_MakeShape_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TopoDS_Shape.hxx>
0025 #include <TopTools_ListOfShape.hxx>
0026 #include <BRepBuilderAPI_Command.hxx>
0027 #include <Message_ProgressRange.hxx>
0028
0029
0030 //! This    is  the  root     class for     all  shape
0031 //! constructions.  It stores the result.
0032 //!
0033 //! It  provides deferred methods to trace the history
0034 //! of sub-shapes.
0035 class BRepBuilderAPI_MakeShape  : public BRepBuilderAPI_Command
0036 {
0037 public:
0038
0039   DEFINE_STANDARD_ALLOC
0040
0041   //! This is  called by  Shape().  It does  nothing but
0042   //! may be redefined.
0043   Standard_EXPORT virtual void Build(const Message_ProgressRange& theRange = Message_ProgressRange());
0044
0045   //! Returns a shape built by the shape construction algorithm.
0046   //! Raises exception StdFail_NotDone if the shape was not built.
0047   Standard_EXPORT virtual const TopoDS_Shape& Shape();
0048   Standard_EXPORT operator TopoDS_Shape();
0049
0050   //! Returns the  list   of shapes generated   from the
0051   //! shape <S>.
0052   Standard_EXPORT virtual const TopTools_ListOfShape& Generated (const TopoDS_Shape& S);
0053
0054   //! Returns the list  of shapes modified from the shape
0055   //! <S>.
0056   Standard_EXPORT virtual const TopTools_ListOfShape& Modified (const TopoDS_Shape& S);
0057
0058   //! Returns true if the shape S has been deleted.
0059   Standard_EXPORT virtual Standard_Boolean IsDeleted (const TopoDS_Shape& S);
0060
0061
0062
0063
0064 protected:
0065
0066
0067   Standard_EXPORT BRepBuilderAPI_MakeShape();
0068
0069
0070   TopoDS_Shape myShape;
0071   TopTools_ListOfShape myGenerated;
0072
0073
0074 private:
0075
0076
0077
0078
0079
0080 };
0081
0082
0083
0084
0085
0086
0087
0088 #endif // _BRepBuilderAPI_MakeShape_HeaderFile