0024428: Implementation of LGPL license
[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
9 -- under the terms of the GNU Lesser General Public 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 inherits BooleanOperation from BRepAlgoAPI
18         ---Purpose:  The class Cut provides a Boolean
19         -- cut operation on a pair of arguments (Boolean Subtraction).
20         -- The class Cut provides a framework for:
21         --   -      Defining the construction of a cut shape
22         --   -      Implementing the building algorithm
23         --   -      Consulting the result
24
25 uses
26     Shape from TopoDS,
27     PaveFiller from BOPAlgo
28
29 is
30     Create (S1,S2 : Shape from TopoDS)  
31         returns Cut from BRepAlgoAPI;  
32         ---Purpose: Shape aS2 cuts shape aS1. The
33         -- resulting shape is a new shape produced by the cut operation.
34         
35
36     Create (S1,S2 : Shape from TopoDS; 
37             aDSF  : PaveFiller  from BOPAlgo; 
38             bFWD  : Boolean from Standard=Standard_True)  
39         returns Cut from BRepAlgoAPI;    
40         --- Purpose: Constructs a new shape cut from
41         -- shape aS1 by shape aS2 using aDSFiller (see
42         -- BRepAlgoAPI_BooleanOperation Constructor).
43         
44 end Cut;