The curve geometry evaluator class defines the pure virtual interface for CAMAL interaction with curves. More...

#include <CAMALCurveEval.hpp>

Public Member Functions
	CAMALCurveEval (ModelEnt *me)
	A constructor for the CAMAL curve geometry evaluator.
virtual	~CAMALCurveEval ()
	A destructor for the CAMAL curve geometry evaluator.
virtual double	arc_length ()=0
	Compute the curve length.
virtual bool	is_parametric ()=0
	Get the parametric status of the curve.
virtual bool	is_periodic (double &period)=0
	Get the periodic status of the curve.
virtual void	get_param_range (double &u_start, double &u_end)=0
	Get the parameter range of the curve.
virtual double	u_from_arc_length (double u_root, double arc_length)=0
virtual bool	position_from_u (double u, double &x, double &y, double &z)=0
	Evaluate the curve at a specified parameter value.
virtual void	move_to_curve (double &x, double &y, double &z)=0
	Move a point near the curve to the closest point on the curve.
virtual double	u_from_position (double x, double y, double z)=0
virtual void	start_coordinates (double &x, double &y, double &z)=0
	Get the starting point of the curve.
virtual void	end_coordinates (double &x, double &y, double &z)=0
	Get the ending point of the curve.
Private Attributes
ModelEnt *	modelEnt
	Model entity for this CurveEval.

Detailed Description

The curve geometry evaluator class defines the pure virtual interface for CAMAL interaction with curves.

Definition at line 13 of file CAMALCurveEval.hpp.

Constructor & Destructor Documentation

CAMALCurveEval ( ModelEnt * me ) [inline]

A constructor for the CAMAL curve geometry evaluator.

Definition at line 17 of file CAMALCurveEval.hpp.

virtual ~CAMALCurveEval ( ) [inline, virtual]

A destructor for the CAMAL curve geometry evaluator.

Definition at line 22 of file CAMALCurveEval.hpp.

Member Function Documentation

double arc_length ( ) [pure virtual]

Compute the curve length.

Returns:: The length of the curve.

Definition at line 10 of file CAMALCurveEval.cpp.

void end_coordinates	(	double &	x,
		double &	y,
		double &	z
	)		`[pure virtual]`

Get the ending point of the curve.

Parameters:

x	The x coordinate of the start point
y	The y coordinate of the start point
z	The z coordinate of the start point

Definition at line 80 of file CAMALCurveEval.cpp.

void get_param_range	(	double &	u_start,
		double &	u_end
	)		`[pure virtual]`

Get the parameter range of the curve.

Parameters:

u_start	The beginning curve parameter
u_end	The ending curve parameter

Note:: The numerical value of u_start may be greater than the numerical value of u_end.

Definition at line 32 of file CAMALCurveEval.cpp.

bool is_parametric ( ) [pure virtual]

Get the parametric status of the curve.

Returns:: true if curve is parametric, false otherwise.

Definition at line 15 of file CAMALCurveEval.cpp.

bool is_periodic ( double & period ) [pure virtual]

Get the periodic status of the curve.

Parameters:

period The period of the curve if periodic.

Returns:: true if curve is periodic, false otherwise.

Definition at line 20 of file CAMALCurveEval.cpp.

void move_to_curve	(	double &	x,
		double &	y,
		double &	z
	)		`[pure virtual]`

Move a point near the curve to the closest point on the curve.

Parameters:

x	The x coordinate of the point
y	The y coordinate of the point
z	The z coordinate of the point

Definition at line 55 of file CAMALCurveEval.cpp.

bool position_from_u	(	double	u,
		double &	x,
		double &	y,
		double &	z
	)		`[pure virtual]`

Evaluate the curve at a specified parameter value.

Parameters:

u	The parameter at which to evaluate the curve
x	The x coordinate of the evaluated point
y	The y coordinate of the evaluated point
z	The z coordinate of the evaluated point

Definition at line 47 of file CAMALCurveEval.cpp.

void start_coordinates	(	double &	x,
		double &	y,
		double &	z
	)		`[pure virtual]`

Get the starting point of the curve.

Parameters:

x	The x coordinate of the start point
y	The y coordinate of the start point
z	The z coordinate of the start point

Definition at line 72 of file CAMALCurveEval.cpp.

double u_from_arc_length	(	double	u_root,
		double	arc_length
	)		`[pure virtual]`

Compute the parameter value at a specified distance along the curve.

Parameters:

u_root	The start parameter from which to compute the distance along the curve.
arc_length	The distance to move along the curve.

Note:: For positive values of arc_length the distance will be computed in the direction of increasing parameter value along the curve. For negative values of arc_length the distance will be computed in the direction of decreasing parameter value along the curve.

Returns:: The parametric coordinate u along the curve

Definition at line 38 of file CAMALCurveEval.cpp.

double u_from_position	(	double	x,
		double	y,
		double	z
	)		`[pure virtual]`

Get the u parameter value on the curve closest to x,y,z and the point on the curve.

Parameters:

x	The x coordinate of the point
y	The y coordinate of the point
z	The z coordinate of the point

Returns:: The parametric coordinate u on the curve

Definition at line 64 of file CAMALCurveEval.cpp.

Member Data Documentation

ModelEnt* modelEnt [private]

Model entity for this CurveEval.

Definition at line 109 of file CAMALCurveEval.hpp.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation