include/opencascade/LocOpe_Generator.hxx

0001 // Created on: 1996-01-09
0002 // Created by: Jacques GOUSSARD
0003 // Copyright (c) 1996-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 _LocOpe_Generator_HeaderFile
0018 #define _LocOpe_Generator_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_DataMapOfShapeListOfShape.hxx>
0026 #include <TopTools_ListOfShape.hxx>
0027 class LocOpe_GeneratedShape;
0028 class TopoDS_Face;
0029
0030 class LocOpe_Generator
0031 {
0032 public:
0033   DEFINE_STANDARD_ALLOC
0034
0035   //! Empty constructor.
0036   LocOpe_Generator();
0037
0038   //! Creates the algorithm on the shape <S>.
0039   LocOpe_Generator(const TopoDS_Shape& S);
0040
0041   //! Initializes the algorithm on the shape <S>.
0042   void Init(const TopoDS_Shape& S);
0043
0044   Standard_EXPORT void Perform(const Handle(LocOpe_GeneratedShape)& G);
0045
0046   Standard_Boolean IsDone() const;
0047
0048   //! Returns the new shape
0049   const TopoDS_Shape& ResultingShape() const;
0050
0051   //! Returns the initial shape
0052   const TopoDS_Shape& Shape() const;
0053
0054   //! Returns  the  descendant  face  of <F>.    <F> may
0055   //! belong to the original shape or to the "generated"
0056   //! shape.  The returned    face may be   a null shape
0057   //! (when <F> disappears).
0058   Standard_EXPORT const TopTools_ListOfShape& DescendantFace(const TopoDS_Face& F);
0059
0060 protected:
0061 private:
0062   TopoDS_Shape                       myShape;
0063   Handle(LocOpe_GeneratedShape)      myGen;
0064   Standard_Boolean                   myDone;
0065   TopoDS_Shape                       myRes;
0066   TopTools_DataMapOfShapeListOfShape myModShapes;
0067 };
0068
0069 #include <LocOpe_Generator.lxx>
0070
0071 #endif // _LocOpe_Generator_HeaderFile