CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

csPath Class Reference
[Geometry utilities]

A path in 3D. More...

#include <path.h>

Inheritance diagram for csPath:

csCatmullRomSpline csBSpline csSpline List of all members.

Public Methods

 csPath (int p)
 Create a path with p points. More...

virtual ~csPath ()
 Destroy the path. More...

void SetPositionVectors (csVector3 *v)
 Set the position vectors (first three dimensions of the cubic spline). More...

void SetUpVectors (csVector3 *v)
 Set the up vectors (dimensions 3 to 5). More...

void SetForwardVectors (csVector3 *v)
 Set the forward vectors (dimensions 6 to 8). More...

void SetPositionVector (int idx, const csVector3 &v)
 Set one position vector. More...

void SetUpVector (int idx, const csVector3 &v)
 Set one up vector. More...

void SetForwardVector (int idx, const csVector3 &v)
 Set one forward vector. More...

void GetPositionVector (int idx, csVector3 &v)
 Get one position vector. More...

void GetUpVector (int idx, csVector3 &v)
 Get one up vector. More...

void GetForwardVector (int idx, csVector3 &v)
 Get one forward vector. More...

void GetInterpolatedPosition (csVector3 &pos)
 Get the interpolated position. More...

void GetInterpolatedUp (csVector3 &pos)
 Get the interpolated up vector. More...

void GetInterpolatedForward (csVector3 &pos)
 Get the interpolated forward vector. More...


Detailed Description

A path in 3D.

An object or camera can use this object to trace a path in 3D. This is particularly useful in combination with csReversibleTransform::LookAt().

Definition at line 36 of file path.h.


Constructor & Destructor Documentation

csPath::csPath int    p [inline]
 

Create a path with p points.

Definition at line 62 of file path.h.

virtual csPath::~csPath   [inline, virtual]
 

Destroy the path.

Definition at line 65 of file path.h.


Member Function Documentation

void csPath::GetForwardVector int    idx,
csVector3   v
[inline]
 

Get one forward vector.

Definition at line 118 of file path.h.

References csSpline::GetDimensionValue, csVector3::x, csVector3::y, and csVector3::z.

void csPath::GetInterpolatedForward csVector3   pos [inline]
 

Get the interpolated forward vector.

Definition at line 140 of file path.h.

References csBSpline::GetInterpolatedDimension, csVector3::x, csVector3::y, and csVector3::z.

void csPath::GetInterpolatedPosition csVector3   pos [inline]
 

Get the interpolated position.

Definition at line 126 of file path.h.

References csBSpline::GetInterpolatedDimension, csVector3::x, csVector3::y, and csVector3::z.

void csPath::GetInterpolatedUp csVector3   pos [inline]
 

Get the interpolated up vector.

Definition at line 133 of file path.h.

References csBSpline::GetInterpolatedDimension, csVector3::x, csVector3::y, and csVector3::z.

void csPath::GetPositionVector int    idx,
csVector3   v
[inline]
 

Get one position vector.

Definition at line 104 of file path.h.

References csSpline::GetDimensionValue, csVector3::x, csVector3::y, and csVector3::z.

void csPath::GetUpVector int    idx,
csVector3   v
[inline]
 

Get one up vector.

Definition at line 111 of file path.h.

References csSpline::GetDimensionValue, csVector3::x, csVector3::y, and csVector3::z.

void csPath::SetForwardVector int    idx,
const csVector3   v
[inline]
 

Set one forward vector.

Definition at line 97 of file path.h.

References csSpline::SetDimensionValue, csVector3::x, csVector3::y, and csVector3::z.

void csPath::SetForwardVectors csVector3   v [inline]
 

Set the forward vectors (dimensions 6 to 8).

Definition at line 78 of file path.h.

void csPath::SetPositionVector int    idx,
const csVector3   v
[inline]
 

Set one position vector.

Definition at line 83 of file path.h.

References csSpline::SetDimensionValue, csVector3::x, csVector3::y, and csVector3::z.

void csPath::SetPositionVectors csVector3   v [inline]
 

Set the position vectors (first three dimensions of the cubic spline).

Definition at line 68 of file path.h.

void csPath::SetUpVector int    idx,
const csVector3   v
[inline]
 

Set one up vector.

Definition at line 90 of file path.h.

References csSpline::SetDimensionValue, csVector3::x, csVector3::y, and csVector3::z.

void csPath::SetUpVectors csVector3   v [inline]
 

Set the up vectors (dimensions 3 to 5).

Definition at line 73 of file path.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14