///////////////////////////////////////////////////////////////////////////////
// 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 Water appearance schema.
*/
class MATERIALREADER_EXPORT OdWaterAppearanceSchema
  : public OdAppearanceSchemaBaseHelper {
public:
  using OdAppearanceSchemaBaseHelper::OdAppearanceSchemaBaseHelper;
  /** \details
    Retrieves the type of the water material.
    
    \param OdMaterial::WaterType [out] Output value of the type of water.
    \returns An OdResult value: eOk if the value can be retrieved, eNotApplicable if not.
  */
  OdResult getType(OdMaterial::WaterType&) const;

  /** \details
    Sets the type of the water material.
    
    \param OdMaterial::WaterType [in] Input value of the type of water.
  */
  void setType(const OdMaterial::WaterType);

  /** \details
    Retrieves the type of color applied to the water material.
    
    \param OdMaterial::WaterColorType [out] Output value of the color type.
    \returns An OdResult value: eOk if the value can be retrieved, eNotApplicable if not.
  */
  OdResult getColorType(OdMaterial::WaterColorType&) const;
  
  /** \details
    Retrieves the calculated color of the Water material.

    \param OdCmEntityColor [out] Output value of the color calculated using water type and water color type.
    \returns An OdResult value: eOk if the value can be retrieved, eNotApplicable if not.
  */
  OdResult getColor(OdCmEntityColor&) const;

  /** \details
    Sets the type of color applied to the water material.
    Not applicable for types of swimming or reflecting pool.
  
    \param OdMaterial::WaterColorType [in] Input value of the color type.
    returns An OdResult value: eOk if value can be set, eNotApplicable if not.
  */
  OdResult setColorType(const OdMaterial::WaterColorType);

  /** \details
    Retrieves a custom color of the water.
  
    \param OdCmEntityColor [out] Output custom color of the water.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getCustomColor(OdCmEntityColor&) const;

  /** \details
    Sets the custom color of the water.
    Applicable only for custom color type of the water material.
    
    \param OdCmEntityColor [in] Input custom color of the water.
    \returns An OdResult value: eOk if value can be set, eNotApplicable if not.
  */
  OdResult setCustomColor(const OdCmEntityColor&);

  /** \details
    Retrieves a relative wave height of the water.
    
    \param double [out] Output relative wave height of the water.
    \returns An OdResult value: eOk if value can be retrieved, eNotApplicable if not.
  */
  OdResult getWavesHeight(double&) const;

  /** \details
    Sets the relative wave height of the water.
    
    \param double [in] Input value between 0 to 5.
  */
  void setWavesHeight(const double&);
};