DtChord Class Reference

NOTE: This entire class is deprecated, in favor of Dt3dChord. More...

List of all members.

Public Member Functions
	DtChord ()
	default constructor
	DtChord (const DtPoint &endpoint0, const DtPoint &endpoint1)
	define the chord given its end points
virtual	~DtChord ()
	destructor
	DtChord (const DtChord &orig)
	copy constructor
DtChord &	operator= (const DtChord &orig)
	assignment operator
const DtPoint &	endpoint0 () const
const DtPoint &	endpoint1 () const
double	directedXComponent () const
double	directedYComponent () const
double	directedZComponent () const
const DtExtent &	extent () const
virtual DtPoint	computePoint (const double t) const
	Determine the point at parametric value t, where the two end points of the chord assume values of 0 and 1.
virtual bool	isCollinear (const DtPoint &p) const
	Determine if given point p is collinear with chord.
virtual bool	parallelToXYPlane () const
	Determines if the chord is parallel to the XY-plane.
virtual bool	inPlaneZEquals (const double c) const
	Determines if Chord lies on plane z=c.
virtual bool	intersectsPlaneZEqualsAtPoint (const double c, double &tvalue) const
	Returns true if the chord intersects plane z=c, and returns a tvalue between 0 and 1.
virtual bool	collinearPointLiesWithin (const DtPoint &pt) const
	Determines if pt is collinear with the chord, and lies between end points.
double	length () const
double	lengthSquared () const
double	lengthOnX () const
double	lengthOnY () const
double	lengthOnZ () const
virtual void	dump (void) const
Protected Member Functions
virtual double	minZ () const
virtual double	maxZ () const
Private Attributes
DtPoint	myFirstEndpoint
DtPoint	mySecondEndpoint
double	myA
	Data derived from endpoints. Should never be set by user.
double	myB
	Data derived from endpoints. Should never be set by user.
double	myC
	Data derived from endpoints. Should never be set by user.
DtExtent	myExtent
	Data derived from endpoints. Should never be set by user.

---

Detailed Description

NOTE: This entire class is deprecated, in favor of Dt3dChord.

Deprecation notes for DtChord: DtChord was moved from terrainToolkit/geometry/chord.* to vrlink/matrix and renamed Dt3dChord for consistency with other geometric objects.

lengthOnX/Y/Z functions were renamed directedX/Y/ZComponent, as the values returned were not pure, unsigned lengths, but directed values. Examination of usage indicted that the signage was important, so functionality was maintained, but the name changed for clarity.

This class (will) have no virtual functions to avoid virtual table pointers for performance reasons. You can subclass, but do not add member data in derived classes or you will develop a memory leak.

---

Constructor & Destructor Documentation

DtChord::DtChord

(

)

default constructor

DtChord::DtChord	(	const DtPoint &	endpoint0,
		const DtPoint &	endpoint1
	)

define the chord given its end points

virtual DtChord::~DtChord

(

)

[virtual]

destructor

DtChord::DtChord

(

const DtChord &

orig

)

copy constructor

---

Member Function Documentation

DtChord& DtChord::operator=

(

const DtChord &

orig

)

assignment operator

virtual DtPoint DtChord::computePoint

(

const double

t

)

const [virtual]

Determine the point at parametric value t, where the two end points of the chord assume values of 0 and 1.

virtual bool DtChord::isCollinear

(

const DtPoint &

p

)

const [virtual]

Determine if given point p is collinear with chord.

virtual bool DtChord::parallelToXYPlane

(

)

const [virtual]

Determines if the chord is parallel to the XY-plane.

virtual bool DtChord::inPlaneZEquals

(

const double

c

)

const [virtual]

Determines if Chord lies on plane z=c.

virtual bool DtChord::intersectsPlaneZEqualsAtPoint	(	const double	c,
		double &	tvalue
	)		const [virtual]

Returns true if the chord intersects plane z=c, and returns a tvalue between 0 and 1.

When the entire chord lies on plane z=c, returns true and tvalue = 2.

virtual bool DtChord::collinearPointLiesWithin

(

const DtPoint &

pt

)

const [virtual]

Determines if pt is collinear with the chord, and lies between end points.

double DtChord::length

(

)

const

double DtChord::lengthSquared

(

)

const

virtual double DtChord::minZ

(

)

const [protected, virtual]

Returns:

The minimum Z-value along the chord

virtual double DtChord::maxZ

(

)

const [protected, virtual]

Returns:

The maximum Z-value along the chord

double DtChord::lengthOnX

(

)

const [inline]

Deprecated:

Use directedXComponent()

Returns:

The length of the line segment along the X-axis.

References myA.

double DtChord::lengthOnY

(

)

const [inline]

Deprecated:

Use directedYComponent()

Returns:

The length of the line segment along the Y-axis.

References myB.

double DtChord::lengthOnZ

(

)

const [inline]

Deprecated:

Use directedZComponent()

Returns:

The length of the line segment along the Z-axis.

References myC.

virtual void DtChord::dump

(

void

)

const [virtual]

Deprecated:

Use ostream

---

Member Data Documentation

DtPoint DtChord::myFirstEndpoint [private]

Referenced by endpoint0().

DtPoint DtChord::mySecondEndpoint [private]

Referenced by endpoint1().

double DtChord::myA [private]

Data derived from endpoints. Should never be set by user.

Referenced by directedXComponent(), and lengthOnX().

double DtChord::myB [private]

Data derived from endpoints. Should never be set by user.

Referenced by directedYComponent(), and lengthOnY().

double DtChord::myC [private]

Data derived from endpoints. Should never be set by user.

Referenced by directedZComponent(), and lengthOnZ().

DtExtent DtChord::myExtent [private]

Data derived from endpoints. Should never be set by user.

Referenced by extent().

---

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

• include/geometry/chord.h