OdGePointOnCurve3d Class Reference

#include <GePointOnCurve3d.h>

Inheritance diagram for OdGePointOnCurve3d:

Public Member Functions
	OdGePointOnCurve3d ()
	OdGePointOnCurve3d (const OdGeCurve3d &curve3d)
	OdGePointOnCurve3d (const OdGeCurve3d &curve3d, double param)
	OdGePointOnCurve3d (const OdGePointOnCurve3d &src)
OdGePointOnCurve3d &	operator= (const OdGePointOnCurve3d &src)
const OdGeCurve3d *	curve () const
double	parameter () const
OdGePoint3d	point () const
OdGePoint3d	point (double param)
OdGePoint3d	point (const OdGeCurve3d &curve3d, double param)
OdGeVector3d	deriv (int order) const
OdGeVector3d	deriv (int order, double param)
OdGeVector3d	deriv (int order, const OdGeCurve3d &curve3d, double param)
bool	isSingular (const OdGeTol &tol=OdGeContext::gTol) const
bool	curvature (double &res)
bool	curvature (double param, double &res)
OdGePointOnCurve3d &	setCurve (const OdGeCurve3d &curve3d)
OdGePointOnCurve3d &	setParameter (double param)
Public Member Functions inherited from OdGePointEnt3d
OdGePoint3d	point3d () const
	operator OdGePoint3d () const
OdGePointEnt3d &	operator= (const OdGePointEnt3d &ent)
Public Member Functions inherited from OdGeEntity3d
	ODRX_HEAP_OPERATORS ()
	~OdGeEntity3d ()
bool	isKindOf (OdGe::EntityId entType) const
OdGe::EntityId	type () const
OdGeEntity3d *	copy () const
OdGeEntity3d &	operator= (const OdGeEntity3d &entity)
bool	operator== (const OdGeEntity3d &entity) const
bool	operator!= (const OdGeEntity3d &entity) const
bool	isEqualTo (const OdGeEntity3d &object, const OdGeTol &tol=OdGeContext::gTol) const
OdGeEntity3d &	transformBy (const OdGeMatrix3d &xfm)
OdGeEntity3d &	translateBy (const OdGeVector3d &translateVec)
OdGeEntity3d &	rotateBy (double angle, const OdGeVector3d &vect, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)
OdGeEntity3d &	mirror (const OdGePlane &plane)
OdGeEntity3d &	scaleBy (double scaleFactor, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)
bool	isOn (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const

Additional Inherited Members
Protected Member Functions inherited from OdGePointEnt3d
	OdGePointEnt3d ()
	OdGePointEnt3d (const OdGePointEnt3d &ent)
Protected Member Functions inherited from OdGeEntity3d
	OdGeEntity3d ()
	OdGeEntity3d (const OdGeEntity3d &)
void	connectTo (OdGeEntity3dImpl *)

Detailed Description

This class represents points along 3D curves.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

Remarks

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

See also

<link ge_Evaluators.html, Working with Evaluator Classes>

Definition at line 48 of file GePointOnCurve3d.h.

Constructor & Destructor Documentation

OdGePointOnCurve3d() [1/4]

OdGePointOnCurve3d::OdGePointOnCurve3d

(

)

Parameters

curve3d	[in] Any 3D curve.
param	[in] Parameter to specify a point on curve3d.

Remarks

The default constructor constructs a point on the curve OdGeLine2d::kXAxis with a parameter value of 0

OdGePointOnCurve3d() [2/4]

OdGePointOnCurve3d::OdGePointOnCurve3d

(

const OdGeCurve3d &

curve3d

)

OdGePointOnCurve3d() [3/4]

OdGePointOnCurve3d::OdGePointOnCurve3d	(	const OdGeCurve3d &	curve3d,
		double	param
	)

OdGePointOnCurve3d() [4/4]

OdGePointOnCurve3d::OdGePointOnCurve3d

(

const OdGePointOnCurve3d &

src

)

Member Function Documentation

curvature() [1/2]

bool OdGePointOnCurve3d::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 at the specified point.

Remarks

Currently not implemented.

curvature() [2/2]

bool OdGePointOnCurve3d::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 curve3d.
res	[out] Receives the curvature of the curve at the specified point.

Remarks

Currently not implemented.

curve()

const OdGeCurve3d* OdGePointOnCurve3d::curve

(

)

const

Returns the curve on which the point lies.

deriv() [1/3]

OdGeVector3d OdGePointOnCurve3d::deriv

(

int

order

)

const

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

Parameters

order

[in] The order of the derivative [1-2].

Remarks

Currently not implemented.

deriv() [2/3]

OdGeVector3d OdGePointOnCurve3d::deriv	(	int	order,
		const OdGeCurve3d &	curve3d,
		double	param
	)

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

Parameters

order	[in] the order of the derivative [1-2].
param	[in] Sets the current parameter.
curve3d	[in] Any 3D curve. Sets the current curve.

Remarks

Currently not implemented.

deriv() [3/3]

OdGeVector3d OdGePointOnCurve3d::deriv	(	int	order,
		double	param
	)

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

Parameters

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

Remarks

Currently not implemented.

isSingular()

bool OdGePointOnCurve3d::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=()

OdGePointOnCurve3d& OdGePointOnCurve3d::operator=

(

const OdGePointOnCurve3d &

src

)

parameter()

double OdGePointOnCurve3d::parameter

(

)

const

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

point() [1/3]

OdGePoint3d OdGePointOnCurve3d::point

(

)

const

Returns the point on the curve.

point() [2/3]

OdGePoint3d OdGePointOnCurve3d::point	(	const OdGeCurve3d &	curve3d,
		double	param
	)

Returns the point on the curve.

Parameters

param	[in] Sets the current parameter.
curve3d	[in] Any 3D curve. Sets the current curve.

point() [3/3]

OdGePoint3d OdGePointOnCurve3d::point

(

double

param

)

Returns the point on the curve.

Parameters

param

[in] Sets the current parameter.

setCurve()

OdGePointOnCurve3d& OdGePointOnCurve3d::setCurve

(

const OdGeCurve3d &

curve3d

)

Sets the current curve.

Parameters

curve3d

[in] Any 3D curve.

setParameter()

OdGePointOnCurve3d& OdGePointOnCurve3d::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:

• GePointOnCurve3d.h