0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepBuilderAPI / BRepBuilderAPI_MakeShape.cdl
1 -- Created on: 1993-07-21
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 deferred class MakeShape from BRepBuilderAPI inherits Command from BRepBuilderAPI
18
19  ---Purpose: This    is  the  root     class for     all  shape
20  --          constructions.  It stores the result.
21  --          
22  --          It  provides deferred methods to trace the history
23  --          of sub-shapes.
24
25 uses
26     Shape             from TopoDS,
27     Face              from TopoDS,
28     Edge              from TopoDS,
29     Vertex            from TopoDS,
30     ShapeModification from BRepBuilderAPI,
31     ListOfShape       from TopTools
32     
33     
34 raises
35     NotDone           from StdFail
36
37 is 
38     Delete(me:out) is redefined;
39     ---C++: alias "Standard_EXPORT virtual ~BRepBuilderAPI_MakeShape(){Delete() ; }"
40     
41     Initialize;
42     
43     Build(me : in out)
44     ---Purpose: This is  called by  Shape().  It does  nothing but
45     --          may be redefined.
46     ---Level: Public
47     is virtual;
48  
49     Shape(me) returns Shape from TopoDS
50     ---Purpose: Returns a shape built by the shape construction algorithm.
51     -- Raises exception StdFail_NotDone if the shape was not built.
52     ---C++: return const &
53     ---C++: alias "Standard_EXPORT operator TopoDS_Shape() const;"
54     ---Level: Public
55     raises
56     NotDone from StdFail 
57     is virtual; 
58     --is static; 
59
60
61     ------------------------------------------------------------------
62     --- The following methods are not implemented at this level.
63     --  An empty list is returned.
64     --- They are optional and must be redefined. 
65     ------------------------------------------------------------------
66
67     Generated (me: in out; S : Shape from TopoDS)
68     ---Purpose: Returns the  list   of shapes generated   from the
69     --          shape <S>. 
70     ---C++: return const & 
71     ---Level: Public
72     returns ListOfShape from TopTools
73     is virtual;
74     
75
76     Modified (me: in out; S : Shape from TopoDS)
77     ---Purpose: Returns the list  of shapes modified from the shape
78     --          <S>. 
79     ---C++: return const & 
80     ---Level: Public
81     returns ListOfShape from TopTools
82     is virtual;
83
84
85     IsDeleted (me: in out; S : Shape from TopoDS)
86     returns Boolean
87     is virtual;
88     ---Purpose: Returns true if the shape S has been deleted.
89
90     
91 fields
92  
93     myShape      : Shape       from TopoDS   is protected;
94     myGenerated  : ListOfShape from TopTools is protected;
95     
96 end MakeShape;