0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BOPAlgo / BOPAlgo_BOP.cdl
CommitLineData
4e57c75e 1-- Created by: Peter KURNEV
973c2be1 2-- Copyright (c) 1999-2014 OPEN CASCADE SAS
4e57c75e 3--
973c2be1 4-- This file is part of Open CASCADE Technology software library.
4e57c75e 5--
d5f74e42 6-- This library is free software; you can redistribute it and/or modify it under
7-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 8-- by the Free Software Foundation, with special exception defined in the file
9-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10-- distribution for complete text of the license and disclaimer of any warranty.
4e57c75e 11--
973c2be1 12-- Alternatively, this file may be used under the terms of Open CASCADE
8620e18d 13-- commercial license or contractual agreement.
4e57c75e 14
8620e18d 15
4e57c75e 16class BOP from BOPAlgo
17 inherits Builder from BOPAlgo
8620e18d 18
4e57c75e 19---Purpose:
20
8620e18d 21uses
22 ShapeEnum from TopAbs,
23 Shape from TopoDS,
24 ListOfShape from TopTools,
25 --
4e57c75e 26 BaseAllocator from BOPCol,
27 ListOfShape from BOPCol,
8620e18d 28 MapOfShape from BOPCol,
29 IndexedDataMapOfShapeListOfShape from BOPCol,
30 --
31 Operation from BOPAlgo,
4e57c75e 32 PaveFiller from BOPAlgo
33
34--raises
35
36is
37 Create
38 ---Purpose: Empty constructor
8620e18d 39 returns BOP from BOPAlgo;
4e57c75e 40 ---C++: alias "Standard_EXPORT virtual ~BOPAlgo_BOP();"
41
42 Create (theAllocator: BaseAllocator from BOPCol)
8620e18d 43 returns BOP from BOPAlgo;
4e57c75e 44
45 Clear(me:out)
46 is redefined;
47 ---Purpose: Clears internal fields and arguments
48
4e57c75e 49 AddTool (me:out;
8620e18d 50 theShape: Shape from TopoDS)
4e57c75e 51 ---Purpose: Adds Tool argument of the operation
49b0c452 52 is virtual;
53
54 SetTools (me:out;
49b0c452 55 theShapes: ListOfShape from BOPCol)
8620e18d 56 is virtual;
49b0c452 57
4e57c75e 58 SetOperation(me:out;
8620e18d 59 theOperation: Operation from BOPAlgo);
4e57c75e 60
61 Operation(me)
8620e18d 62 returns Operation from BOPAlgo;
63 --
64 Perform(me:out)
65 is redefined;
4e57c75e 66 --
67 -- protected methods
68 --
69 CheckData(me:out)
8620e18d 70 is redefined protected;
4e57c75e 71
72 Prepare(me:out)
8620e18d 73 is redefined protected;
4e57c75e 74 ---Purpose: Provides preparing actions
75
36f4947b 76 PerformInternal1(me:out;
85915310 77 thePF:PaveFiller from BOPAlgo)
8620e18d 78 is redefined protected;
4e57c75e 79 ---Purpose: Performs calculations using prepared Filler
36f4947b 80 -- object <thePF>
8620e18d 81
82 BuildResult(me:out;
85915310 83 theType: ShapeEnum from TopAbs)
8620e18d 84 is redefined protected;
85
4e57c75e 86 BuildShape(me:out)
8620e18d 87 is protected;
4e57c75e 88
89 BuildRC(me:out)
8620e18d 90 is protected;
4e57c75e 91
92 BuildSolid(me:out)
8620e18d 93 is protected;
4e57c75e 94
95 IsBoundSplits(me:out;
8620e18d 96 theS:Shape from TopoDS;
97 theMEF:out IndexedDataMapOfShapeListOfShape from BOPCol)
98 returns Boolean from Standard
99 is protected;
85915310 100
4e57c75e 101fields
4e57c75e 102 myOperation : Operation from BOPAlgo is protected;
4e57c75e 103 myDims : Integer from Standard[2] is protected;
104 --
105 myRC : Shape from TopoDS is protected;
106 myTools : ListOfShape from BOPCol is protected;
107 myMapTools : MapOfShape from BOPCol is protected;
108
109end BOP;