///////////////////////////////////////////////////////////////////////////////
// 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 base part of Wall Paint appearance schema.
*/
class MATERIALREADER_EXPORT OdWallPaintAppearanceSchema
  : public OdAppearanceSchemaBaseHelper {
public:
  using OdAppearanceSchemaBaseHelper::OdAppearanceSchemaBaseHelper;
  /** \details
    Retrieves wall paint color.
    
    \param OdCmEntityColor [out] Output wall paint color.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.  
  */
  OdResult getColor(OdCmEntityColor&) const;

  /** \details
    Sets the wall paint color.
    
    \param OdCmEntityColor [in] Input wall paint color.
  */
  void setColor(const OdCmEntityColor&);

  /** \details
    Retrieves the type of the wall paint material.
    
    \param OdMaterial::WallPaintFinishType [out] Output value of the type of wall paint.
    \returns An OdResult value: eOk if the value can be retrieved, eNotApplicable if not.
  */
  OdResult getFinishType(OdMaterial::WallPaintFinishType&) const;

  /** \details
    Sets the finish type of the wall paint material.
    
    \param OdMaterial::WallPaintFinishType [in] Input value of the type of wall paint.
  */
  void setFinishType(const OdMaterial::WallPaintFinishType);

  /** \details
    Retrieves the type of wall paint application.
    
    \param OdMaterial::WallPaintApplicationType [out] Output value of the wall paint application type.
    \returns An OdResult value: eOk if the value can be retrieved, eNotApplicable if not.
  */
  OdResult getApplicationType(OdMaterial::WallPaintApplicationType&) const;

  /** \details
    Sets the type of wall paint application.
    
    \param OdMaterial::WallPaintApplicationType [in] Input value of the wall paint application type.
  */
  void setApplicationType(const OdMaterial::WallPaintApplicationType);
};
// End of Wallpaint properties