0027670: Visualization - avoid duplication of structures defining primitive array...
[occt.git] / src / OpenGl / OpenGl_ShaderStates.hxx
1 // Created on: 2013-10-02
2 // Created by: Denis BOGOLEPOV
3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _OpenGl_State_HeaderFile
17 #define _OpenGl_State_HeaderFile
18
19 #include <NCollection_List.hxx>
20 #include <OpenGl_Element.hxx>
21 #include <OpenGl_Light.hxx>
22 #include <OpenGl_Vec.hxx>
23
24 //! Defines interface for OpenGL state.
25 class OpenGl_StateInterface
26 {
27 public:
28
29   //! Creates new state.
30   OpenGl_StateInterface();
31
32   //! Returns current state index.
33   Standard_Size Index() const { return myIndex; }
34
35   //! Increment current state.
36   void Update() { ++myIndex; }
37
38 protected:
39
40   Standard_Size myIndex; //!< current state index
41
42 };
43
44 //! Defines state of OCCT projection transformation.
45 class OpenGl_ProjectionState : public OpenGl_StateInterface
46 {
47 public:
48
49   //! Creates uninitialized projection state.
50   OpenGl_ProjectionState();
51
52   //! Sets new projection matrix.
53   void Set (const OpenGl_Mat4& theProjectionMatrix);
54
55   //! Returns current projection matrix.
56   const OpenGl_Mat4& ProjectionMatrix() const;
57
58   //! Returns inverse of current projection matrix.
59   const OpenGl_Mat4& ProjectionMatrixInverse() const;
60
61 private:
62
63   OpenGl_Mat4         myProjectionMatrix;        //!< OCCT projection matrix
64   mutable OpenGl_Mat4 myProjectionMatrixInverse; //!< Inverse of OCCT projection matrix
65   bool                myInverseNeedUpdate;       //!< Is inversed matrix outdated?
66
67 };
68
69 //! Defines state of OCCT model-world transformation.
70 class OpenGl_ModelWorldState : public OpenGl_StateInterface
71 {
72 public:
73
74   //! Creates uninitialized model-world state.
75   OpenGl_ModelWorldState();
76
77   //! Sets new model-world matrix.
78   void Set (const OpenGl_Mat4& theModelWorldMatrix);
79
80   //! Returns current model-world matrix.
81   const OpenGl_Mat4& ModelWorldMatrix() const;
82
83   //! Returns inverse of current model-world matrix.
84   const OpenGl_Mat4& ModelWorldMatrixInverse() const;
85
86 private:
87
88   OpenGl_Mat4         myModelWorldMatrix;        //!< OCCT model-world matrix
89   mutable OpenGl_Mat4 myModelWorldMatrixInverse; //!< Inverse of OCCT model-world matrix
90   bool                myInverseNeedUpdate;       //!< Is inversed matrix outdated?
91   
92 };
93
94 //! Defines state of OCCT world-view transformation.
95 class OpenGl_WorldViewState : public OpenGl_StateInterface
96 {
97 public:
98
99   //! Creates uninitialized world-view state.
100   OpenGl_WorldViewState();
101
102   //! Sets new world-view matrix.
103   void Set (const OpenGl_Mat4& theWorldViewMatrix);
104
105   //! Returns current world-view matrix.
106   const OpenGl_Mat4& WorldViewMatrix() const;
107
108   //! Returns inverse of current world-view matrix.
109   const OpenGl_Mat4& WorldViewMatrixInverse() const;
110
111 private:
112
113   OpenGl_Mat4         myWorldViewMatrix;        //!< OCCT world-view matrix
114   mutable OpenGl_Mat4 myWorldViewMatrixInverse; //!< Inverse of OCCT world-view matrix
115   bool                myInverseNeedUpdate;      //!< Is inversed matrix outdated?
116
117 };
118
119 //! Defines state of OCCT light sources.
120 class OpenGl_LightSourceState : public OpenGl_StateInterface
121 {
122 public:
123
124   //! Creates uninitialized state of light sources.
125   OpenGl_LightSourceState();
126
127   //! Sets new light sources.
128   void Set (const OpenGl_ListOfLight* theLightSources);
129
130   //! Returns current list of light sources.
131   const OpenGl_ListOfLight* LightSources() const;
132
133 private:
134
135   const OpenGl_ListOfLight* myLightSources; //!< List of OCCT light sources
136
137 };
138
139 //! Defines generic state of OCCT material properties.
140 class OpenGl_MaterialState : public OpenGl_StateInterface
141 {
142 public:
143
144   //! Creates new material state.
145   OpenGl_MaterialState (const OpenGl_Element* theAspect = NULL);
146
147   //! Sets new material aspect.
148   void Set (const OpenGl_Element* theAspect);
149
150   //! Returns material aspect.
151   const OpenGl_Element* Aspect() const;
152
153 private:
154
155   const OpenGl_Element* myAspect; //!< OCCT material aspect
156
157 };
158
159 //! Defines generic state of OCCT clipping state.
160 class OpenGl_ClippingState
161 {
162 public:
163
164   //! Creates new clipping state.
165   OpenGl_ClippingState();
166
167   //! Returns current state index.
168   Standard_Size Index() const { return myIndex; }
169
170   //! Updates current state.
171   void Update();
172
173   //! Reverts current state.
174   void Revert();
175
176 protected:
177
178   Standard_Size                   myIndex;      //!< Current state index
179   Standard_Size                   myNextIndex;  //!< Next    state index
180   NCollection_List<Standard_Size> myStateStack; //!< Stack of previous states
181
182 };
183
184 #endif // _OpenGl_State_HeaderFile