PLMath::Ray Class Reference

Ray class (infinite length, in both directions) More...

#include <Ray.h>

List of all members.

Public Member Functions
	Ray ()
	Default constructor setting all position and direction components to 0.
	Ray (const Ray &cSource)
	Copy constructor.
	~Ray ()
	Destructor.
Ray &	operator= (const Ray &cSource)
	Copy operator.
void	Set (const Vector3 &vLineStartPos, const Vector3 &vLineEndPos)
	Set the current ray using a line.
const Vector3 &	GetPos () const
	Returns the current position.
void	SetPos (float fX=0.0f, float fY=0.0f, float fZ=0.0f)
	Set the current position.
void	SetPos (const Vector3 &vPos)
	Set the current position.
const Vector3 &	GetDir () const
	Returns the ray direction.
void	SetDir (float fX=0.0f, float fY=0.0f, float fZ=0.0f)
	Set the ray direction.
void	SetDir (const Vector3 &vDir)
	Set the ray direction.

---

Detailed Description

Ray class (infinite length, in both directions)

---

Constructor & Destructor Documentation

PLMath::Ray::Ray

(

)

[inline]

Default constructor setting all position and direction components to 0.

PLMath::Ray::Ray

(

const Ray &

cSource

)

[inline]

Copy constructor.

Parameters:

[in]

cSource

Source to copy from

PLMath::Ray::~Ray

(

)

[inline]

Destructor.

---

Member Function Documentation

Ray & PLMath::Ray::operator=

(

const Ray &

cSource

)

[inline]

Copy operator.

Parameters:

[in]

cSource

Source to copy from

Returns:

Reference to this instance

void PLMath::Ray::Set	(	const Vector3 &	vLineStartPos,
		const Vector3 &	vLineEndPos
	)		[inline]

Set the current ray using a line.

Parameters:

[in]	vLineStartPos	Line start position
[in]	vLineEndPos	Line end position

const Vector3 & PLMath::Ray::GetPos

(

)

const [inline]

Returns the current position.

Returns:

Current position

void PLMath::Ray::SetPos	(	float	fX = 0.0f,
		float	fY = 0.0f,
		float	fZ = 0.0f
	)		[inline]

Set the current position.

Parameters:

[in]	fX	X component of the new position
[in]	fY	Y component of the new position
[in]	fZ	Z component of the new position

void PLMath::Ray::SetPos

(

const Vector3 &

vPos

)

[inline]

Set the current position.

Parameters:

[in]

vPos

New position

const Vector3 & PLMath::Ray::GetDir

(

)

const [inline]

Returns the ray direction.

Returns:

Ray direction

void PLMath::Ray::SetDir	(	float	fX = 0.0f,
		float	fY = 0.0f,
		float	fZ = 0.0f
	)		[inline]

Set the ray direction.

Parameters:

[in]	fX	X component of the new direction vector
[in]	fY	Y component of the new direction vector
[in]	fZ	Z component of the new direction vector

void PLMath::Ray::SetDir

(

const Vector3 &

vDir

)

[inline]

Set the ray direction.

Parameters:

[in]

vDir

New ray direction

---

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

• Ray.h
• Ray.inl