0027816: Visualization - provide an API for overriding clipping planes list
[occt.git] / src / OpenGl / OpenGl_SetOfShaderPrograms.hxx
1 // Created on: 2014-10-08
2 // Created by: Kirill Gavrilov
3 // Copyright (c) 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_SetOfShaderPrograms_HeaderFile
17 #define _OpenGl_SetOfShaderPrograms_HeaderFile
18
19 #include <NCollection_DataMap.hxx>
20 #include <OpenGl_ShaderProgram.hxx>
21
22 //! Standard GLSL program combination bits.
23 enum OpenGl_ProgramOptions
24 {
25   OpenGl_PO_Point       = 0x001, //!< point marker
26   OpenGl_PO_VertColor   = 0x002, //!< per-vertex color
27   OpenGl_PO_TextureRGB  = 0x004, //!< handle RGB   texturing
28   OpenGl_PO_TextureA    = 0x008, //!< handle Alpha texturing
29   OpenGl_PO_TextureEnv  = 0x010, //!< handle environment map
30   OpenGl_PO_StippleLine = 0x020, //!< stipple line
31   OpenGl_PO_ClipPlanes1 = 0x040, //!< handle 1 clipping plane
32   OpenGl_PO_ClipPlanes2 = 0x080, //!< handle 2 clipping planes
33   OpenGl_PO_ClipPlanesN = 0x100, //!< handle N clipping planes
34   OpenGl_PO_NB          = 0x200  //!< overall number of combinations
35 };
36
37 //! Alias to programs array of predefined length
38 class OpenGl_SetOfShaderPrograms : public Standard_Transient
39 {
40
41 public:
42
43   //! Empty constructor
44   OpenGl_SetOfShaderPrograms() {}
45
46   //! Access program by index
47   Handle(OpenGl_ShaderProgram)& ChangeValue (const Standard_Integer theIndex) { return myPrograms[theIndex]; }
48
49 protected:
50
51   Handle(OpenGl_ShaderProgram) myPrograms[OpenGl_PO_NB]; //!< programs array
52
53 public:
54
55   DEFINE_STANDARD_RTTI_INLINE(OpenGl_SetOfShaderPrograms,Standard_Transient)
56
57 };
58
59 DEFINE_STANDARD_HANDLE(OpenGl_SetOfShaderPrograms, Standard_Transient)
60
61 typedef NCollection_DataMap<TCollection_AsciiString, Handle(OpenGl_SetOfShaderPrograms)> OpenGl_MapOfShaderPrograms;
62
63 #endif // _OpenGl_SetOfShaderPrograms_HeaderFile