Public API Reference

csPath Class Reference
[Geometry utilities]

A path in 3D. More...

#include <csgeom/path.h>

Inheritance diagram for csPath:

[legend]List of all members.

Public Member Functions
virtual void	Calculate (float time)
	Calculate internal values for this spline given some time value.
virtual void	CalculateAtTime (float time)
	Calculate internal values for this spline given some time value.
	csPath (int p)
	Create a path with p points.
virtual int	GetCurrentIndex ()
	Get current index.
float	GetDimensionValue (int dim, int idx) const
	Get the value for some dimension.
float const *	GetDimensionValues (int dim) const
	Get the values for some dimension.
virtual void	GetForwardVector (int idx, csVector3 &v)
	Get one forward vector.
virtual void	GetInterpolatedForward (csVector3 &pos)
	Get the interpolated forward vector.
virtual void	GetInterpolatedPosition (csVector3 &pos)
	Get the interpolated position.
virtual void	GetInterpolatedUp (csVector3 &pos)
	Get the interpolated up vector.
int	GetPointCount ()
	Get the number of vector points in this spline.
virtual void	GetPositionVector (int idx, csVector3 &v)
	Get one position vector.
virtual float	GetTime (int idx)
	Get one time point.
float const *	GetTimes () const
	Get the time values.
float	GetTimeValue (int idx) const
	Get one time point.
float const *	GetTimeValues () const
	Get the time values.
virtual void	GetUpVector (int idx, csVector3 &v)
	Get one up vector.
void	InsertPoint (int idx)
	Insert a point after some index.
virtual int	Length ()
	Get the number of vector points in this spline.
void	RemovePoint (int idx)
	Remove a point at the index.
virtual void	SetForwardVector (int idx, const csVector3 &v)
	Set one forward vector.
virtual void	SetForwardVectors (csVector3 *v)
	Set the forward vectors (dimensions 6 to 8).
virtual void	SetPositionVector (int idx, const csVector3 &v)
	Set one position vector.
virtual void	SetPositionVectors (csVector3 *v)
	Set the position vectors (first three dimensions of the cubic spline).
virtual void	SetTime (int idx, float t)
	Set one time point.
void	SetTimes (float const *t)
	Set the time values.
virtual void	SetTimeValue (int idx, float t)
	Set one time point.
void	SetTimeValues (float const *t)
	Set the time values.
virtual void	SetUpVector (int idx, const csVector3 &v)
	Set one up vector.
virtual void	SetUpVectors (csVector3 *v)
	Set the up vectors (dimensions 3 to 5).
virtual	~csPath ()
	Destroy the path.
Protected Attributes
csCatmullRomSpline	spline

---

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 44 of file path.h.

---

Constructor & Destructor Documentation

csPath::csPath

(

int

p

)

[inline]

Create a path with p points.

Definition at line 76 of file path.h.

virtual csPath::~csPath

(

)

[inline, virtual]

Destroy the path.

Definition at line 80 of file path.h.

---

Member Function Documentation

virtual void csPath::Calculate

(

float

time

)

[inline, virtual]

Calculate internal values for this spline given some time value.

Deprecated:

Use CalculateAtTime() instead.

Definition at line 107 of file path.h.

virtual void csPath::CalculateAtTime

(

float

time

)

[inline, virtual]

Calculate internal values for this spline given some time value.

Implements iPath.

Definition at line 98 of file path.h.

virtual int csPath::GetCurrentIndex

(

)

[inline, virtual]

Get current index.

Implements iPath.

Definition at line 112 of file path.h.

float csPath::GetDimensionValue	(	int	dim,
		int	idx
	)			const [inline]

Get the value for some dimension.

Definition at line 262 of file path.h.

float const* csPath::GetDimensionValues

(

int

dim

)

const [inline]

Get the values for some dimension.

Definition at line 257 of file path.h.

virtual void csPath::GetForwardVector	(	int	idx,
		csVector3 &	v
	)			[inline, virtual]

Get one forward vector.

Implements iPath.

Definition at line 228 of file path.h.

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

virtual void csPath::GetInterpolatedForward

(

csVector3 &

pos

)

[inline, virtual]

Get the interpolated forward vector.

Implements iPath.

Definition at line 250 of file path.h.

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

virtual void csPath::GetInterpolatedPosition

(

csVector3 &

pos

)

[inline, virtual]

Get the interpolated position.

Implements iPath.

Definition at line 236 of file path.h.

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

virtual void csPath::GetInterpolatedUp

(

csVector3 &

pos

)

[inline, virtual]

Get the interpolated up vector.

Implements iPath.

Definition at line 243 of file path.h.

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

int csPath::GetPointCount

(

)

[inline]

Get the number of vector points in this spline.

Deprecated:

Use Length() instead.

Definition at line 93 of file path.h.

virtual void csPath::GetPositionVector	(	int	idx,
		csVector3 &	v
	)			[inline, virtual]

Get one position vector.

Implements iPath.

Definition at line 214 of file path.h.

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

virtual float csPath::GetTime

(

int

idx

)

[inline, virtual]

Get one time point.

Implements iPath.

Definition at line 117 of file path.h.

float const* csPath::GetTimes

(

)

const [inline]

Get the time values.

Definition at line 164 of file path.h.

float csPath::GetTimeValue

(

int

idx

)

const [inline]

Get one time point.

Deprecated:

Use GetTime() instead.

Definition at line 126 of file path.h.

float const* csPath::GetTimeValues

(

)

const [inline]

Get the time values.

Deprecated:

Use GetTimes() instead.

Definition at line 173 of file path.h.

virtual void csPath::GetUpVector	(	int	idx,
		csVector3 &	v
	)			[inline, virtual]

Get one up vector.

Implements iPath.

Definition at line 221 of file path.h.

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

void csPath::InsertPoint

(

int

idx

)

[inline]

Insert a point after some index.

If index == -1 add a point before all others.

Definition at line 270 of file path.h.

virtual int csPath::Length

(

)

[inline, virtual]

Get the number of vector points in this spline.

Implements iPath.

Definition at line 84 of file path.h.

void csPath::RemovePoint

(

int

idx

)

[inline]

Remove a point at the index.

Definition at line 275 of file path.h.

virtual void csPath::SetForwardVector	(	int	idx,
		const csVector3 &	v
	)			[inline, virtual]

Set one forward vector.

Implements iPath.

Definition at line 207 of file path.h.

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

virtual void csPath::SetForwardVectors

(

csVector3 *

v

)

[inline, virtual]

Set the forward vectors (dimensions 6 to 8).

Implements iPath.

Definition at line 188 of file path.h.

virtual void csPath::SetPositionVector	(	int	idx,
		const csVector3 &	v
	)			[inline, virtual]

Set one position vector.

Implements iPath.

Definition at line 193 of file path.h.

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

virtual void csPath::SetPositionVectors

(

csVector3 *

v

)

[inline, virtual]

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

Implements iPath.

Definition at line 178 of file path.h.

virtual void csPath::SetTime	(	int	idx,
		float	t
	)			[inline, virtual]

Set one time point.

Implements iPath.

Definition at line 131 of file path.h.

void csPath::SetTimes

(

float const *

t

)

[inline]

Set the time values.

't' should point to an array containing 'num_points' values. These values typically start with 0 and end with 1. Other values are also possible the but the values should rise. The given array is copied.

Definition at line 150 of file path.h.

virtual void csPath::SetTimeValue	(	int	idx,
		float	t
	)			[inline, virtual]

Set one time point.

Deprecated:

Use SetTime() instead.

Definition at line 140 of file path.h.

void csPath::SetTimeValues

(

float const *

t

)

[inline]

Set the time values.

Deprecated:

Use SetTimes() instead.

Definition at line 159 of file path.h.

virtual void csPath::SetUpVector	(	int	idx,
		const csVector3 &	v
	)			[inline, virtual]

Set one up vector.

Implements iPath.

Definition at line 200 of file path.h.

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

virtual void csPath::SetUpVectors

(

csVector3 *

v

)

[inline, virtual]

Set the up vectors (dimensions 3 to 5).

Implements iPath.

Definition at line 183 of file path.h.

---

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

• csgeom/path.h

---