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

#include "PrcCurve3d.h"
#include "PrcMath3d.h"

/** \details
The class implements a three-dimensional transformed curve.
A transformed curve is a curve defined by the result of a three-dimensional mathematical function applied to a base curve.
A transfomed curve can be parameterized and transformed for positioning in model space. 
The OdPrcTransformedCurve3d class inherits the <link OdPrcCurve, OdPrcCurve> class and can be reparameterized and trimmed using the <link OdPrcParameterization, OdPrcParameterization> class 
and the <link OdPrcCurve::setParameterization@const_OdPrcParameterization&, setParameterization()> method of the <link OdPrcCurve, OdPrcCurve> class. 

\remarks
Transformation can be one of the following:
  <table>
    <tr><th>Value</th><th>Description</th></tr>
    <tr><td>0x00</td><td>Identity</td></tr>
    <tr><td>0x01</td><td>Translate</td></tr>
    <tr><td>0x02</td><td>Rotate</td></tr>
    <tr><td>0x08</td><td>Scale</td></tr>
  </table>

<group PRC_Curve_Classes>
*/
class PRC_TOOLKIT OdPrcTransformedCurve3d : public OdPrcCurve3d
{
public:
  ODPRC_DECLARE_MEMBERS_CRV(OdPrcTransformedCurve3d)

  /** \details
  Destroys the transformed curve object.
  */
  ~OdPrcTransformedCurve3d();
  
  /** \details
  Requests the current 3D mathematical function applied to the base curve of the transformed curve.
  \returns A smart pointer to the <link OdPrcMath3d, OdPrcMath3d> object that represents the 3D mathematical function.
  \remarks 
  The 3D mathematical function is returned as a reference to a smart pointer to the <link OdPrcMath3d, OdPrcMath3d> object; 
  therefore, it can be used to set a new 3D mathematical function.
  */
  OdPrcMath3dPtr &mathTransformation();
  
  /** \details
  Requests the current 3D mathematical function applied to the base curve of the transformed curve.
  \returns A smart pointer to the <link OdPrcMath3d, OdPrcMath3d> object that represents the 3D mathematical function.
  */
  const OdPrcMath3dPtr &mathTransformation() const;
  
  /** \details
  Sets a new base curve for the transformed curve.
  
  \param value [in] A new base curve to be set.
  
  \returns The eOk value, if a new base curve was successfully set or an appropriate error code in the other case.
  */
  OdResult setBaseCurve(const OdPrcCurvePtr &value);
  
  /** \details
  Requests the current base curve for the transformed curve.
  \returns A smart pointer to the <link OdPrcCurve, OdPrcCurve> object that represents the base curve.
  */
  const OdPrcCurvePtr &baseCurve() const;
};
SMARTPTR(OdPrcTransformedCurve3d);

#endif // _PRCCRVTRANSFORM3d_INCLUDED_