8586690c8ac97c5b84efc9a7c743135a162fcd3f
[occt.git] / src / AIS / AIS_LocalStatus.hxx
1 // Created on: 1997-01-20
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 #ifndef _AIS_LocalStatus_HeaderFile
18 #define _AIS_LocalStatus_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Boolean.hxx>
24 #include <Standard_Integer.hxx>
25 #include <TColStd_ListOfInteger.hxx>
26 #include <Quantity_NameOfColor.hxx>
27 #include <MMgt_TShared.hxx>
28 class Standard_Transient;
29
30
31 class AIS_LocalStatus;
32 DEFINE_STANDARD_HANDLE(AIS_LocalStatus, MMgt_TShared)
33
34 //! Stored Info about temporary objects.
35 class AIS_LocalStatus : public MMgt_TShared
36 {
37
38 public:
39
40   
41   Standard_EXPORT AIS_LocalStatus(const Standard_Boolean IsTemporary = Standard_True, const Standard_Boolean Decompose = Standard_False, const Standard_Integer DisplayMode = -1, const Standard_Integer SelectionMode = -1, const Standard_Integer HilightMode = 0, const Standard_Boolean SubIntensity = 0, const Quantity_NameOfColor TheHiCol = Quantity_NOC_WHITE);
42   
43     Standard_Boolean Decomposed() const;
44   
45     Standard_Boolean IsTemporary() const;
46   
47     Standard_Integer DisplayMode() const;
48   
49     const TColStd_ListOfInteger& SelectionModes() const;
50   
51   Standard_EXPORT Standard_Boolean IsActivated (const Standard_Integer aSelMode) const;
52   
53     Standard_Integer HilightMode() const;
54   
55     Standard_Boolean IsSubIntensityOn() const;
56   
57     Quantity_NameOfColor HilightColor() const;
58   
59     void SetDecomposition (const Standard_Boolean astatus);
60   
61     void SetTemporary (const Standard_Boolean astatus);
62   
63     void SetDisplayMode (const Standard_Integer aMode);
64   
65     void SetFirstDisplay (const Standard_Boolean aStatus);
66   
67     Standard_Boolean IsFirstDisplay() const;
68   
69   Standard_EXPORT void AddSelectionMode (const Standard_Integer aMode);
70   
71   Standard_EXPORT void RemoveSelectionMode (const Standard_Integer aMode);
72   
73   Standard_EXPORT void ClearSelectionModes();
74   
75   Standard_EXPORT Standard_Boolean IsSelModeIn (const Standard_Integer aMode) const;
76   
77     void SetHilightMode (const Standard_Integer aMode);
78   
79     void SetHilightColor (const Quantity_NameOfColor aHiCol);
80   
81     void SubIntensityOn();
82   
83     void SubIntensityOff();
84   
85     void SetPreviousState (const Handle(Standard_Transient)& aStatus);
86   
87     const Handle(Standard_Transient)& PreviousState() const;
88
89
90
91
92   DEFINE_STANDARD_RTTIEXT(AIS_LocalStatus,MMgt_TShared)
93
94 protected:
95
96
97
98
99 private:
100
101
102   Standard_Boolean myDecomposition;
103   Standard_Boolean myIsTemporary;
104   Standard_Integer myDMode;
105   Standard_Boolean myFirstDisplay;
106   Standard_Integer myHMode;
107   TColStd_ListOfInteger mySModes;
108   Standard_Boolean mySubIntensity;
109   Quantity_NameOfColor myHiCol;
110   Handle(Standard_Transient) myPreviousState;
111
112
113 };
114
115
116 #include <AIS_LocalStatus.lxx>
117
118
119
120
121
122 #endif // _AIS_LocalStatus_HeaderFile