CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
OdGePointOnCurve2d Class Reference

#include <GePointOnCurve2d.h>

Inheritance diagram for OdGePointOnCurve2d:
OdGePointEnt2d OdGeEntity2d

Public Member Functions

 OdGePointOnCurve2d ()
 
 OdGePointOnCurve2d (const OdGeCurve2d &curve2d, double param=0.0)
 
 OdGePointOnCurve2d (const OdGePointOnCurve2d &source)
 
OdGePointOnCurve2doperator= (const OdGePointOnCurve2d &pntOnCurve)
 
const OdGeCurve2dcurve () const
 
double parameter () const
 
OdGePoint2d point () const
 
OdGePoint2d point (double param)
 
OdGePoint2d point (const OdGeCurve2d &curve2d, double param)
 
OdGeVector2d deriv (int order) const
 
OdGeVector2d deriv (int order, double param)
 
OdGeVector2d deriv (int order, const OdGeCurve2d &curve2d, double param)
 
bool isSingular (const OdGeTol &tol=OdGeContext::gTol) const
 
bool curvature (double &res)
 
bool curvature (double param, double &res)
 
OdGePointOnCurve2dsetCurve (const OdGeCurve2d &curve2d)
 
OdGePointOnCurve2dsetParameter (double param)
 
- Public Member Functions inherited from OdGePointEnt2d
OdGePoint2d point2d () const
 
 operator OdGePoint2d () const
 
OdGePointEnt2doperator= (const OdGePointEnt2d &point)
 
- Public Member Functions inherited from OdGeEntity2d
 ODRX_HEAP_OPERATORS ()
 
bool isKindOf (OdGe::EntityId entType) const
 
OdGe::EntityId type () const
 
OdGeEntity2dcopy () const
 
OdGeEntity2doperator= (const OdGeEntity2d &entity)
 
bool operator== (const OdGeEntity2d &entity) const
 
bool operator!= (const OdGeEntity2d &entity) const
 
bool isEqualTo (const OdGeEntity2d &other, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGeEntity2dtransformBy (const OdGeMatrix2d &xfm)
 
OdGeEntity2dtranslateBy (const OdGeVector2d &translateVec)
 
OdGeEntity2drotateBy (double angle, const OdGePoint2d &basePoint=OdGePoint2d::kOrigin)
 
OdGeEntity2dmirror (const OdGeLine2d &line)
 
OdGeEntity2dscaleBy (double scaleFactor, const OdGePoint2d &basePoint=OdGePoint2d::kOrigin)
 
bool isOn (const OdGePoint2d &point, const OdGeTol &tol=OdGeContext::gTol) const
 
 ~OdGeEntity2d ()
 

Additional Inherited Members

- Protected Member Functions inherited from OdGePointEnt2d
 OdGePointEnt2d ()
 
 OdGePointEnt2d (const OdGePointEnt2d &source)
 
- Protected Member Functions inherited from OdGeEntity2d
 OdGeEntity2d ()
 
 OdGeEntity2d (const OdGeEntity2d &)
 
void connectTo (OdGeEntity2dImpl *)
 

Detailed Description

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>

See also
<link ge_Evaluators.html, Working with Evaluator Classes>

Definition at line 47 of file GePointOnCurve2d.h.

Constructor & Destructor Documentation

◆ OdGePointOnCurve2d() [1/3]

OdGePointOnCurve2d::OdGePointOnCurve2d ( )
Parameters
curve2d[in] Any 2D curve.
param[in] Parameter to specify a point on curve2d.
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() [2/3]

OdGePointOnCurve2d::OdGePointOnCurve2d ( const OdGeCurve2d curve2d,
double  param = 0.0 
)

◆ OdGePointOnCurve2d() [3/3]

OdGePointOnCurve2d::OdGePointOnCurve2d ( const OdGePointOnCurve2d source)

Member Function Documentation

◆ curvature() [1/2]

bool OdGePointOnCurve2d::curvature ( double &  res)

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.

Parameters
res[out] Receives the curvature of the curve.
Remarks
Currently not implemented.

◆ curvature() [2/2]

bool OdGePointOnCurve2d::curvature ( double  param,
double &  res 
)

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.

Parameters
param[in] Parameter to specify a point on curve2d.
res[out] Receives the curvature of the curve at the specified point.
Remarks
Currently not implemented.

◆ curve()

const OdGeCurve2d* OdGePointOnCurve2d::curve ( ) const

Returns the curve on which the point lies.

◆ deriv() [1/3]

OdGeVector2d OdGePointOnCurve2d::deriv ( int  order) const

Returns the derivitive of the curve at the point on the curve.

Parameters
order[in] Specifies the order of the derivitive [1-2].
Remarks
Currently not implemented.

◆ deriv() [2/3]

OdGeVector2d OdGePointOnCurve2d::deriv ( int  order,
const OdGeCurve2d curve2d,
double  param 
)

Returns the derivitive of the curve at the point on the curve.

Parameters
order[in] Specifies the order of the derivitive [1-2].
param[in] Sets the current parameter.
curve2d[in] Any 2D curve. Sets the current curve.
Remarks
Currently not implemented.

◆ deriv() [3/3]

OdGeVector2d OdGePointOnCurve2d::deriv ( int  order,
double  param 
)

Returns the derivitive of the curve at the point on the curve.

Parameters
order[in] Specifies the order of the derivitive [1-2].
param[in] Sets the current parameter.
Remarks
Currently not implemented.

◆ isSingular()

bool OdGePointOnCurve2d::isSingular ( const OdGeTol tol = OdGeContext::gTol) const

Returns true if and only if the first derivative vector has a length of zero.

Parameters
tol[in] Geometric tolerance.
Remarks
Currently not implemented.

◆ operator=()

OdGePointOnCurve2d& OdGePointOnCurve2d::operator= ( const OdGePointOnCurve2d pntOnCurve)

◆ parameter()

double OdGePointOnCurve2d::parameter ( ) const

Returns the parameter value on the curve corresponding to the point.

◆ point() [1/3]

OdGePoint2d OdGePointOnCurve2d::point ( ) const

Returns the point on the curve.

◆ point() [2/3]

OdGePoint2d OdGePointOnCurve2d::point ( const OdGeCurve2d curve2d,
double  param 
)

Returns the point on the curve.

Parameters
param[in] Sets the current parameter.
curve2d[in] Any 2D curve. Sets the current curve.

◆ point() [3/3]

OdGePoint2d OdGePointOnCurve2d::point ( double  param)

Returns the point on the curve.

Parameters
param[in] Sets the current parameter.

◆ setCurve()

OdGePointOnCurve2d& OdGePointOnCurve2d::setCurve ( const OdGeCurve2d curve2d)

Sets the current curve.

Parameters
curve2d[in] Any 2D curve.

◆ setParameter()

OdGePointOnCurve2d& OdGePointOnCurve2d::setParameter ( double  param)

Sets the current parameter.

Parameters
param[in] Sets the current parameter.

The documentation for this class was generated from the following file: