Contains all classes, functions, and constants used in the library.
More...
Classes |
| struct | Line |
| | Defines a directed line. More...
|
| class | RVOSimulator |
| | Defines the simulation. More...
|
| class | Vector2 |
| | Defines a two-dimensional vector. More...
|
Functions |
| float | abs (const Vector2 &vector) |
| | Computes the length of a specified two-dimensional vector.
|
| float | absSq (const Vector2 &vector) |
| | Computes the squared length of a specified two-dimensional vector.
|
| float | det (const Vector2 &vector1, const Vector2 &vector2) |
| | Computes the determinant of a two-dimensional square matrix with rows consisting of the specified two-dimensional vectors.
|
| Vector2 | normalize (const Vector2 &vector) |
| | Computes the normalization of the specified two-dimensional vector.
|
| Vector2 | operator* (float s, const Vector2 &vector) |
| | Computes the scalar multiplication of the specified two-dimensional vector with the specified scalar value.
|
| std::ostream & | operator<< (std::ostream &os, const Vector2 &vector) |
| | Inserts the specified two-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 Vector2 & |
vector |
) |
[inline] |
Computes the length of a specified two-dimensional vector.
- Parameters:
-
| vector | The two-dimensional vector whose length is to be computed. |
- Returns:
- The length of the two-dimensional vector.
| float RVO::absSq |
( |
const Vector2 & |
vector |
) |
[inline] |
Computes the squared length of a specified two-dimensional vector.
- Parameters:
-
| vector | The two-dimensional vector whose squared length is to be computed. |
- Returns:
- The squared length of the two-dimensional vector.
| float RVO::det |
( |
const Vector2 & |
vector1, |
|
|
const Vector2 & |
vector2 | |
|
) |
| | [inline] |
Computes the determinant of a two-dimensional square matrix with rows consisting of the specified two-dimensional vectors.
- Parameters:
-
| vector1 | The top row of the two-dimensional square matrix. |
| vector2 | The bottom row of the two-dimensional square matrix. |
- Returns:
- The determinant of the two-dimensional square matrix.
| Vector2 RVO::normalize |
( |
const Vector2 & |
vector |
) |
[inline] |
Computes the normalization of the specified two-dimensional vector.
- Parameters:
-
| vector | The two-dimensional vector whose normalization is to be computed. |
- Returns:
- The normalization of the two-dimensional vector.
| Vector2 RVO::operator* |
( |
float |
s, |
|
|
const Vector2 & |
vector | |
|
) |
| | [inline] |
Computes the scalar multiplication of the specified two-dimensional vector with the specified scalar value.
- Parameters:
-
| s | The scalar value with which the scalar multiplication should be computed. |
| vector | The two-dimensional vector with which the scalar multiplication should be computed. |
- Returns:
- The scalar multiplication of the two-dimensional vector with the scalar value.
| std::ostream& RVO::operator<< |
( |
std::ostream & |
os, |
|
|
const Vector2 & |
vector | |
|
) |
| | [inline] |
Inserts the specified two-dimensional vector into the specified output stream.
- Parameters:
-
| os | The output stream into which the two-dimensional vector should be inserted. |
| vector | The two-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 (or -1 for many compilers) that is returned in case of an error by functions in RVO::RVOSimulator.