0024428: Implementation of LGPL license
[occt.git] / src / BRepBuilderAPI / BRepBuilderAPI_MakeShape.cdl
CommitLineData
b311480e 1-- Created on: 1993-07-21
2-- Created by: Remi LEQUETTE
3-- Copyright (c) 1993-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17deferred 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
25uses
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
34raises
35 NotDone from StdFail
36
37is
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 static;
58
59
60 ------------------------------------------------------------------
61 --- The following methods are not implemented at this level.
62 -- An empty list is returned.
63 --- They are optional and must be redefined.
64 ------------------------------------------------------------------
65
66 Generated (me: in out; S : Shape from TopoDS)
67 ---Purpose: Returns the list of shapes generated from the
68 -- shape <S>.
69 ---C++: return const &
70 ---Level: Public
71 returns ListOfShape from TopTools
72 is virtual;
73
74
75 Modified (me: in out; S : Shape from TopoDS)
76 ---Purpose: Returns the list of shapes modified from the shape
77 -- <S>.
78 ---C++: return const &
79 ---Level: Public
80 returns ListOfShape from TopTools
81 is virtual;
82
83
84 IsDeleted (me: in out; S : Shape from TopoDS)
85 returns Boolean
86 is virtual;
87 ---Purpose: Returns true if the shape S has been deleted.
88
89
90fields
91
92 myShape : Shape from TopoDS is protected;
93 myGenerated : ListOfShape from TopTools is protected;
94
95end MakeShape;