0029902: Data Exchange, XCAF - provide extended Material definition for visualization...
[occt.git] / src / XCAFDoc / XCAFDoc_VisMaterialPBR.hxx
1 // Copyright (c) 2019 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _XCAFDoc_VisMaterialPBR_HeaderFile
15 #define _XCAFDoc_VisMaterialPBR_HeaderFile
16
17 #include <Graphic3d_AlphaMode.hxx>
18 #include <Graphic3d_Vec.hxx>
19 #include <Image_Texture.hxx>
20 #include <Quantity_ColorRGBA.hxx>
21
22 //! Metallic-roughness PBR material definition.
23 struct XCAFDoc_VisMaterialPBR
24 {
25   Handle(Image_Texture)   BaseColorTexture;         //!< RGB texture for the base color
26   Handle(Image_Texture)   MetallicRoughnessTexture; //!< RG texture packing the metallic and roughness properties together
27   Handle(Image_Texture)   EmissiveTexture;          //!< RGB emissive map controls the color and intensity of the light being emitted by the material
28   Handle(Image_Texture)   OcclusionTexture;         //!< R occlusion map indicating areas of indirect lighting
29   Handle(Image_Texture)   NormalTexture;            //!< normal map
30   Quantity_ColorRGBA      BaseColor;                //!< base color (or scale factor to the texture); [1.0, 1.0, 1.0, 1.0] by default
31   Graphic3d_Vec3          EmissiveFactor;           //!< emissive color; [0.0, 0.0, 0.0] by default
32   Standard_ShortReal      Metallic;                 //!< metalness  (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
33   Standard_ShortReal      Roughness;                //!< roughness  (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
34   Standard_Boolean        IsDefined;                //!< defined flag; FALSE by default
35
36   //! Empty constructor.
37   XCAFDoc_VisMaterialPBR()
38   : BaseColor (1.0f, 1.0f, 1.0f, 1.0f),
39     EmissiveFactor (0.0f, 0.0f, 0.0f),
40     Metallic  (1.0f),
41     Roughness (1.0f),
42     IsDefined (Standard_False) {}
43
44   //! Compare two materials.
45   Standard_Boolean IsEqual (const XCAFDoc_VisMaterialPBR& theOther) const
46   {
47     if (&theOther == this)
48     {
49       return true;
50     }
51     else if (theOther.IsDefined != IsDefined)
52     {
53       return false;
54     }
55     else if (!IsDefined)
56     {
57       return true;
58     }
59
60     return theOther.BaseColorTexture == BaseColorTexture
61         && theOther.MetallicRoughnessTexture == MetallicRoughnessTexture
62         && theOther.EmissiveTexture == EmissiveTexture
63         && theOther.OcclusionTexture == OcclusionTexture
64         && theOther.NormalTexture == NormalTexture
65         && theOther.BaseColor == BaseColor
66         && theOther.EmissiveFactor == EmissiveFactor
67         && theOther.Metallic == Metallic
68         && theOther.Roughness == Roughness;
69   }
70 };
71
72 #endif // _XCAFDoc_VisMaterialPBR_HeaderFile