///////////////////////////////////////////////////////////////////////////////
// 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 bump finishing.
*/
class MATERIALREADER_EXPORT OdFinishBumpsSchemaHelper
  : public OdAppearanceSchemaBaseHelper {
public:
  using OdAppearanceSchemaBaseHelper::OdAppearanceSchemaBaseHelper;

  /** \details
    Retrieves the type of decorative design (Relief bumps) pressed onto the surface.
    
    \param OdInt32 [out] Output value of pattern type.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getPatternType(OdInt32&) const;

  /** \details
    Sets the relief pattern of the surface.
    
    \param OdInt32 [in] Input value of relief pattern type.
  */
  void setPatternType(const OdInt32&);

  /** \details
    Retrieves a relative height of the relief pattern.
    
    \param double [out] Output value of relief height, 0 means flat pattern.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  virtual OdResult getHeight(double&) const;

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

  /** \details
    Retrieves a map of the relief pattern.
    
    \param OdAssetPtr [out] Output map of the relief pattern.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getPatternMap(OdAssetPtr&) const;

  /** \details
    Sets the map of the relief pattern.
    
    \param OdAssetPtr [in] Input map of the relief pattern.
  */
  void setPatternMap(const OdAssetPtr&);
};