ParaScripting::ParaSeqCtrler Class Reference
[ParaScene]

List of all members.

---

Detailed Description

ParaSeqCtrler object: A sequence controller is a biped controller which moves the biped according to some predefined sequence.

it is used to control sequence based commands of character object.

Public Member Functions
bool	IsValid ()
	check if the object is valid
	ParaSeqCtrler (CSequenceCtler *pObj)
bool	Save (bool bOverride)
bool	LoadByID (int nSequenceID)
bool	LoadFromFile (const char *fileName)
int	Create (const char *name, const char *description, const char *pData, bool bInMemory)
string	ToString ()
int	GetKeyPos ()
	Get the current absolute playing cursor position.
void	SetKeyPos (int nPos)
	set the current absolute playing cursor position
int	GetTotalKeys ()
	get total key count
int	AdvanceKey (int nOffset)
	offset the key index according to the current play mode.
void	BeginAddKeys ()
	call the command functions(RunTo, MoveTo, etc) only between the matching pair of BeginAddKeys() and EndAddKeys()
void	EndAddKeys ()
	call the command functions(RunTo, MoveTo, etc) only between the matching pair of BeginAddKeys() and EndAddKeys()
int	GetSequenceID ()
bool	DeleteKeysRange (int nFrom, int nTo)
	delete keys range
bool	GetPlayDirection ()
	get the play direction.
void	SetPlayDirection (bool bForward)
	set the play direction.
float	GetInterval ()
	the minimum time between two successive calls.
void	SetInterval (float fInterval)
	the minimum time between two successive calls.
void	GetStartPos (float &x, float &y, float &z)
	get the starting position.
void	SetStartPos (float x, float y, float z)
	set the starting position.
float	GetStartFacing ()
	get the start facing.
void	SetStartFacing (float facing)
	Set the start facing.
int	GetPlayMode ()
	get the current play mode
void	SetPlayMode (int mode)
	set the current play mode
float	GetMovingTimeout ()
	get the number of seconds after which all move commands will be treated as finished.
void	SetMovingTimeout (float fTimeout)
	set the number of seconds after which all move commands will be treated as finished.
void	Suspend ()
	suspend
void	Resume ()
	resume
void	RunTo (float x, float y, float z)
void	WalkTo (float x, float y, float z)
void	MoveTo (float x, float y, float z)
void	PlayAnim (const char *sAnim)
void	PlayAnim1 (int nAnimID)
void	Wait (float fSeconds)
void	Exec (const char *sCmd)
void	Pause ()
void	Turn (float fAngleAbsolute)
void	MoveForward (float fDistance)
void	MoveBack (float fDistance)
void	MoveLeft (float fDistance)
void	MoveRight (float fDistance)
void	Jump ()
void	Goto (int nOffset)
void	Goto1 (const char *sLable)
void	Lable (const char *sLable)
Public Attributes
CSequenceCtler *	m_pSequenceCtrler

---

Member Function Documentation

int ParaScripting::ParaSeqCtrler::AdvanceKey

(

int

nOffset

)

offset the key index according to the current play mode.

i.e. it will automatically wrap to the beginning if looping.

Parameters:

nOffset,:

number of keys to advance.

Returns:

: the number of keys that have been successfully offseted. Usually if the returned value is not equal to the input value, it means that the sequence should be paused.

bool ParaScripting::ParaSeqCtrler::DeleteKeysRange	(	int	nFrom,
		int	nTo
	)

delete keys range

Parameters:

	nFrom,:	0 based index.
	nTo,:	0 based index, if -1, it means the last one.

bool ParaScripting::ParaSeqCtrler::GetPlayDirection

(

)

get the play direction.

void ParaScripting::ParaSeqCtrler::SetPlayDirection

(

bool

bForward

)

set the play direction.

float ParaScripting::ParaSeqCtrler::GetInterval

(

)

the minimum time between two successive calls.

void ParaScripting::ParaSeqCtrler::SetInterval

(

float

fInterval

)

the minimum time between two successive calls.

void ParaScripting::ParaSeqCtrler::GetStartPos	(	float &	x,
		float &	y,
		float &	z
	)

get the starting position.

void ParaScripting::ParaSeqCtrler::SetStartPos	(	float	x,
		float	y,
		float	z
	)

set the starting position.

float ParaScripting::ParaSeqCtrler::GetStartFacing

(

)

get the start facing.

usually default to 0.

void ParaScripting::ParaSeqCtrler::SetStartFacing

(

float

facing

)

Set the start facing.

usually default to 0.

float ParaScripting::ParaSeqCtrler::GetMovingTimeout

(

)

get the number of seconds after which all move commands will be treated as finished.

default value is 30 seconds.

void ParaScripting::ParaSeqCtrler::SetMovingTimeout

(

float

fTimeout

)

set the number of seconds after which all move commands will be treated as finished.

default value is 30 seconds.

---