///////////////////////////////////////////////////////////////////////////////
// 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 relief part of SolidGlass appearance schema.
*/
class MATERIALREADER_EXPORT OdSolidGlassAppearanceSchemaRelief
  : public OdFinishBumpsSchemaHelper {
public:
  using OdFinishBumpsSchemaHelper::OdFinishBumpsSchemaHelper;
  /** \details
    Retrieves the type of decorative design (relief pattern) pressed onto the surface of the metal.
    
    \param OdMaterial::SolidGlassPatternType [out] Output value of solid glass pattern type.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getPatternType(OdMaterial::SolidGlassPatternType&) const;

  /** \details
    Sets the relief pattern of the metal surface.
    
    \param OdMaterial::SolidGlassPatternType [in] Input value of solid glass pattern type.
  */
  void setPatternType(const OdMaterial::SolidGlassPatternType);

  /** \details
    Sets the relative height of the relief pattern.
    
    \param double [in] Input double value between 0 (flat pattern) and 2.
  */
  void setHeight(const double&);

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