///////////////////////////////////////////////////////////////////////////////
// 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.
///////////////////////////////////////////////////////////////////////////////

#ifndef _PRCSRFCYLINDRICAL_INCLUDED_
#define _PRCSRFCYLINDRICAL_INCLUDED_ 
 

#include "PrcSurface.h"

/** \details 
<group PRC_Surface_Classes> 

Class representing a definition of a cylindrical surface represented in a cylindrical coordinate system. The axis of this surface lies along the z-axis.
*/
class PRC_TOOLKIT OdPrcCylindricalSurface : public OdPrcSurface
{
public:
  //DOM-IGNORE-BEGIN
  ODPRC_DECLARE_MEMBERS_SURF(OdPrcCylindricalSurface)
  //DOM-IGNORE-END

  /** \details
  Destroys the cylindrical surface object.
  */
  ~OdPrcCylindricalSurface();
  
  /** \details
  Sets a new tolerance value.

  \param tolerance [in] A new tolerance value to be set.
  */
  void setTolerance(double tolerance);
  
  /** \details
  Returns the current tolerance value.
  */
  double tolerance() const;

  /** \details
  Sets a new base surface to the cylindrical surface.

  \param value [in] A new base surface to be set.
  
  \returns Returns eOk if a new surface was successfully applied to the cylindrical surface or an appropriate error code in the other case.
  */
  OdResult setBaseSurface(const OdPrcSurfacePtr &value);
  
  /** \details
  Returns the current base surface.
  */
  const OdPrcSurfacePtr &baseSurface() const;
};

SMARTPTR(OdPrcCylindricalSurface);

#endif // _PRCSRFCYLINDRICAL_INCLUDED_