ARLK::SkeData Class Reference

#include <SkeData.h>

Public Member Functions
	SkeData ()
	~SkeData ()
bool	AddOneFrame (const Vector4 *SkeVector)
bool	SaveStart (const char *FileName=NULL, int FrameLimit=0, SKELONG TimeLimit=0)
bool	SaveEnd ()
bool	SavingIsStopped ()
	Return true if the saving process is stopped.
int	GetFrameSaved ()
	Get the number of frames saved.
SKEFILEHEADER *	GetSFH ()
SKEINFORHEADER *	GetSIH ()
bool	GetHeaders (FILE *pFile)
bool	GetFramesFromFile (FILE *pFile)
bool	AddFramesFromFile (FILE *pFile)
bool	WriteFrames2File (const char *FileName)
void	ClearContent ()
	Clear the content of m_SkePoints, m_cFrame, m_pSFH and m_pSIH.
SKDPOINT *	GetPoint (int frameIdx, int jointIdx)

Static Public Member Functions
static bool	GetHeaders (FILE *pFile, SKEFILEHEADER *psfh, SKEINFORHEADER *psih)

Constructor & Destructor Documentation

ARLK::SkeData::SkeData

(

)

ARLK::SkeData::~SkeData

(

)

Member Function Documentation

bool ARLK::SkeData::AddFramesFromFile

(

FILE *

pFile

)

Add the frame information from a skd file

Parameters

[in]

pFile

Pointer to the skd file

Returns

True if succeeds

bool ARLK::SkeData::AddOneFrame

(

const Vector4 *

SkeVector

)

Add one frame data to the SkeData variable

Parameters

[in]

SkeVector

Pointer to Vector4 variable containing the joint coordinates in a frame

Returns

Return false if it add no more frame(SkeData::IsStopped == true)

void ARLK::SkeData::ClearContent

(

)

Clear the content of m_SkePoints, m_cFrame, m_pSFH and m_pSIH.

int ARLK::SkeData::GetFrameSaved

(

)

Get the number of frames saved.

bool ARLK::SkeData::GetFramesFromFile

(

FILE *

pFile

)

Get all the information from one skd file

Parameters

[in]

pFile

Pointer to the skd file

Returns

True if succeeds

bool ARLK::SkeData::GetHeaders ( FILE *  pFile, SKEFILEHEADER *  psfh, SKEINFORHEADER *  psih  )

static

Get headers from the skd file

Parameters

[in]	pFile	Pointer to the skd file
[out]	psfh	Pointer to the SKEFILEHEADER structure containing the file header
[out]	psih	Pointer to the SKEINFORHEADER structure containing the info header

Returns

Return true if succeeds

bool ARLK::SkeData::GetHeaders

(

FILE *

pFile

)

Get headers from the skd file and store them in this SkeData structure

Parameters

[in]

pFile

Pointer to the skd file

Returns

True if succeeds

SKDPOINT * ARLK::SkeData::GetPoint	(	int	frameIdx,
		int	jointIdx
	)

Get the position information of a certain skeleton joint

Parameters

[in]	frameIdx	Frame index, counting from 1
[in]	jointIdx	Joint index, counting from 1

Returns

A pointer to SKEPOINT structure containing the 3D position information of the joint; NULL if not found

SKEFILEHEADER * ARLK::SkeData::GetSFH

(

)

Copy SKEFILEHEADER content of the SkeData object and return a pointer to it

Returns

A pointer to SKEFILEHEADER structure containing the file header

SKEINFORHEADER * ARLK::SkeData::GetSIH

(

)

Copy SKEINFORHEADER content of the SkeData object and return a pointer to it

Returns

A pointer to SKEINFORHEADER structure containing the file header

bool ARLK::SkeData::SaveEnd

(

)

Ending the saving process and generate the output file if required

Returns

True if there's no error

bool ARLK::SkeData::SaveStart	(	const char *	FileName = NULL,
		int	FrameLimit = 0,
		SKELONG	TimeLimit = 0
	)

Initializing saving process

Parameters

[in]	FileName	Full path of the file to be saved as
[in]	FrameLimit	Max frame number to be saved, 0 if unlimited
[in]	TimeLimit	Limit of the time, 0 if unlimited

Returns

True if there's no error

bool ARLK::SkeData::SavingIsStopped

(

)

Return true if the saving process is stopped.

bool ARLK::SkeData::WriteFrames2File

(

const char *

FileName

)

Write the SkeData content to a skd file

Parameters

[in]

FileName

Name of the skd file to be generated

Returns

True if succeeds

---

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

• include/ARLK/SkeData.h
• src/ARLK/SkeData.cpp