/////////////////////////////////////////////////////////////////////////////// 
// 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_GESPNT3D_H
#define OD_GESPNT3D_H /*!DOM*/

class OdGeKnotVector;
#include "Ge/GeCurve3d.h"

#include "TD_PackPush.h"

/** \details
    This class represents various spline objects in 3D space. Currently not implemented.
    
    Corresponding C++ library: TD_Ge
   
    <group OdGe_Classes> 
*/
class GE_TOOLKIT_EXPORT OdGeSplineEnt3d : public OdGeCurve3d
{
public:


  /** \details
    Returns true if and only if the spline is rational or a polynomial.

    \remarks
    This function is meaningful only for OdGeNurbCurve3d objects derived from OdGeSplineEnt3d.
  */
   bool isRational() const;

  /** \details
    Returns the degree of the spline.

    \remarks
    Currently not implemented.
  */
   int degree() const;

  /** \details
    Returns the order of the spline.

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

  /** \details
    Returns the number of knots in the knot vector.
  */
   int numKnots() const;

  /** \details
    Returns the knot vector.
    
    \remarks
    A knot vector defines a sequence of parameter values that determines how the shape of a spline entity is affected. 
    The knot vector is a sequence of parameter values and divides the parametric space into intervals, usually called knot spans. Values of a knot vector are in an ascending order.
  */
   const OdGeKnotVector& knots() const;

  /** \details
    Returns the number of points in the control point array.

    \remarks
    Currently not implemented.
  */
   int numControlPoints() const;

   int continuityAtKnot(
    int index, 
    const OdGeTol& tol = OdGeContext::gTol) const;

  /** \details
    Returns the parameter corresponding to the start point of this spline.
    
    \remarks
    The start parameter is the lower bound of the parametric interval.
  */
   double startParam() const;

  /** \details
    Returns the parameter corresponding to the end point of this spline.
    
    \remarks
    The end parameter is the upper bound of the parametric interval.
  */
   double endParam() const;

  /** \details
    Returns the start point of this spline evaluated by the start parameter.
  */
   OdGePoint3d startPoint() const;

  /** \details
    Returns the end point of this spline evaluated by the end parameter.
  */
   OdGePoint3d endPoint() const;

  /** \details
    Returns true if and only if the spline is constructed using fit points.

    \remarks
    Currently not implemented.
  */
   bool hasFitData() const;

  /** \details
    Returns a knot value for the specified knot.

    \param knotIndex [in]  Knot index.
  */
   double knotAt(
    int knotIndex) const;

  /** \details
    Sets the knot value for the specified knot.

    \param knotIndex [in]  Knot index.
    \param val [in]  The new value for the knot.
  */
   OdGeSplineEnt3d& setKnotAt(
    int knotIndex, 
    double val);

  /** \details
    Returns the specified control point in the control point array.

    \param controlPointIndex [in]  Control point index.

    \remarks
    Currently not implemented.
  */
   OdGePoint3d controlPointAt(
    int controlPointIndex) const;

  /** \details
    Sets the specified control point in the control point array.

    \param controlPointIndex [in]  Control point index in the array of control points.
    \param point [in]  New point to be set at the specified index.

    \remarks
    Currently not implemented.
  */
   OdGeSplineEnt3d& setControlPointAt(
    int controlPointIndex, 
    const OdGePoint3d& point);

  /** \details
    Assignment operator for the OdGeSplineEnt3d object.
    
    \returns
    A reference to this spline entity.
  */
  OdGeSplineEnt3d& operator =(const OdGeSplineEnt3d& spline);

  //////////////////////////////////////////////////////////////////////////

protected:
  OdGeSplineEnt3d();
  OdGeSplineEnt3d(const OdGeSplineEnt3d&);
};

#include "TD_PackPop.h"

#endif