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 <NCollection_List.hxx>
0026 #include <BRepBuilderAPI_Command.hxx>
0027 #include <Message_ProgressRange.hxx>
0028
0029 //! This is the root class for all shape
0030 //! constructions. It stores the result.
0031 //!
0032 //! It provides deferred methods to trace the history
0033 //! of sub-shapes.
0034 class BRepBuilderAPI_MakeShape : public BRepBuilderAPI_Command
0035 {
0036 public:
0037   DEFINE_STANDARD_ALLOC
0038
0039   //! This is called by Shape(). It does nothing but
0040   //! may be redefined.
0041   Standard_EXPORT virtual void Build(
0042     const Message_ProgressRange& theRange = Message_ProgressRange());
0043
0044   //! Returns a shape built by the shape construction algorithm.
0045   //! Raises exception StdFail_NotDone if the shape was not built.
0046   Standard_EXPORT virtual const TopoDS_Shape& Shape();
0047   Standard_EXPORT                             operator TopoDS_Shape();
0048
0049   //! Returns the list of shapes generated from the
0050   //! shape <S>.
0051   Standard_EXPORT virtual const NCollection_List<TopoDS_Shape>& Generated(const TopoDS_Shape& S);
0052
0053   //! Returns the list of shapes modified from the shape
0054   //! <S>.
0055   Standard_EXPORT virtual const NCollection_List<TopoDS_Shape>& Modified(const TopoDS_Shape& S);
0056
0057   //! Returns true if the shape S has been deleted.
0058   Standard_EXPORT virtual bool IsDeleted(const TopoDS_Shape& S);
0059
0060 protected:
0061   Standard_EXPORT BRepBuilderAPI_MakeShape();
0062
0063   TopoDS_Shape                   myShape;
0064   NCollection_List<TopoDS_Shape> myGenerated;
0065 };
0066
0067 #endif // _BRepBuilderAPI_MakeShape_HeaderFile