RVO Namespace Reference

Contains all classes, functions, and constants used in the library. More...

Classes
struct	Plane
	Defines a plane. More...
class	RVOSimulator
	Defines the simulation. More...
class	Vector3
	Defines a three-dimensional vector. More...
Functions
float	abs (const Vector3 &vector)
	Computes the length of a specified three-dimensional vector.
float	absSq (const Vector3 &vector)
	Computes the squared length of a specified three-dimensional vector.
Vector3	cross (const Vector3 &vector1, const Vector3 &vector2)
	Computes the cross product of the specified three-dimensional vectors.
Vector3	normalize (const Vector3 &vector)
	Computes the normalization of the specified three-dimensional vector.
Vector3	operator* (float scalar, const Vector3 &vector)
	Computes the scalar multiplication of the specified three-dimensional vector with the specified scalar value.
std::ostream &	operator<< (std::ostream &os, const Vector3 &vector)
	Inserts the specified three-dimensional vector into the specified output stream.
Variables
static const size_t	RVO_ERROR = std::numeric_limits<size_t>::max()
	Error value.

---

Detailed Description

Contains all classes, functions, and constants used in the library.

---

Function Documentation

float RVO::abs

(

const Vector3 &

vector

)

[inline]

Computes the length of a specified three-dimensional vector.

Parameters:

vector

The three-dimensional vector whose length is to be computed.

Returns:

The length of the three-dimensional vector.

float RVO::absSq

(

const Vector3 &

vector

)

[inline]

Computes the squared length of a specified three-dimensional vector.

Parameters:

vector

The three-dimensional vector whose squared length is to be computed.

Returns:

The squared length of the three-dimensional vector.

Vector3 RVO::cross	(	const Vector3 &	vector1,
		const Vector3 &	vector2
	)		[inline]

Computes the cross product of the specified three-dimensional vectors.

Parameters:

vector1	The first vector with which the cross product should be computed.
vector2	The second vector with which the cross product should be computed.

Returns:

The cross product of the two specified vectors.

Vector3 RVO::normalize

(

const Vector3 &

vector

)

[inline]

Computes the normalization of the specified three-dimensional vector.

Parameters:

vector

The three-dimensional vector whose normalization is to be computed.

Returns:

The normalization of the three-dimensional vector.

Vector3 RVO::operator*	(	float	scalar,
		const Vector3 &	vector
	)		[inline]

Computes the scalar multiplication of the specified three-dimensional vector with the specified scalar value.

Parameters:

scalar	The scalar value with which the scalar multiplication should be computed.
vector	The three-dimensional vector with which the scalar multiplication should be computed.

Returns:

The scalar multiplication of the three-dimensional vector with the scalar value.

std::ostream& RVO::operator<<	(	std::ostream &	os,
		const Vector3 &	vector
	)		[inline]

Inserts the specified three-dimensional vector into the specified output stream.

Parameters:

os	The output stream into which the three-dimensional vector should be inserted.
vector	The three-dimensional vector which to insert into the output stream.

Returns:

A reference to the output stream.

---

Variable Documentation

const size_t RVO::RVO_ERROR = std::numeric_limits<size_t>::max() [static]

Error value.

A value equal to the largest unsigned integer, which is returned in case of an error by functions in RVO::RVOSimulator.