0027961: Visualization - remove unused and no more working OpenGl_AVIWriter
[occt.git] / src / OpenGl / OpenGl_ShaderStates.hxx
CommitLineData
30f0ad28 1// Created on: 2013-10-02
2// Created by: Denis BOGOLEPOV
d5f74e42 3// Copyright (c) 2013-2014 OPEN CASCADE SAS
30f0ad28 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
30f0ad28 6//
d5f74e42 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
973c2be1 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.
30f0ad28 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
30f0ad28 15
16#ifndef _OpenGl_State_HeaderFile
17#define _OpenGl_State_HeaderFile
18
e135a155 19#include <NCollection_List.hxx>
30f0ad28 20#include <OpenGl_Element.hxx>
21#include <OpenGl_Light.hxx>
c827ea3a 22#include <OpenGl_Vec.hxx>
ca102800 23
30f0ad28 24//! Defines interface for OpenGL state.
25class OpenGl_StateInterface
26{
27public:
28
8cf06aa2 29 //! Creates new state.
30f0ad28 30 OpenGl_StateInterface();
31
32 //! Returns current state index.
8cf06aa2 33 Standard_Size Index() const { return myIndex; }
30f0ad28 34
8cf06aa2 35 //! Increment current state.
36 void Update() { ++myIndex; }
30f0ad28 37
38protected:
39
8cf06aa2 40 Standard_Size myIndex; //!< current state index
30f0ad28 41
42};
43
44//! Defines state of OCCT projection transformation.
45class OpenGl_ProjectionState : public OpenGl_StateInterface
46{
47public:
48
49 //! Creates uninitialized projection state.
50 OpenGl_ProjectionState();
51
52 //! Sets new projection matrix.
c827ea3a 53 void Set (const OpenGl_Mat4& theProjectionMatrix);
30f0ad28 54
55 //! Returns current projection matrix.
c827ea3a 56 const OpenGl_Mat4& ProjectionMatrix() const;
30f0ad28 57
58 //! Returns inverse of current projection matrix.
c827ea3a 59 const OpenGl_Mat4& ProjectionMatrixInverse() const;
30f0ad28 60
61private:
62
c827ea3a 63 OpenGl_Mat4 myProjectionMatrix; //!< OCCT projection matrix
64 mutable OpenGl_Mat4 myProjectionMatrixInverse; //!< Inverse of OCCT projection matrix
65 bool myInverseNeedUpdate; //!< Is inversed matrix outdated?
30f0ad28 66
67};
68
69//! Defines state of OCCT model-world transformation.
70class OpenGl_ModelWorldState : public OpenGl_StateInterface
71{
72public:
73
74 //! Creates uninitialized model-world state.
75 OpenGl_ModelWorldState();
76
77 //! Sets new model-world matrix.
c827ea3a 78 void Set (const OpenGl_Mat4& theModelWorldMatrix);
30f0ad28 79
80 //! Returns current model-world matrix.
c827ea3a 81 const OpenGl_Mat4& ModelWorldMatrix() const;
30f0ad28 82
83 //! Returns inverse of current model-world matrix.
c827ea3a 84 const OpenGl_Mat4& ModelWorldMatrixInverse() const;
30f0ad28 85
86private:
87
c827ea3a 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?
30f0ad28 91
92};
93
94//! Defines state of OCCT world-view transformation.
95class OpenGl_WorldViewState : public OpenGl_StateInterface
96{
97public:
98
99 //! Creates uninitialized world-view state.
100 OpenGl_WorldViewState();
e135a155 101
30f0ad28 102 //! Sets new world-view matrix.
c827ea3a 103 void Set (const OpenGl_Mat4& theWorldViewMatrix);
30f0ad28 104
105 //! Returns current world-view matrix.
c827ea3a 106 const OpenGl_Mat4& WorldViewMatrix() const;
30f0ad28 107
108 //! Returns inverse of current world-view matrix.
c827ea3a 109 const OpenGl_Mat4& WorldViewMatrixInverse() const;
30f0ad28 110
111private:
112
c827ea3a 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?
30f0ad28 116
117};
118
119//! Defines state of OCCT light sources.
120class OpenGl_LightSourceState : public OpenGl_StateInterface
121{
122public:
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
133private:
134
135 const OpenGl_ListOfLight* myLightSources; //!< List of OCCT light sources
136
137};
138
139//! Defines generic state of OCCT material properties.
140class OpenGl_MaterialState : public OpenGl_StateInterface
141{
142public:
143
144 //! Creates new material state.
145 OpenGl_MaterialState (const OpenGl_Element* theAspect = NULL);
e135a155 146
30f0ad28 147 //! Sets new material aspect.
148 void Set (const OpenGl_Element* theAspect);
149
150 //! Returns material aspect.
151 const OpenGl_Element* Aspect() const;
152
153private:
154
155 const OpenGl_Element* myAspect; //!< OCCT material aspect
156
157};
158
159//! Defines generic state of OCCT clipping state.
8cf06aa2 160class OpenGl_ClippingState
30f0ad28 161{
162public:
163
164 //! Creates new clipping state.
165 OpenGl_ClippingState();
166
8cf06aa2 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
176protected:
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
30f0ad28 182};
183
184#endif // _OpenGl_State_HeaderFile