///////////////////////////////////////////////////////////////////////////////
// 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 appearance schema.
*/
class MATERIALREADER_EXPORT OdAppearanceSchemaHelper
  : public OdAppearanceSchemaBaseHelper {
public:
  using OdAppearanceSchemaBaseHelper::OdAppearanceSchemaBaseHelper;
  /** \details
    Retrieves an appearance color if possible.
    
    \param color [out] Outputppearance color.
    \returns An OdResult value: eOk if color can be retrieved, eNotApplicable if not.
  */
  virtual OdResult getColor(OdCmEntityColor& color) const;

  /** \details
    Sets an appearance color if possible.
    
    \param color [in] Inputppearance color.
    \returns An OdResult value: eOk if schema contains color, eNotApplicable if not.
  */
  virtual OdResult setColor(const OdCmEntityColor& color);

  /** \details
    Retrieves an appearance texture if possible.
    
    \param asset [out] Output texture asset (it is usually a Unified bitmap schema).
    \returns An OdResult value: eOk if schema contains texture, eNotApplicable if not.
  */
  virtual OdResult getTextureAsset(OdAssetPtr& asset) const;

  /** \details
      Sets   an appearance texture if possible.

      \param asset [in] Input texture asset.
      \returns An OdResult value: eOk if it is possible to set a defuse texture, eNotApplicable if not.
    */
  virtual OdResult setTextureAsset(OdAssetPtr asset);

  /** \details
    Retrieves an appearance relief texture if possible.

    \param asset [out] Output texture asset (it is usually a Unified bitmap schema).
    \returns An OdResult value: eOk if schema contains texture, eNotApplicable if not.
  */
  virtual OdResult getReliefTextureAsset(OdAssetPtr& asset) const;

  /** \details
    Sets an appearance relief texture if possible.

    \param asset [in] Input texture asset.
    \returns An OdResult value: eOk if it is possible to set a relief texture, eNotApplicable if not.
  */
  virtual OdResult setReliefTextureAsset(OdAssetPtr asset);

  /** \details
    Retrieves a depth of surface irregularities if possible.

    \param value [out] Output value that contains depth of surface irregularities.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  virtual OdResult getReliefBumpAmount(double& value) const;

  /** \details
      Sets a depth of surface irregularities if possible.

      \param value [in] Input value that contains depth of surface irregularities.
      \returns An OdResult value: eOk if it is possible to set the depth of surface irregularities, eNotApplicable if not.
    */
  virtual OdResult setReliefBumpAmount(double value);
};