HBT::Recorder Class Reference

This object defines a writer for the posture data. More...

#include <HBTRecorder.h>

Collaboration diagram for HBT::Recorder:

[legend]List of all members.

Public Member Functions
	Recorder ()
	Default constructor.
	Recorder (const std::string &fileName)
	Constructor.
virtual	~Recorder ()
	Destructor.
void	open (const std::string &fileName)
	Open the file.
	operator bool () const
	Boolean operator.
Recorder &	write (const InitialisationSequence &intialisationSequence)
	The initialisation sequence writer.
Recorder &	write (unsigned int date, const PostureData &posture)
	The posture writer.
Static Public Attributes
static const std::string	HEADER
	The header.
Protected Member Functions
Writers
void	write (const std::string &txt)
	Write a string.
void	write (const bool &flag)
	Write a bool.
void	write (const Ogre::Vector3 &vect)
	Write an Ogre::Vector3.
void	write (const Ogre::Quaternion &quat)
	Write an Ogre::Quaternion.
template<typename T>
void	write (const std::vector< T > &tab)
	Write a vector of T.
template<typename T>
void	write (const T &val)
	Write a T.
Protected Attributes
bool	_initRecorded
	The flag to know if the initialisation sequence is written.
std::ofstream	_file
	The file where the data will be written.

---

Detailed Description

This object defines a writer for the posture data.

The format is a binary file in three parts :

• the text "PostureFileVer0\0" (17 bytes) as a header (could change in futur format)
• one initialisation sequence
• the postures until the end of the file.

Example of use :

  // Do the initialisations of the avatar mesh master and of the human control
  initialisationSequence = avatarMeshMaster.init( treehMesh, meshFile,
                      name, true,
                      nodeAssociationFile,
                      useShadows, axis, scale,
                      0.0f ) ;
  humanControl.init( treehMesh ) ;
  // Store the initialisation sequence
  Recorder recorder( fileName ) ;
  recorder.write( *initialisationSequence ) ;
  for( ;; )
  {
    // And for each step update the posture and store it
    humanControl.update( frequency );
    humanControl.getPosture().computeToRelative( avatarMeshMaster );
    recorder.write( *avatarMeshMaster.computeAndGetPostureDatas() ) ;
  }

Definition at line 39 of file HBTRecorder.h.

---

Constructor & Destructor Documentation

Recorder::Recorder

(

)

Default constructor.

Use open to define the name of the file where the data will be written.

Definition at line 18 of file HBTRecorder.cpp.

: _initRecorded( false ),
  _file()
{ 
}

Recorder::Recorder

(

const std::string &

fileName

)

Constructor.

Parameters:

[in]

fileName,the

file where the data will be written.

This constructor calls open to define the file.

Definition at line 10 of file HBTRecorder.cpp.

References open().

: _initRecorded( false ),
  _file()
{ 
  // Open directly the file
  open( fileName ) ;
}

Recorder::~Recorder

(

)

[virtual]

Destructor.

Closes the file.

Definition at line 24 of file HBTRecorder.cpp.

References _file.

{
  _file.close() ;
}

---

Member Function Documentation

void Recorder::open

(

const std::string &

fileName

)

Open the file.

Parameters:

[in]

fileName,the

file where the data will be written.

Definition at line 29 of file HBTRecorder.cpp.

References _file.

Referenced by OMK::HumanoRecorder::loadParameters(), and Recorder().

{
  _file.open( fileName.c_str(), std::ios::binary ) ;
}

HBT::Recorder::operator bool

(

)

const [inline]

Boolean operator.

Returns:

true if the initialisation sequence have been already write, or false if not.

Definition at line 59 of file HBTRecorder.h.

{ return _initRecorded ; }

Recorder & Recorder::write

(

const InitialisationSequence &

intialisationSequence

)

The initialisation sequence writer.

Parameters:

[in]

intialisationSequence

The intialisation sequence.

This writer must be called first, before any call to the posture writer.

Definition at line 86 of file HBTRecorder.cpp.

References _file, _initRecorded, HBT::InitialisationSequence::boneNumber, HBT::InitialisationSequence::generalScale, HEADER, HBT::InitialisationSequence::humanName, HBT::InitialisationSequence::meshFile, HBT::InitialisationSequence::postureQuat, HBT::InitialisationSequence::rootPos, HBT::InitialisationSequence::rootQuat, and HBT::InitialisationSequence::useShadows.

Referenced by OMK::HumanoRecorder::computeParameters(), and write().

{
  OBT_ASSERT( _file.is_open() && "The file is not opened" ) ;
  OBT_ASSERT( 0 == _file.tellp() && "The file is not empty" ) ;

  write( HEADER + "0" ) ; // Tag, this is the header with the version number

  write( intialisationSequence.meshFile ) ;
  write( intialisationSequence.humanName ) ;
  write( intialisationSequence.useShadows ) ;
  write( intialisationSequence.generalScale ) ;
  write( intialisationSequence.rootQuat ) ;
  write( intialisationSequence.rootPos ) ;
  write( intialisationSequence.boneNumber ) ;
  write( intialisationSequence.postureQuat ) ;

  _initRecorded = true ;

  return *this ;
}

Recorder & Recorder::write	(	unsigned int	date,
		const PostureData &	posture
	)

The posture writer.

Parameters:

[in]	date	The date.
[in]	posture	The posture.

This writer must be called after the call to the initialisation sequence writer.

Definition at line 107 of file HBTRecorder.cpp.

References _file, _initRecorded, HBT::PostureData::generalScale, HBT::PostureData::postureQuat, HBT::PostureData::quatModified, HBT::PostureData::rootPos, HBT::PostureData::rootQuat, and write().

{
  OBT_ASSERT( _file.is_open() && "The file is not opened" ) ;
  OBT_ASSERT( _initRecorded && "You must write InitialisationSequence before writeing the posture data" ) ;
  write( date ) ;     
  write( posture.rootPos ) ;     
  write( posture.rootQuat ) ;    
  write( posture.generalScale ) ;
  write( posture.postureQuat ) ; 
  write( posture.quatModified ) ;
  return *this ;
}

void Recorder::write

(

const std::string &

txt

)

[protected]

Write a string.

Definition at line 34 of file HBTRecorder.cpp.

References _file.

{
  // size + c string (including the '\0')
  size_t size = txt.size() + 1 ;
  _file.write( (char*)&size, sizeof( size_t )) ;
  _file.write( (char*)txt.c_str(), size ) ;
}

void Recorder::write

(

const bool &

flag

)

[protected]

Write a bool.

Definition at line 42 of file HBTRecorder.cpp.

References _file.

{
  // true => '1', false => '0'
  char tmp = flag ? '1' : '0' ;
  _file.write( &tmp, 1 ) ;
}

void Recorder::write

(

const Ogre::Vector3 &

vect

)

[protected]

Write an Ogre::Vector3.

Definition at line 56 of file HBTRecorder.cpp.

References _file.

{
  // the 3 binary values
  _file.write( (char*)&vect.x, sizeof( Ogre::Real ) ) ;
  _file.write( (char*)&vect.y, sizeof( Ogre::Real ) ) ;
  _file.write( (char*)&vect.z, sizeof( Ogre::Real ) ) ;
}

void Recorder::write

(

const Ogre::Quaternion &

quat

)

[protected]

Write an Ogre::Quaternion.

Definition at line 64 of file HBTRecorder.cpp.

References _file.

{
  // the 4 binary values
  _file.write( (char*)&quat.w, sizeof( Ogre::Real ) ) ;
  _file.write( (char*)&quat.x, sizeof( Ogre::Real ) ) ;
  _file.write( (char*)&quat.y, sizeof( Ogre::Real ) ) ;
  _file.write( (char*)&quat.z, sizeof( Ogre::Real ) ) ;
}

template<typename T>

void Recorder::write

(

const std::vector< T > &

tab

)

[protected]

Write a vector of T.

Definition at line 74 of file HBTRecorder.cpp.

References _file, and write().

{
  // size of the vector + the N values
  size_t size = tab.size() ;
  _file.write( (char*)&size, sizeof( size_t ) ) ;
  for( size_t i = 0 ; i < size ; i++ )
  {
    write( tab[ i ] ) ;
  }
}

template<typename T>

void Recorder::write

(

const T &

val

)

[protected]

Write a T.

Definition at line 50 of file HBTRecorder.cpp.

References _file.

{
  // the binary value
  _file.write( (char*)&val, sizeof( T ) ) ;
}

---

Member Data Documentation

const std::string Recorder::HEADER [static]

The header.

Definition at line 74 of file HBTRecorder.h.

Referenced by HBT::Player::read(), and write().

bool HBT::Recorder::_initRecorded [protected]

The flag to know if the initialisation sequence is written.

Definition at line 77 of file HBTRecorder.h.

Referenced by write().

std::ofstream HBT::Recorder::_file [protected]

The file where the data will be written.

Definition at line 79 of file HBTRecorder.h.

Referenced by open(), write(), and ~Recorder().

---