// 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_VisMaterialCommon_HeaderFile
#define _XCAFDoc_VisMaterialCommon_HeaderFile

#include <Graphic3d_AlphaMode.hxx>
#include <Graphic3d_Vec.hxx>
#include <Image_Texture.hxx>
#include <Quantity_ColorRGBA.hxx>
#include <Standard_Dump.hxx>

class Graphic3d_Aspects;
class Graphic3d_MaterialAspect;

//! Common (obsolete) material definition.
struct XCAFDoc_VisMaterialCommon
{
  Handle(Image_Texture)   DiffuseTexture;  //!< image defining diffuse color
  Quantity_Color          AmbientColor;    //!< ambient  color
  Quantity_Color          DiffuseColor;    //!< diffuse  color
  Quantity_Color          SpecularColor;   //!< specular color
  Quantity_Color          EmissiveColor;   //!< emission color
  Standard_ShortReal      Shininess;       //!< shininess value
  Standard_ShortReal      Transparency;    //!< transparency value within [0, 1] range with 0 meaning opaque
  Standard_Boolean        IsDefined;       //!< defined flag; FALSE by default

  //! Empty constructor.
  XCAFDoc_VisMaterialCommon()
  : AmbientColor (0.1, 0.1, 0.1, Quantity_TOC_RGB),
    DiffuseColor (0.8, 0.8, 0.8, Quantity_TOC_RGB),
    SpecularColor(0.2, 0.2, 0.2, Quantity_TOC_RGB),
    EmissiveColor(0.0, 0.0, 0.0, Quantity_TOC_RGB),
    Shininess (1.0f),
    Transparency (0.0f),
    IsDefined (Standard_False) {}

  //! Compare two materials.
  Standard_Boolean IsEqual (const XCAFDoc_VisMaterialCommon& theOther) const
  {
    if (&theOther == this)
    {
      return true;
    }
    else if (theOther.IsDefined != IsDefined)
    {
      return false;
    }
    else if (!IsDefined)
    {
      return true;
    }

    return theOther.DiffuseTexture  == DiffuseTexture
        && theOther.AmbientColor    == AmbientColor
        && theOther.DiffuseColor    == DiffuseColor
        && theOther.SpecularColor   == SpecularColor
        && theOther.EmissiveColor   == EmissiveColor
        && theOther.Shininess       == Shininess
        && theOther.Transparency    == Transparency;
  }

  //! Dumps the content of me into the stream
  void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const
  {
    OCCT_DUMP_CLASS_BEGIN (theOStream, XCAFDoc_VisMaterialCommon)

    OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, DiffuseTexture.get())

    OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &AmbientColor)
    OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &DiffuseColor)
    OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &SpecularColor)
    OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &EmissiveColor)

    OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, Shininess)
    OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, Transparency)
    OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, IsDefined)
  }
}; 

#endif // _XCAFDoc_VisMaterialCommon_HeaderFile