0024927: Getting rid of "Persistent" functionality -- Code
[occt.git] / src / PTopoDS / PTopoDS_HShape.cdl
1 -- Created on: 1990-12-11
2 -- Created by: Remi Lequette
3 -- Copyright (c) 1990-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 -- Update:      Frederic Maupas
18
19
20 class HShape from PTopoDS inherits ExternShareable from ObjMgt
21
22     ---Purpose: The PTopoDS_HShape is the Persistent view of a TopoDS_Shape.
23   -- This can be a vertex, an edge, a wire, a face, a shell, a solid and so on.
24  -- It can be shared by other objects.
25     --  a  HShape contains :
26     --          
27     --          - a reference to a TShape.
28     --          
29     --          - a Location  to put the TShape in  a local coordinate
30     --          system.
31     --          
32     --          - an Orientation.
33     --          
34     --          It inherits from ExternShareable, so that it can be shared
35     --          by other objects located outside the container.
36     
37 uses
38
39     Orientation   from TopAbs,
40     TShape        from PTopoDS,
41     Location      from PTopLoc
42     
43 is
44     Create returns HShape from PTopoDS;
45     ---Level: Internal 
46
47     TShape(me) returns any TShape from PTopoDS
48     ---Level: Internal 
49     is static;
50
51     TShape(me : mutable; T : TShape from PTopoDS)
52     ---Level: Internal 
53     is static;
54
55     Location(me) returns Location from PTopLoc
56     ---Level: Internal 
57     is static;
58         
59     Location(me : mutable; L : Location from PTopLoc)
60     ---Level: Internal 
61     is static;
62         
63     Orientation(me) returns Orientation from TopAbs
64     ---Level: Internal 
65     is static;
66
67     Orientation(me: mutable; O : Orientation from TopAbs)
68     ---Level: Internal 
69     is static;
70     
71 fields
72     myTShape   : TShape      from PTopoDS;
73     myLocation : Location    from PTopLoc;
74     myOrient   : Orientation from TopAbs;
75
76 end HShape;