include/opencascade/BRepAlgoAPI_Cut.hxx

0001 // Created on: 1993-10-14
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 _BRepAlgoAPI_Cut_HeaderFile
0018 #define _BRepAlgoAPI_Cut_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <BRepAlgoAPI_BooleanOperation.hxx>
0024 class BOPAlgo_PaveFiller;
0025 class TopoDS_Shape;
0026
0027 //! The class Cut provides Boolean cut operation
0028 //! between arguments and tools (Boolean Subtraction).
0029 class BRepAlgoAPI_Cut : public BRepAlgoAPI_BooleanOperation
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   //! Empty constructor
0035   Standard_EXPORT BRepAlgoAPI_Cut();
0036   Standard_EXPORT ~BRepAlgoAPI_Cut() override;
0037
0038   //! Empty constructor
0039   //! <PF> - PaveFiller object that is carried out
0040   Standard_EXPORT BRepAlgoAPI_Cut(const BOPAlgo_PaveFiller& PF);
0041
0042   //! Constructor with two shapes
0043   //! <S1>  -argument
0044   //! <S2>  -tool
0045   //! <anOperation> - the type of the operation
0046   //! Obsolete
0047   Standard_EXPORT BRepAlgoAPI_Cut(const TopoDS_Shape&          S1,
0048                                   const TopoDS_Shape&          S2,
0049                                   const Message_ProgressRange& theRange = Message_ProgressRange());
0050
0051   //! Constructor with two shapes
0052   //! <S1>  -argument
0053   //! <S2>  -tool
0054   //! <anOperation> - the type of the operation
0055   //! <PF> - PaveFiller object that is carried out
0056   //! Obsolete
0057   Standard_EXPORT BRepAlgoAPI_Cut(const TopoDS_Shape&          S1,
0058                                   const TopoDS_Shape&          S2,
0059                                   const BOPAlgo_PaveFiller&    aDSF,
0060                                   const bool                   bFWD     = true,
0061                                   const Message_ProgressRange& theRange = Message_ProgressRange());
0062 };
0063
0064 #endif // _BRepAlgoAPI_Cut_HeaderFile