///////////////////////////////////////////////////////////////////////////////
// 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 "OdAppearanceSchemaHelper.h"

/** \details
  
  A helper class to work with base part of Ceramic appearance schema.
*/
class MATERIALREADER_EXPORT OdCeramicAppearanceSchema
  : public OdAppearanceSchemaBaseHelper {
public:
  using OdAppearanceSchemaBaseHelper::OdAppearanceSchemaBaseHelper;
  /** \details
    Retrieves a type of material.
    
    \param OdMaterial::CeramicType [out] Output value of solid glass pattern type.
    \returns An OdResult value: eOk if the value can be retrieved, eNotApplicable if not.
  */
  OdResult getCeramicType(OdMaterial::CeramicType&) const;

  /** \details
    Sets the type of material.
    
    \param OdMaterial::CeramicType [in] Input value of ceramic or porcelain.
  */
  void setCeramicType(const OdMaterial::CeramicType&);

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

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

  /** \details
    Retrieves ceramic appearance pattern.
    
    \param OdAssetPtr [in] Input properties asset.
    \returns An OdResult value: eOk if the value can be retrieved, eNotApplicable if not.
  */
  OdResult getAppearancePattern(OdAssetPtr&) const;

  /** \details
    Sets the ceramic appearance pattern.
    
    \param OdAssetPtr [in] Input ceramic appearance pattern.
  */
  void setAppearancePattern(const OdAssetPtr&);

  /** \details
    Retrieves a type of ceramic finish adjustment.
    
    \param OdMaterial::CeramicFinishType [out] Output type of ceramic finish adjustment.
    \returns An OdResult value: eOk if the value can be retrieved, eNotApplicable if not.
  */
  OdResult getFinish(OdMaterial::CeramicFinishType&) const;
  /** \details
    Sets the type of finish adjustment of ceramic material.
    
    \param OdMaterial::CeramicFinishType [in] Input type of ceramic finish adjustment.
  */
  void setFinish(const OdMaterial::CeramicFinishType);
};