///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a license
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
#pragma once

#include "OdAppearanceSchemaBaseHelper.h"

/** \details
  
  A helper class to work with base part of Solid Glass appearance schema.
*/
class MATERIALREADER_EXPORT OdSolidGlassAppearanceSchema
  : public OdAppearanceSchemaBaseHelper {
public:
  using OdAppearanceSchemaBaseHelper::OdAppearanceSchemaBaseHelper;
  /** \details
    Retrieves a predefined Glazing color.
    
    \param OdMaterial::GlassColor [out] Outputn enum value that contains the id of predefined Glazing color.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.  
  */
  OdResult getColor(OdMaterial::GlassColor&) const;

  /** \details
    Retrieves the calculated Glazing color.

    \param OdCmEntityColor [out] Output color value calculated using id of the predefined Glazing color.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getColor(OdCmEntityColor&) const;

  /** \details
    Sets the predefined Glazing color.
    
    \param OdMaterial::GlassColor [in] Inputn enum value that contains the id of predefined Glazing color.
  */
  void setColor(const OdMaterial::GlassColor);

  /** \details
    Retrieves a color of the Glazing.
    
    \param OdCmEntityColor [out] Output color of the Glazing.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getCustomColor(OdCmEntityColor&) const;

  /** \details
    Sets the custom color of the Glazing.
    
    \param OdCmEntityColor [in] Input custom color of the Glazing.
  */
  void setCustomColor(const OdCmEntityColor&);

  /** \details
    Retrieves a pattern of custom color of the Glazing.
    
    \param OdAssetPtr [out] Output pattern of custom color of the Glazing.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getCustomColorMap(OdAssetPtr&) const;

  /** \details
    Sets the pattern of custom color of the Glazing.
    
    \param OdAssetPtr [in] Input pattern of custom color of the Glazing.
  */
  void setCustomColorMap(const OdAssetPtr&);

  /** \details
    Retrieves the amount of light that is reflected from the surface of the glass rather than passed through it.
    
    \param double [out] Output double value between 0 (none) and 1 (full).
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.   
  */
  OdResult getReflectance(double&) const;

  /** \details
    Sets the reflectance level.
    
    \param double [in] Input double value between 0 (none) and 1 (full).
  */
  void setReflectance(const double&);

  /** \details
    Retrieves a light bends factor when the light passes through the material.
    
    \param double [out] Output value of refraction: 0 (no refraction) and 5 (most refraction).
    \returns An OdResult value: eOk if schema contains a refraction, eNotApplicable if not.   
  */
  OdResult getRefraction(double&) const;

  /** \details
    Sets the light bends factor.
    
    \param double [in] Input composite value
  */
  void setRefraction(const double&);

  /** \details
    Retrieves the roughness of the glass.
    
    \param double [out] Output value between 0 (smooth, shiny glass) and 1 (frosted glass).
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getRoughness(double&) const;

  /** \details
    Sets the roughness of the glass.
    
    \param dounble [in] Input value between 0 (smooth, shiny glass) and 1 (frosted glass).
  */
  void setRoughness(const double&);
};