///////////////////////////////////////////////////////////////////////////////
// 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 Hardwood appearance schema.
*/
class MATERIALREADER_EXPORT OdHardwoodAppearanceSchema
  : public OdAppearanceSchemaBaseHelper {
public:
  using OdAppearanceSchemaBaseHelper::OdAppearanceSchemaBaseHelper;
  /** \details
    Retrieves hardwood appearance pattern.
    
    \param OdAssetPtr [in] Input properties asset.
    \returns An OdResult value: eOk if schema contains a diffuse pattern, eNotApplicable if not.
  */
  OdResult getAppearancePattern(OdAssetPtr&) const;

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

  /** \details
    Retrieves a type of hardwood finish adjustment.
    
    \param OdMaterial::HardwoodFinishType [out] Output type of hardwood finish adjustment.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getFinishType(OdMaterial::HardwoodFinishType&) const;

  /** \details
    Sets the type of material.
    
    \param OdMaterial::HardwoodFinishType [in] Input type of hardwood finish adjustment.
  */
  void setFinishType(const OdMaterial::HardwoodFinishType);

  /** \details
    Retrieves true if wood is stained.
    
    \param bool [out] Output value containing stain status of the hardwood.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getStain(bool&) const;

  /** \details
    Set true if wood is stained.
    
    \param bool [in] Input A value containing stain status of the hardwood.
  */
  void setStain(bool);

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

  /** \details
    Sets the stain color of the hardwood.
    
    \param OdCmEntityColor [in] Input stain color.
  */
  void setStainColor(const OdCmEntityColor&);

  /** \details
    Retrieves a type how the wood surface gets used.
    
    \param OdMaterial::HardwoodUseType [out] Output value of flooring or furniture.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getUsedFor(OdMaterial::HardwoodUseType&) const;

  /** \details
    Sets the type how the wood surface gets used.
    
    \param OdMaterial::HardwoodUseType [in] Input type of flooring or furniture.
  */
  void setUsedFor(const OdMaterial::HardwoodUseType);
};