0025477: Boolean Operations with additional tolerance - Fuzzy Boolean operations
[occt.git] / src / BRepAlgoAPI / BRepAlgoAPI_Cut.cdl
1 -- Created on: 1993-10-14
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 class Cut from BRepAlgoAPI  
18     inherits BooleanOperation from BRepAlgoAPI
19  ---Purpose:  The class Cut provides a Boolean
20      -- cut operation on a pair of arguments (Boolean Subtraction).
21      -- The class Cut provides a framework for:
22      --   -      Defining the construction of a cut shape
23      --   -      Implementing the building algorithm
24      --   -      Consulting the result
25
26 uses
27     Shape from TopoDS,
28     PaveFiller from BOPAlgo
29
30 is 
31  
32     Create 
33         returns Cut from BRepAlgoAPI;   
34     ---C++: alias "Standard_EXPORT virtual ~BRepAlgoAPI_Cut();"  
35     --- Purpose: Empty constructor 
36         
37
38     Create (S1,S2 : Shape from TopoDS)  
39         returns Cut from BRepAlgoAPI;  
40     ---Purpose: Shape aS2 cuts shape aS1. The
41      -- resulting shape is a new shape produced by the cut operation.
42  
43
44     Create (S1,S2 : Shape from TopoDS; 
45             aDSF  : PaveFiller  from BOPAlgo; 
46             bFWD  : Boolean from Standard=Standard_True)  
47         returns Cut from BRepAlgoAPI;  
48      --- Purpose: Constructs a new shape cut from
49      -- shape aS1 by shape aS2 using aDSFiller (see
50      -- BRepAlgoAPI_BooleanOperation Constructor).
51         
52 end Cut;