#include <CURay.h>

Public Member Functions
	Ray ()

	Ray (const Vec3 direction)

	Ray (const Vec3 origin, const Vec3 direction)

	Ray (const Ray &ray)

	~Ray ()

Ray &	operator= (const Ray &ray)

Ray &	operator= (const Vec3 direction)

Ray &	set (const Ray &ray)

Ray &	set (const Vec3 origin, const Vec3 direction)

Ray &	set (const Vec3 direction)

Vec3	getEndpoint (float distance) const

Ray &	multiply (const Mat4 &mat)

Ray &	operator*= (const Mat4 &mat)

Vec3	operator* (float distance) const

const Ray	operator* (const Mat4 &mat) const

bool	operator== (const Ray &r) const

bool	operator!= (const Ray &r) const

bool	equals (const Ray &r, float variance=CU_MATH_EPSILON) const

std::string	toString (bool verbose=false) const

	operator std::string () const

Static Public Member Functions
static Vec3 *	endpoint (const Ray &ray, float distance, Vec3 *dst)

static Ray *	multiply (const Ray &ray, const Mat4 &mat, Ray *dst)

Public Attributes
Vec3	origin

Vec3	direction

Static Public Attributes
static const Ray	X_AXIS

static const Ray	Y_AXIS

static const Ray	Z_AXIS

Detailed Description

This class is a ray with a starting position and a unit length direction.

While this class has a few convience methods, most of the access is intended to be through the individual attributes.

Constructor & Destructor Documentation

◆ Ray() [1/4]

cugl::Ray::Ray ( )

inline

Creates a new ray along the x-axis

◆ Ray() [2/4]

cugl::Ray::Ray ( const Vec3 direction )

inline

Creates a new ray with the given direction.

The origin of the ray is (0,0,0)

Parameters

direction The ray direction

◆ Ray() [3/4]

cugl::Ray::Ray	(	const Vec3	origin,
		const Vec3	direction
	)

inline

Creates a new ray with the given origin and the direction.

Parameters

origin	The starting position
direction	The ray direction

◆ Ray() [4/4]

cugl::Ray::Ray ( const Ray & ray )

inline

Creates a copy of the given ray.

Parameters

ray	The ray to copy

◆ ~Ray()

cugl::Ray::~Ray ( )

inline

Destroys this ray, releasing all resources

Member Function Documentation

◆ endpoint()

static Vec3* cugl::Ray::endpoint	(	const Ray &	ray,
		float	distance,
		Vec3 *	dst
	)

static

Computes the endpoint for the given distance and assigns it to dst.

This is calculated as startpoint + distance * direction.

Parameters

ray	The ray to calculate
distance	The distance value
dst	A vector to store the result in

Returns: A reference to dst for chaining

◆ equals()

bool cugl::Ray::equals	(	const Ray &	r,
		float	variance = `CU_MATH_EPSILON`
	)		const

inline

Returns true if the rays are within tolerance of each other.

The tolerance bounds the origin and direction separately.

Parameters

r	The ray to compare against.
variance	The comparison tolerance.

Returns: true if the rays are within tolerance of each other.

◆ getEndpoint()

Vec3 cugl::Ray::getEndpoint ( float distance ) const

inline

Returns the endpoint for the given distance.

This is calculated as startpoint + distance * direction.

Parameters

distance The distance value

Returns: the endpoint for the given distance.

◆ multiply() [1/2]

Ray& cugl::Ray::multiply ( const Mat4 & mat )

inline

Multiplies this ray by the given matrix.

Use this to transform the ray into another coordinate system.

Parameters

mat	The transform matrix

Returns: A reference to this (modified) Ray for chaining.

◆ multiply() [2/2]

static Ray* cugl::Ray::multiply	(	const Ray &	ray,
		const Mat4 &	mat,
		Ray *	dst
	)

static

Multiplies the ray by the given matrix and assigns it to dst.

Use this to transform a ray into another coordinate system.

Parameters

ray	The ray to transform
mat	The transform matrix
dst	A ray to store the result in

Returns: A reference to dst for chaining

◆ operator std::string()

cugl::Ray::operator std::string ( ) const

inline

Cast from Ray to a string.

◆ operator!=()

bool cugl::Ray::operator!= ( const Ray & r ) const

inline

Returns true if this ray is not equal to the given ray.

Comparison is exact, which may be unreliable given that the attributes are floats.

Parameters

r	The ray to compare against.

Returns: True if this ray is not equal to the given ray.

◆ operator*() [1/2]

const Ray cugl::Ray::operator* ( const Mat4 & mat ) const

inline

Returns a copy of this ray multiplied by the given matrix.

Use this to transform the ray into another coordinate system.

Parameters

mat	The transform matrix

Returns: a copy of this ray multiplied by the given matrix.

◆ operator*() [2/2]

Vec3 cugl::Ray::operator* ( float distance ) const

inline

Returns the endpoint for the given distance.

This is calculated as startpoint + distance * direction.

Parameters

distance The distance value

Returns: the endpoint for the given distance.

◆ operator*=()

Ray& cugl::Ray::operator*= ( const Mat4 & mat )

inline

Multiplies this ray by the given matrix.

Use this to transform the ray into another coordinate system.

Parameters

mat	The transform matrix

Returns: A reference to this (modified) Ray for chaining.

◆ operator=() [1/2]

Ray& cugl::Ray::operator= ( const Ray & ray )

inline

Sets this ray to be a copy of the given ray.

Parameters

ray	The ray to copy

Returns: A reference to this (modified) Ray for chaining.

◆ operator=() [2/2]

Ray& cugl::Ray::operator= ( const Vec3 direction )

inline

Sets this ray to go along the given direction from the origin.

This will reset the origin to (0,0,0).

Parameters

direction The ray direction

Returns: A reference to this (modified) Ray for chaining.

◆ operator==()

bool cugl::Ray::operator== ( const Ray & r ) const

inline

Returns true if this ray is equal to the given ray.

Comparison is exact, which may be unreliable given that the attributes are floats.

Parameters

r	The ray to compare against.

Returns: True if this ray is equal to the given ray.

◆ set() [1/3]

Ray& cugl::Ray::set ( const Ray & ray )

inline

Sets this ray to be a copy of the given ray.

Parameters

ray	The ray to copy

Returns: A reference to this (modified) Ray for chaining.

◆ set() [2/3]

Ray& cugl::Ray::set ( const Vec3 direction )

inline

Sets this ray to go along the given direction from the origin.

This will reset the origin to (0,0,0).

Parameters

direction The ray direction

Returns: A reference to this (modified) Ray for chaining.

◆ set() [3/3]

Ray& cugl::Ray::set	(	const Vec3	origin,
		const Vec3	direction
	)

inline

Sets this ray to have the given origin and the direction.

Parameters

origin	The starting position
direction	The ray direction

Returns: A reference to this (modified) Ray for chaining.

◆ toString()

std::string cugl::Ray::toString ( bool verbose = false ) const

Returns a string representation of this ray for debugging purposes.

If verbose is true, the string will include class information. This allows us to unambiguously identify the class.

Parameters

verbose Whether to include class information

Returns: a string representation of this ray for debugging purposes.

Member Data Documentation

◆ direction

Vec3 cugl::Ray::direction

The direction of this ray (a unit vector)

◆ origin

Vec3 cugl::Ray::origin

The anchoring origin of this ray.

◆ X_AXIS

const Ray cugl::Ray::X_AXIS

static

The ray anchored at the origin along the x-axis

◆ Y_AXIS

const Ray cugl::Ray::Y_AXIS

static

The ray anchored at the origin along the y-axis

◆ Z_AXIS

const Ray cugl::Ray::Z_AXIS

static

The ray anchored at the origin along the z-axis

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

include/cugl/math/CURay.h

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Ray() [1/4]

◆ Ray() [2/4]

◆ Ray() [3/4]

◆ Ray() [4/4]

◆ ~Ray()

Member Function Documentation

◆ endpoint()

◆ equals()

◆ getEndpoint()

◆ multiply() [1/2]

◆ multiply() [2/2]

◆ operator std::string()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ toString()

Member Data Documentation

◆ direction

◆ origin

◆ X_AXIS

◆ Y_AXIS

◆ Z_AXIS