0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepAlgoAPI / BRepAlgoAPI_Common.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 Common from BRepAlgoAPI  
18     inherits BooleanOperation from BRepAlgoAPI
19
20     ---Purpose:  
21     -- The class provides Boolean common operation
22     -- between arguments and tools (Boolean Intersection).
23
24 uses
25     Shape from TopoDS, 
26     PaveFiller from BOPAlgo
27  
28 is  
29     Create 
30         returns Common from BRepAlgoAPI;  
31     ---C++: alias "Standard_EXPORT virtual ~BRepAlgoAPI_Common();"  
32     --- Purpose: Empty constructor       
33       
34     Create (PF: PaveFiller from BOPAlgo)
35         returns Common from BRepAlgoAPI;  
36     --- Purpose: Empty constructor  
37     -- <PF> - PaveFiller object that is carried out     
38  
39     Create (S1,S2 : Shape from TopoDS)  
40         returns Common from BRepAlgoAPI;  
41     ---Purpose: Constructor with two shapes  
42     -- <S1>  -argument     
43     -- <S2>  -tool     
44     -- <anOperation> - the type of the operation
45     -- Obsolete  
46  
47     Create (S1: Shape from TopoDS; 
48             S2: Shape from TopoDS; 
49             PF: PaveFiller from BOPAlgo)  
50         returns Common from BRepAlgoAPI; 
51     ---Purpose: Constructor with two shapes  
52     -- <S1>  -argument     
53     -- <S2>  -tool    
54     -- <anOperation> - the type of the operation 
55     -- <PF> - PaveFiller object that is carried out  
56     -- Obsolete   
57     
58 end Common;
59