0024624: Lost word in license statement in source files
[occt.git] / src / AIS / AIS_GlobalStatus.cdl
1 -- Created on: 1997-01-24
2 -- Created by: Robert COUBLANC
3 -- Copyright (c) 1997-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 private class GlobalStatus from AIS inherits TShared from MMgt
18
19         ---Purpose: Stores  information  about objects in graphic context:
20         --          - Status Of Display : in the main viewer 
21         --                                hidden in the main viewer
22         --          - Displayed Modes 
23         --          - Active Selection Modes
24         --          - is the Interactive Object Current ?
25         --          - Layer Index
26
27 uses 
28     ListOfInteger from TColStd,
29     DisplayStatus from AIS,
30     NameOfColor from Quantity
31
32 is
33
34     Create returns mutable GlobalStatus from AIS;
35
36     Create (aStat             : DisplayStatus from AIS;
37             aDispMode,aSelMode: Integer from Standard;
38             ishilighted       : Boolean from Standard=Standard_False;
39             TheHiCol          : NameOfColor from Quantity = Quantity_NOC_WHITE;
40             aLayerIndex       : Integer from Standard = 0)
41             returns mutable GlobalStatus from AIS;
42
43                     ---Category: Modifications.
44
45     SetGraphicStatus(me:mutable; aStat :  DisplayStatus from AIS);
46     ---C++: inline
47     AddDisplayMode(me:mutable; aMode: Integer from Standard);
48     ---C++: inline    
49     AddSelectionMode(me:mutable; aMode : Integer from Standard);
50     ---C++: inline    
51     SetLayerIndex (me: mutable ; AnIndex : Integer from Standard);
52     ---C++: inline  
53     SetHilightStatus (me: mutable; aStat:Boolean from Standard);
54     ---C++: inline    
55     SetHilightColor(me:mutable;aHiCol : NameOfColor from Quantity);
56     ---C++: inline    
57
58
59
60     IsSubIntensityOn(me) returns Boolean from Standard;
61     ---C++: inline
62     SubIntensityOn (me: mutable);
63     ---C++: inline    
64     SubIntensityOff (me: mutable);
65     ---C++: inline    
66
67     
68
69     RemoveDisplayMode(me:mutable; aMode : Integer from Standard);
70
71     RemoveSelectionMode(me:mutable; aMode : Integer from Standard);
72     ClearSelectionModes(me:mutable);
73
74
75                     ---Category: Information.
76
77    
78     GraphicStatus(me) returns DisplayStatus from AIS;
79     ---C++: inline
80             
81     DisplayedModes(me) returns ListOfInteger from TColStd;
82     ---C++: return const &
83     ---C++: inline
84     ---Purpose: keeps the information of displayed modes in the 
85     --          main viewer.
86
87     SelectionModes(me) returns ListOfInteger from TColStd;
88     ---C++: return const &
89     ---C++: inline
90     ---Purpose: keeps the active selection modes of the object
91     --          in the main viewer.
92
93     IsHilighted(me) returns Boolean from Standard;
94     ---C++: inline
95
96     HilightColor(me) returns NameOfColor from Quantity;
97     ---C++: inline
98
99     IsDModeIn(me; aMode : Integer from Standard) returns Boolean from Standard;
100
101     IsSModeIn(me; aMode : Integer from Standard) returns Boolean from Standard;
102     
103     
104 fields
105
106     myStatus     : DisplayStatus from AIS;
107     myDispModes  : ListOfInteger from TColStd;
108     mySelModes   : ListOfInteger from TColStd;
109     myLayerIndex : Integer       from Standard;
110     myIsHilit    : Boolean       from Standard;
111     myHiCol      : NameOfColor   from Quantity;
112     mySubInt     : Boolean;
113 end GlobalStatus;