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

/** \details
  
  A helper class to work with finish bumps part of Stone appearance schema.
*/
class MATERIALREADER_EXPORT OdStoneAppearanceSchemaFinishBumps : public OdFinishBumpsSchemaHelper
{
public:
  /** \details
    Default constructor.
    
    \param pAsset [in] Input Smart pointer to asset object of Appearance asset which contains appearance schema data.
  */
  OdStoneAppearanceSchemaFinishBumps(const OdAssetPtr& pAsset) :OdFinishBumpsSchemaHelper(pAsset) {}

  /** \details
    Retrieves a type of relief pattern of stone.
    
    \param OdMaterial::StoneReliefType [out] Output value of pattern type.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getPatternType(OdMaterial::StoneReliefType&) const;

  /** \details
    Sets the type of relief pattern of stone.
    
    \param OdMaterial::StoneReliefType [in] Input value of pattern type.
  */
  void setPatternType(const OdMaterial::StoneReliefType);

private:
  // hide default methods
  OdResult getPatternType(OdInt32&) const;
  void setPatternType(const OdInt32&);
};