dlr::geometry::Ray3D Class Reference

The Ray3D class represents a ray in 3D space. More...

#include <ray3D.h>

List of all members.

Public Member Functions
	Ray3D ()
	The default constructor initializes to the ray which starts at the origin and points along the X axis.
	Ray3D (const Vector3D &point, const Vector3D &direction, bool normalize=true)
	This constructor initializes the ray using a point and a direction.
	Ray3D (const Ray3D &source)
	The copy constructor deep copies its argument.
	~Ray3D ()
	Destructor.
Ray3D &	operator= (const Ray3D &source)
	The assignment operator deep copies its argument.
const Vector3D &	getDirectionVector () const
	This member function returns the direction of the ray.
const Vector3D &	getOrigin () const
	This member function returns the start point of the ray.

---

Detailed Description

The Ray3D class represents a ray in 3D space.

Definition at line 28 of file ray3D.h.

---

Constructor & Destructor Documentation

dlr::geometry::Ray3D::Ray3D

(

)

[inline]

The default constructor initializes to the ray which starts at the origin and points along the X axis.

Definition at line 35 of file ray3D.h.

dlr::geometry::Ray3D::Ray3D	(	const Vector3D &	point,
		const Vector3D &	direction,
		bool	normalize = true
	)

This constructor initializes the ray using a point and a direction.

Parameters:

	point	This argument specifies the start point of the ray.
	direction	This argument specifies the direction of the ray.
	normalized	If the direction vector is already normalized to unit length, then you can save some computation by setting this argument to false.

Definition at line 27 of file ray3D.cpp.

References dlr::numeric::magnitude().

dlr::geometry::Ray3D::Ray3D

(

const Ray3D &

source

)

The copy constructor deep copies its argument.

Parameters:

source

This argument is the class instance to be copied.

Definition at line 41 of file ray3D.cpp.

dlr::geometry::Ray3D::~Ray3D

(

)

[inline]

Destructor.

Definition at line 67 of file ray3D.h.

---

Member Function Documentation

Ray3D & dlr::geometry::Ray3D::operator=

(

const Ray3D &

source

)

The assignment operator deep copies its argument.

Parameters:

source

This argument is the class instance to be copied.

Returns:

The return value is a reference to *this.

Definition at line 52 of file ray3D.cpp.

References m_direction, and m_origin.

const Vector3D& dlr::geometry::Ray3D::getDirectionVector

(

)

const [inline]

This member function returns the direction of the ray.

Returns:

The return value is a const reference to Vector3D representing the direction of the ray.

Definition at line 89 of file ray3D.h.

Referenced by dlr::geometry::findIntersect(), and dlr::geometry::operator<<().

const Vector3D& dlr::geometry::Ray3D::getOrigin

(

)

const [inline]

This member function returns the start point of the ray.

Returns:

The return value is a const reference to Vector3D representing the start point of the ray.

Definition at line 99 of file ray3D.h.

Referenced by dlr::geometry::findIntersect(), and dlr::geometry::operator<<().

---

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

• ray3D.h
• ray3D.cpp

---