///////////////////////////////////////////////////////////////////////////////
// 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 Metal appearance schema.
*/
class MATERIALREADER_EXPORT OdMetalAppearanceSchema
  : public OdAppearanceSchemaBaseHelper {
public:
  using OdAppearanceSchemaBaseHelper::OdAppearanceSchemaBaseHelper;

  /** \details
    Retrieves metal type.
    
    \param OdMaterial::MetalType [out] Outputn enum value that contains the metal type.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getType(OdMaterial::MetalType&) const;

  /** \details
    Sets the metal type.
    
    \param OdMaterial::MetalType [in] Inputn enum value that contains the metal type.
  */
  void setType(const OdMaterial::MetalType);

  /** \details
    Retrieves type of metal finish.
    
    \param OdMaterial::MetalFinishType [out] Outputn enum value that contains the type of metal finish.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getFinishType(OdMaterial::MetalFinishType&) const;

  /** \details
    Sets the type of metal finish.
    
    \param OdMaterial::MetalFinishType [in] Inputn enum value that contains the type of metal finish.
  */
  void setFinishType(const OdMaterial::MetalFinishType);

  /** \details
    Retrieves the degree of discoloration as result of oxidation or the application of a chemical compound. Applicable for copper or bronze.
    
    \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 getPatinaDegree(double&) const;

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

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

  /** \details
    Sets the color of the metal.
    
    \param OdCmEntityColor [in] Input color of the metal.
  */
  void setColor(const OdCmEntityColor&);
};