///////////////////////////////////////////////////////////////////////////////
|
// Copyright (C) 2002-2016, 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 Teigha(R) software pursuant to a license
|
// agreement with Open Design Alliance.
|
// Teigha(R) Copyright (C) 2002-2016 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.
|
|
Library: TD_Ge
|
|
<group OdGe_Classes>
|
|
\sa
|
<link ge_Evaluators.html, Working with Evaluator Classes>
|
*/
|
class GE_TOOLKIT_EXPORT OdGePointOnCurve2d : public OdGePointEnt2d
|
{
|
public:
|
|
|
/** \param curve2d [in] Any 2D curve.
|
\param param [in] Parameter to specify a point on curve2d.
|
\param source [in] Object to be cloned.
|
|
\remarks
|
The default constructor constructs a point on the curve OdGeLine2d::kXAxis with a parameter value of 0.
|
*/
|
OdGePointOnCurve2d();
|
|
OdGePointOnCurve2d(
|
const OdGeCurve2d& curve2d,
|
double param = 0.0);
|
|
OdGePointOnCurve2d(
|
const OdGePointOnCurve2d& source);
|
|
OdGePointOnCurve2d& operator =(
|
const OdGePointOnCurve2d& pntOnCurve);
|
|
/** \details
|
Returns the curve on which the point lies.
|
*/
|
const OdGeCurve2d* curve() const;
|
|
/** \details
|
Returns the parameter value on the curve corresponding to the point.
|
*/
|
double parameter() const;
|
|
/** \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;
|
|
OdGePoint2d point(
|
double param);
|
|
OdGePoint2d point(
|
const OdGeCurve2d& curve2d,
|
double param);
|
|
/** \details
|
Returns the derivitive of the curve at the point on the curve.
|
|
\param order [in] Specifies the order of the derivitive [1-2].
|
\param param [in] Sets the current parameter.
|
\param curve2d [in] Any 2D curve. Sets the current curve.
|
|
\note
|
Currently not implemented.
|
*/
|
OdGeVector2d deriv(
|
int order) const;
|
|
OdGeVector2d deriv(
|
int order,
|
double param);
|
|
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.
|
|
\note
|
Currently not implemented.
|
*/
|
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 param [in] parameter to specify a point on curve2d.
|
\param res [out] Receives the curvature of the curve at the specified point.
|
|
\note
|
Currently not implemented.
|
*/
|
bool curvature(
|
double& res);
|
|
bool curvature(
|
double param,
|
double& res);
|
|
/** \details
|
Sets the current curve.
|
|
\param curve2d [in] Any 2D curve.
|
*/
|
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
|
