///////////////////////////////////////////////////////////////////////////////
// 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 _PRCCRVONSURF3d_INCLUDED_
#define _PRCCRVONSURF3d_INCLUDED_ 
 

#include "PrcCurve3d.h"
#include "PrcSurface.h"

/** \details
<group PRC_Curve_Classes>

Class representing a three-dimensional curve defined through a UV-curve lying in the surface's domain.
On-surface curves can be parameterized and transformed for positioning in model space.
\remarks
Transformation can be one of the following:
  <table>
    Value  Description
    0x00  Identity
    0x01  Translate
    0x02  Rotate
    0x08  Scale
  </table>
  
  OdPrc2dCurveOnSurfaceCurve3d inherits the OdPrcCurve class and can be reparameterized and trimmed using the OdPrcParameterization class and setParameterization() method. 
*/
class PRC_TOOLKIT OdPrc2dCurveOnSurfaceCurve3d : public OdPrcCurve3d
{
public:
  //DOM-IGNORE-BEGIN
  ODPRC_DECLARE_MEMBERS_CRV(OdPrc2dCurveOnSurfaceCurve3d)
  //DOM-IGNORE-END

  /** \details
  Sets a new value of tolerance for the on-surface curve.
  \param tolerance [in] A new tolerance value to be set.
  */
  void setTolerance(double tolerance);
  
  /** \details
  Returns the current tolerance value of the on-surface curve.
  */
  double tolerance() const;

  /** \details 
  Sets a new uv-curve for the on-surface curve.
  \param value [in] A new curve to be set as the uv-curve represented as a smart pointer to an OdPrcCurve object.
  \returns
  Returns eOk if a new curve was successfully set or an appropriate error code in the other case.
  */
  OdResult setCurveUV(const OdPrcCurvePtr &value);
  
  /** \details
  Returns the current uv-curve of the on-surface curve.
  */
  const OdPrcCurvePtr &curveUV() const;

  /** \details
  Sets a new base surface of the on-surface curve.
  \param value [in] A new surface to be set as the base surface, which is represented as a smart pointer to an OdPrcSurface.
  \returns
  Returns eOk if a new surface was successfully set or an appropriate error code in the other case.
  */
  OdResult setBaseSurface(const OdPrcSurfacePtr &value);
  
  /** \details
  Returns the current base surface of the on-surface curve.
  */
  const OdPrcSurfacePtr &baseSurface() const;
};
SMARTPTR(OdPrc2dCurveOnSurfaceCurve3d);

#endif // _PRCCRVONSURF3d_INCLUDED_