0029902: Data Exchange, XCAF - provide extended Material definition for visualization...
[occt.git] / src / XCAFDoc / XCAFDoc_VisMaterialPBR.hxx
diff --git a/src/XCAFDoc/XCAFDoc_VisMaterialPBR.hxx b/src/XCAFDoc/XCAFDoc_VisMaterialPBR.hxx
new file mode 100644 (file)
index 0000000..bbe3d3c
--- /dev/null
@@ -0,0 +1,72 @@
+// Copyright (c) 2019 OPEN CASCADE SAS
+//
+// This file is part of Open CASCADE Technology software library.
+//
+// This library is free software; you can redistribute it and/or modify it under
+// the terms of the GNU Lesser General Public License version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
+//
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
+
+#ifndef _XCAFDoc_VisMaterialPBR_HeaderFile
+#define _XCAFDoc_VisMaterialPBR_HeaderFile
+
+#include <Graphic3d_AlphaMode.hxx>
+#include <Graphic3d_Vec.hxx>
+#include <Image_Texture.hxx>
+#include <Quantity_ColorRGBA.hxx>
+
+//! Metallic-roughness PBR material definition.
+struct XCAFDoc_VisMaterialPBR
+{
+  Handle(Image_Texture)   BaseColorTexture;         //!< RGB texture for the base color
+  Handle(Image_Texture)   MetallicRoughnessTexture; //!< RG texture packing the metallic and roughness properties together
+  Handle(Image_Texture)   EmissiveTexture;          //!< RGB emissive map controls the color and intensity of the light being emitted by the material
+  Handle(Image_Texture)   OcclusionTexture;         //!< R occlusion map indicating areas of indirect lighting
+  Handle(Image_Texture)   NormalTexture;            //!< normal map
+  Quantity_ColorRGBA      BaseColor;                //!< base color (or scale factor to the texture); [1.0, 1.0, 1.0, 1.0] by default
+  Graphic3d_Vec3          EmissiveFactor;           //!< emissive color; [0.0, 0.0, 0.0] by default
+  Standard_ShortReal      Metallic;                 //!< metalness  (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
+  Standard_ShortReal      Roughness;                //!< roughness  (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
+  Standard_Boolean        IsDefined;                //!< defined flag; FALSE by default
+
+  //! Empty constructor.
+  XCAFDoc_VisMaterialPBR()
+  : BaseColor (1.0f, 1.0f, 1.0f, 1.0f),
+    EmissiveFactor (0.0f, 0.0f, 0.0f),
+    Metallic  (1.0f),
+    Roughness (1.0f),
+    IsDefined (Standard_False) {}
+
+  //! Compare two materials.
+  Standard_Boolean IsEqual (const XCAFDoc_VisMaterialPBR& theOther) const
+  {
+    if (&theOther == this)
+    {
+      return true;
+    }
+    else if (theOther.IsDefined != IsDefined)
+    {
+      return false;
+    }
+    else if (!IsDefined)
+    {
+      return true;
+    }
+
+    return theOther.BaseColorTexture == BaseColorTexture
+        && theOther.MetallicRoughnessTexture == MetallicRoughnessTexture
+        && theOther.EmissiveTexture == EmissiveTexture
+        && theOther.OcclusionTexture == OcclusionTexture
+        && theOther.NormalTexture == NormalTexture
+        && theOther.BaseColor == BaseColor
+        && theOther.EmissiveFactor == EmissiveFactor
+        && theOther.Metallic == Metallic
+        && theOther.Roughness == Roughness;
+  }
+};
+
+#endif // _XCAFDoc_VisMaterialPBR_HeaderFile