///////////////////////////////////////////////////////////////////////////////
// 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 pearl part of Metallic Paint appearance schema.
*/
class MATERIALREADER_EXPORT OdMetallicPaintAppearanceSchemaPearl
  : public OdAppearanceSchemaBaseHelper {
public:
  using OdAppearanceSchemaBaseHelper::OdAppearanceSchemaBaseHelper;
  /** \details
    Retrieves a type of pearl effect of paint appearance.
    
    \param OdMaterial::MetallicPaintPearlType [out] Output type of top coat finish adjustment.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.   
  */
  OdResult getType(OdMaterial::MetallicPaintPearlType&) const;

  /** \details
    Sets the type of pearl effect of paint appearance.
    
    \param OdMaterial::MetallicPaintPearlType [in] Input type of topCoat finish adjustment.
  */
  void setType(const OdMaterial::MetallicPaintPearlType);


  /** \details
    Retrieves a color of pearl effect of paint appearance.
    
    \param OdCmEntityColor [out] Output metallic paint pearl color.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getColor(OdCmEntityColor&) const;

  /** \details
    Sets the metallic paint pearl color.
    Applicable for pearl type of Second color.
    
    \param OdCmEntityColor [in] Input metallic paint pearl color.
  */
  void setColor(const OdCmEntityColor&);

  /** \details
    Retrieves a blend ratio of pearl colors.
    
    \param double [out] Output blend ratio.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.  
  */
  OdResult getBlend(double&) const;

  /** \details
    Sets the blend ratio of pearl colors.
    Applicable for pearl type of Second color.
    
    \param double [in] Input value between 0 to 100.
  */
  void setBlend(const double&);

  /** \details
    Retrieves a blend ratio between pearl effect and the base color.
    
    \param double [out] Output blend ratio.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.  
  */
  OdResult getAmount(double&) const;

  /** \details
    Sets the blend ratio between pearl effect and the base color.
    
    \param double [in] Input value between 0 to 100.
  */
  void setAmount(const double&);
};