0029528: Visualization, TKOpenGl - allow defining sRGB textures
[occt.git] / src / OpenGl / OpenGl_Material.hxx
1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2013 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_Material_Header
17 #define _OpenGl_Material_Header
18
19 #include <Graphic3d_MaterialAspect.hxx>
20 #include <OpenGl_Vec.hxx>
21
22 class OpenGl_Context;
23
24 //! OpenGL material definition
25 struct OpenGl_Material
26 {
27
28   OpenGl_Vec4 Ambient;  //!< ambient reflection coefficient
29   OpenGl_Vec4 Diffuse;  //!< diffuse reflection coefficient
30   OpenGl_Vec4 Specular; //!< glossy  reflection coefficient
31   OpenGl_Vec4 Emission; //!< material emission
32   OpenGl_Vec4 Params;   //!< extra packed parameters
33
34   float  Shine()        const { return Params.x(); }
35   float& ChangeShine()        { return Params.x(); }
36
37   float  Transparency() const { return Params.y(); }
38   float& ChangeTransparency() { return Params.y(); }
39
40   //! Set material color.
41   void SetColor (const OpenGl_Vec4& theColor)
42   {
43     // apply the same formula as in Graphic3d_MaterialAspect::SetColor()
44     Ambient.SetValues (theColor.rgb() * 0.25f, Ambient.a());
45     Diffuse.SetValues (theColor.rgb(), Diffuse.a());
46   }
47
48   //! Empty constructor.
49   OpenGl_Material()
50   : Ambient (1.0f),
51     Diffuse (1.0f),
52     Specular(1.0f),
53     Emission(1.0f),
54     Params  (1.0f, 0.0f, 0.0f, 0.0f) {}
55
56   //! Initialize material
57   void Init (const OpenGl_Context& theCtx,
58              const Graphic3d_MaterialAspect& theProp,
59              const Quantity_Color& theInteriorColor);
60
61   //! Returns packed (serialized) representation of material properties
62   const OpenGl_Vec4* Packed() const { return reinterpret_cast<const OpenGl_Vec4*> (this); }
63   static Standard_Integer NbOfVec4() { return 5; }
64
65   //! Check this material for equality with another material (without tolerance!).
66   bool IsEqual (const OpenGl_Material& theOther) const
67   {
68     return std::memcmp (this, &theOther, sizeof(OpenGl_Material)) == 0;
69   }
70
71   //! Check this material for equality with another material (without tolerance!).
72   bool operator== (const OpenGl_Material& theOther)       { return IsEqual (theOther); }
73   bool operator== (const OpenGl_Material& theOther) const { return IsEqual (theOther); }
74
75   //! Check this material for non-equality with another material (without tolerance!).
76   bool operator!= (const OpenGl_Material& theOther)       { return !IsEqual (theOther); }
77   bool operator!= (const OpenGl_Material& theOther) const { return !IsEqual (theOther); }
78
79 };
80
81 //! Material flag
82 enum OpenGl_MaterialFlag
83 {
84   OpenGl_MaterialFlag_Front, //!< material for front faces
85   OpenGl_MaterialFlag_Back   //!< material for back  faces
86 };
87
88 #endif // _OpenGl_Material_Header