CL_LineSegment3 Class Reference [clanCore Math]

3D line segment - Integer More...

#include <line_segment.h>

Inheritance diagram for CL_LineSegment3:

List of all members.

Public Member Functions
	CL_LineSegment3 ()
	CL_LineSegment3 (const CL_Vec3< int > &point_p, const CL_Vec3< int > &point_q)
	CL_LineSegment3 (const CL_LineSegment3x< int > &copy)
Attributes
CL_Vec3< int >	get_midpoint () const
	Get the midpoint of this line.
int	point_distance (const CL_Vec3< int > &point, CL_Vec3< int > &dest_intercept) const
	Calculate the distance from a line segment to a point.
Operators
bool	operator== (const CL_LineSegment3x< int > &line) const
	== operator.
bool	operator!= (const CL_LineSegment3x< int > &line) const
	!= operator.
Public Attributes
CL_Vec3< int >	p
	Start point on the line.
CL_Vec3< int >	q

---

Detailed Description

3D line segment - Integer

A line segment has a start point and an end point

---

Constructor & Destructor Documentation

CL_LineSegment3::CL_LineSegment3

(

)

[inline]

CL_LineSegment3::CL_LineSegment3

(

const CL_LineSegment3x< int > &

copy

)

[inline]

CL_LineSegment3::CL_LineSegment3	(	const CL_Vec3< int > &	point_p,
		const CL_Vec3< int > &	point_q
	)			[inline]

---

Member Function Documentation

CL_Vec3<int > CL_LineSegment3x< int >::get_midpoint

(

)

const [inline, inherited]

Get the midpoint of this line.

Returns:

The midpoint

References CL_LineSegment3x< Type >::p, and CL_LineSegment3x< Type >::q.

bool CL_LineSegment3x< int >::operator!=

(

const CL_LineSegment3x< int > &

line

)

const [inline, inherited]

!= operator.

References CL_LineSegment3x< Type >::p, and CL_LineSegment3x< Type >::q.

bool CL_LineSegment3x< int >::operator==

(

const CL_LineSegment3x< int > &

line

)

const [inline, inherited]

== operator.

References CL_LineSegment3x< Type >::p, and CL_LineSegment3x< Type >::q.

int CL_LineSegment3x< int >::point_distance	(	const CL_Vec3< int > &	point,
		CL_Vec3< int > &	dest_intercept
	)			const [inherited]

Calculate the distance from a line segment to a point.

Parameters:

	point	= The point
	dest_intercept	= On Return: The point on the line closest to the point

Returns:

The Distance

---

Member Data Documentation

CL_Vec3<int > CL_LineSegment3x< int >::p [inherited]

Start point on the line.

CL_Vec3<int > CL_LineSegment3x< int >::q [inherited]

---

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

• line_segment.h