/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2019, 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-2019 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 OD_GE_POINT_ON_CURVE_2D_H
#define OD_GE_POINT_ON_CURVE_2D_H /*!DOM*/

#include "Ge/GePointEnt2d.h"
class OdGeCurve2d;

#include "TD_PackPush.h"

/** \details
    This class represents points along 2D curves.

    \remarks
    The point representation includes its parameter value, its coordinates, and the
    the derivatives of the curve at that point. 

    Corresponding C++ library: TD_Ge

    <group OdGe_Classes>

    \sa
    <link ge_Evaluators.html, Working with Evaluator Classes>
*/
class GE_TOOLKIT_EXPORT OdGePointOnCurve2d : public OdGePointEnt2d
{
public:
    
  /** \details
    Default constructor for the OdGePointOnCurve2d class.

    \remarks
    The default constructor constructs a point that does not lie on any curve and has a parameter value of 0.
  */
  OdGePointOnCurve2d();

  /** \details
    Constructor for the OdGePointOnCurve2d class.
    
    \param curve2d [in]  Any 2D curve on which this point lies.
    \param param [in]  Parameter value for this point.

    \remarks
    The constructor constructs a point that lies on a specified 2D curve and has a specified parameter value.
  */
  OdGePointOnCurve2d(
    const OdGeCurve2d& curve2d, 
    double param = 0.0);

  /** \details
    Copy constructor for the OdGePointOnCurve2d class.
    
    \param source [in]  Object to be copied.
  */
  OdGePointOnCurve2d(
    const OdGePointOnCurve2d& source);

  /** \details
    Assignment operator for the OdGePointOnCurve2d object.
  */
  OdGePointOnCurve2d& operator =(
    const OdGePointOnCurve2d& pntOnCurve);

  /** \details
    Returns a pointer to a constant curve on which the point lies.
  */
  const OdGeCurve2d* curve() const;

  /** \details
    Returns the parameter value of this point on the curve.
  */
  double parameter() const;

  /** \details
    Returns the point on the curve.
  */
  OdGePoint2d point() const;

  /** \details
    Returns the point on the curve.

    \param param [in] Sets the current parameter.
  */
  OdGePoint2d point(
    double param);

  /** \details
    Returns the point on the curve.

    \param param [in] Sets the current parameter.
    \param curve2d [in] Any 2D curve. Sets the current curve.
  */
  OdGePoint2d point(
    const OdGeCurve2d& curve2d, 
    double param);

  /** \details
    Returns the derivative of the curve at the point on the curve.

    \param order [in]  Specifies the order of the derivative [1-2].

    \remarks
    Currently not implemented.
  */
  OdGeVector2d deriv(
    int order) const;

  /** \details
    Returns the derivative of the curve at the point on the curve.

    \param order [in]  Specifies the order of the derivative [1-2].
    \param param [in]  Sets the current parameter.

    \remarks
    Currently not implemented.
  */
  OdGeVector2d deriv(
    int order, 
    double param);

  /** \details
    Returns the derivative of the curve at the point on the curve.

    \param order [in]  Specifies the order of the derivative [1-2].
    \param param [in]  Sets the current parameter.
    \param curve2d [in]  Any 2D curve. Sets the current curve.

    \remarks
    Currently not implemented.
  */
  OdGeVector2d deriv(
    int order, 
    const OdGeCurve2d& curve2d,
    double param);

  /** \details
    Returns true if and only if the first derivative vector 
    has a length of zero.

    \param tol [in]  Geometric tolerance.
  */
  bool isSingular(
    const OdGeTol& tol = OdGeContext::gTol) const;


  /** \details
    Returns true if and only if the first derivative vector has a non-zero length, and
    the curvature of the curve at the point on the curve. 

    \param res [out]  Receives the curvature of the curve.

    \remarks
    Currently not implemented.
  */
  bool curvature(
    double& res);

  /** \details
    Returns true if and only if the first derivative vector has a non-zero length, and
    the curvature of the curve at the point on the curve. 

    \param param [in]  Parameter to specify a point on curve2d.
    \param res [out]  Receives the curvature of the curve at the specified point.

    \remarks
    Currently not implemented.
  */
  bool curvature(
    double param, 
    double& res);

  /** \details
    Sets the current curve on which this point lies.

    \param curve2d [in]  Any 2D curve on which this point lies.
  */
  OdGePointOnCurve2d& setCurve(
    const OdGeCurve2d& curve2d);

  /** \details
    Sets the current parameter.

    \param param [in]  Sets the current parameter.
  */
  OdGePointOnCurve2d& setParameter(
    double param);

};

#include "TD_PackPop.h"

#endif