Replacing french comments by english one
[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
55     Clear(me:mutable)
56         ---Purpose: removes the whole content of the presentation.
57               
58     is redefined;
59
60     Highlight(me; anIndex: Integer from Standard) 
61     is static private;
62         
63     ---Category: 2d specialized methods.
64         
65     EnablePlot (me)
66         ---Purpose: Allows the drawing on a plotter of the graphic object
67         -- aPresentableObject with the display mode aMode.
68     is static private;
69  
70     DisablePlot (me)
71         ---Purpose: Forbids the drawing on a plotter of the graphic object
72         -- aPresentableObject with the display mode aMode.
73     is static private;
74     
75     IsPlottable (me)
76     returns Boolean from Standard
77         ---Purpose: Returns true if the graphic object aPresentableObject
78         -- with the display mode aMode can be plotted.
79     is static private;
80
81     SetOffset (me: mutable;anOffset: Integer from Standard)
82     is static ;
83         ---Purpose: Specifies an Offset applied to the original color
84         --          index of all primitives in the graphic object <me>.
85         --  Warning: To reset the real color of the primitives
86         --          you have to call this method with <anOffset> = 0.
87
88     Offset (me) returns Integer from Standard
89     is static ;
90         ---Level: Public
91         ---Purpose: Returns the Offset applied to the original color
92         --          index of all primitives in the graphic object <me>.
93         ---Category: Methods to manage the highlight
94
95     Presentation (me) returns mutable GraphicObject from Graphic2d
96     is static ;
97
98 fields
99
100     myStructure: GraphicObject from Graphic2d;
101
102 friends 
103     class PresentationManager2d from PrsMgr,
104     class PresentableObject from PrsMgr
105
106 end Presentation2d from PrsMgr;