1f25394b7bf255495d2c8e58a9e2090b23540077
[occt.git] / src / PrsMgr / PrsMgr_Presentation.cdl
1 -- Created on: 1995-01-25
2 -- Created by: Jean-Louis Frenkel
3 -- Copyright (c) 1995-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21 -- Modified by Rob : 20-feb-1997
22 -- Modified by Rob : 16-dec-1997 : kind of presentation
23
24 deferred class Presentation from PrsMgr
25 inherits TShared  from MMgt
26
27 uses 
28
29     PresentationManager from PrsMgr,
30     KindOfPrs from PrsMgr
31
32 is
33
34     Initialize(aPresentationManager: PresentationManager from PrsMgr)
35     is protected;
36
37     KindOfPresentation(me) returns KindOfPrs from PrsMgr is deferred;    
38     ---Purpose: 2D or 3D
39     
40     Display(me: mutable) is deferred private;
41     
42     Erase(me) is deferred private;
43
44     SetVisible (me: mutable; theValue: Boolean from Standard) is deferred private;
45
46     Highlight(me: mutable) is deferred private;
47     
48     Unhighlight (me) is deferred private;
49     
50     IsHighlighted(me) returns Boolean from Standard
51     is deferred private;
52
53     IsDisplayed(me) returns Boolean from Standard
54     is deferred private;
55
56     Destroy ( me : mutable )
57     is virtual; 
58     ---Level: Public    
59     ---Purpose: Destructor
60     ---C++:     alias ~
61
62     DisplayPriority(me) returns Integer from Standard
63     is deferred private;
64     
65     SetDisplayPriority(me:mutable;aNewPrior:Integer from Standard)
66     is deferred private;
67
68     SetZLayer ( me : mutable;
69                 theLayerId : Integer from Standard )
70       is deferred private;
71     ---Purpose: Set Z layer ID for the presentation
72
73     GetZLayer ( me )
74       returns Integer from Standard is deferred private;
75     ---Purpose: Get Z layer ID for the presentation
76
77     Clear(me: mutable) 
78     is deferred private;
79     
80 ---Category: Inquire Methods
81 --            
82     PresentationManager(me) returns mutable PresentationManager
83     ---Purpose: returns the PresentationManager in which the
84     --          presentation has been created.
85     is static;
86     ---C++: inline
87     ---C++: return const&
88
89
90 ---Category: Internal Methods
91
92     SetUpdateStatus(me:mutable; aStat : Boolean from Standard);
93     ---C++: inline
94     
95     MustBeUpdated(me) returns Boolean from Standard;
96     ---C++: inline
97
98
99 fields
100
101     myPresentationManager: PresentationManager from PrsMgr is protected;
102     myMustBeUpdated      : Boolean from Standard is protected;
103
104 friends
105     class PresentationManager from PrsMgr
106         
107 end Presentation from PrsMgr;