0022795: Make possible to display some presentable objects in overlay of others,...
[occt.git] / src / PrsMgr / PrsMgr_Presentation2d.cdl
1 -- File:        PrsMgr_Presentation2d.cdl
2 -- Created:     Thu Oct 21 13:09:32 1993
3 -- Author:      Jean-Louis FRENKEL
4 --              <jlf@stylox>
5 --Modified by rob Dec-16-97             
6 ---Copyright:    Matra Datavision 1993
7
8
9
10 class Presentation2d from PrsMgr inherits Presentation from PrsMgr
11         
12         ---Purpose: A framework to manage 2D displays, graphic entities
13         -- and their updates. Plotters, Highlights, Minima
14         -- maxima, immediate display. 
15         
16 uses
17     GraphicObject from Graphic2d,
18     PresentationManager2d from PrsMgr,
19     KindOfPrs from PrsMgr
20 is
21     Create(aPresentationManager2d: PresentationManager2d from PrsMgr) 
22     returns  mutable Presentation2d from PrsMgr
23     is private;
24         ---Purpose: Creates a framework to manage displays and graphic
25         -- entities with the 2D view aStructureManager.
26         
27     KindOfPresentation(me) returns KindOfPrs from PrsMgr is redefined static;
28     
29     Destroy(me: mutable) is redefined;
30     ---Level: Public    
31     ---Purpose: Destructor.
32     ---C++:     alias ~
33
34     Display(me: mutable) is redefined static private;
35     
36     Erase(me) is redefined static private;
37     
38     Highlight(me: mutable) is redefined static private;
39     
40     Unhighlight (me) is redefined static private;
41     
42     IsDisplayed(me) returns Boolean from Standard
43     is redefined static private;
44     
45     IsHighlighted(me) returns Boolean from Standard
46     is redefined static private;
47
48     DisplayPriority(me) returns Integer from Standard
49     is redefined static private;
50     
51     SetDisplayPriority(me:mutable;aNewPrior:Integer from Standard)
52     is redefined static private;
53    
54     SetZLayer ( me : mutable;
55                 theLayerId : Integer from Standard )
56       is redefined static private;
57     ---Purpose: Set Z layer ID for the presentation
58
59     GetZLayer ( me )
60       returns Integer from Standard is redefined static private;
61     ---Purpose: Get Z layer ID for the presentation
62
63     Clear(me:mutable)
64         ---Purpose: removes the whole content of the presentation.
65               
66     is redefined;
67
68     Highlight(me; anIndex: Integer from Standard) 
69     is static private;
70         
71     ---Category: 2d specialized methods.
72         
73     EnablePlot (me)
74         ---Purpose: Allows the drawing on a plotter of the graphic object
75         -- aPresentableObject with the display mode aMode.
76     is static private;
77  
78     DisablePlot (me)
79         ---Purpose: Forbids the drawing on a plotter of the graphic object
80         -- aPresentableObject with the display mode aMode.
81     is static private;
82     
83     IsPlottable (me)
84     returns Boolean from Standard
85         ---Purpose: Returns true if the graphic object aPresentableObject
86         -- with the display mode aMode can be plotted.
87     is static private;
88
89     SetOffset (me: mutable;anOffset: Integer from Standard)
90     is static ;
91         ---Purpose: Specifies an Offset applied to the original color
92         --          index of all primitives in the graphic object <me>.
93         --  Warning: To reset the real color of the primitives
94         --          you have to call this method with <anOffset> = 0.
95
96     Offset (me) returns Integer from Standard
97     is static ;
98         ---Level: Public
99         ---Purpose: Returns the Offset applied to the original color
100         --          index of all primitives in the graphic object <me>.
101         ---Category: Methods to manage the highlight
102
103     Presentation (me) returns mutable GraphicObject from Graphic2d
104     is static ;
105
106 fields
107
108     myStructure: GraphicObject from Graphic2d;
109
110 friends 
111     class PresentationManager2d from PrsMgr,
112     class PresentableObject from PrsMgr
113
114 end Presentation2d from PrsMgr;