HBT::Player Class Reference

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

#include <HBTPlayer.h>

Collaboration diagram for HBT::Player:

[legend]List of all members.

Public Member Functions
	Player ()
	Default constructor.
	Player (const std::string &fileName)
	Constructor.
virtual	~Player ()
	Destructor.
void	open (const std::string &fileName)
	Open the file.
	operator bool () const
	Boolean operator.
Player &	read (InitialisationSequence &intialisationSequence)
	The initialisation sequence reader.
Player &	read (unsigned int &date, PostureData &posture)
	The posture reader.
void	setLoop (bool loop=true)
	Set the behiavor at the end of the file.
Protected Member Functions
Readers
void	read (std::string &txt)
	Read a string.
void	read (bool &flag)
	Read a bool.
void	read (Ogre::Vector3 &vect)
	Read an Ogre::Vector3.
void	read (Ogre::Quaternion &quat)
	Read an Ogre::Quaternion.
template<typename T>
void	read (std::vector< T > &tab)
	Read a vector of T.
template<typename T>
void	read (T &val)
	Read a T.
Protected Attributes
bool	_initRead
	The flag to know if the initialisation sequence is read.
bool	_loop
	The flag to loop at the end of the file.
std::ifstream	_file
	The file where the data will be written.
PostureData	_lastPosture
	The last read posture.
unsigned int	_lastDate
	The last read date.

---

Detailed Description

This object defines a reader for the posture data.

The format is a binary file in three parts, see Recorder.

Example of use :

  AvatarMesh avatar ;
  // Open the file
  Player player( filename ) ;
  // Do the initialisations of the avatar mesh 
  InitialisationSequence initialisationSequence ;
  player.read( InitialisationSequence ) ;
  avatar.init( ogreSceneManager, &initialisationSequence ) ;
  avatar.show() ;
  for( ;; )
  {
    // And for each step update the posture
    unsigned int date ;
    PostureData posture ;
    player.read( date, posture ) ;
    avatar.update( posture ) ;
  }

Definition at line 35 of file HBTPlayer.h.

---

Constructor & Destructor Documentation

Player::Player

(

)

Default constructor.

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

Definition at line 18 of file HBTPlayer.cpp.

: _initRead( false ),
  _loop( false ),
  _file()
{ 
}

Player::Player

(

const std::string &

fileName

)

Constructor.

Parameters:

[in]

fileName,the

file where the data will be read.

This constructor calls open to define the file.

Definition at line 10 of file HBTPlayer.cpp.

References open().

: _initRead( false ),
  _loop( false ),
  _file()
{ 
  open( fileName ) ;
}

Player::~Player

(

)

[virtual]

Destructor.

Closes the file.

Definition at line 25 of file HBTPlayer.cpp.

References _file.

{
  _file.close() ;
}

---

Member Function Documentation

void Player::open

(

const std::string &

fileName

)

Open the file.

Parameters:

[in]

fileName,the

file where the data will be read.

Definition at line 30 of file HBTPlayer.cpp.

References _file, and _initRead.

Referenced by OMK::HumanoPlayer::loadParameters(), and Player().

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

HBT::Player::operator bool

(

)

const [inline]

Boolean operator.

Returns:

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

Definition at line 55 of file HBTPlayer.h.

{ return _initRead ; }

Player & Player::read

(

InitialisationSequence &

intialisationSequence

)

The initialisation sequence reader.

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

Definition at line 89 of file HBTPlayer.cpp.

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

Referenced by OMK::HumanoPlayer::computeParameters(), OMK::HumanoPlayer::loadParameters(), and read().

{
  OBT_ASSERT( _file.is_open() && "The file is not opened" ) ;
  // Go to the beginning of the file
  _file.seekg( 0 ) ;

  // Tag
  std::string header ;
  read( header ) ;
  size_t length = Recorder::HEADER.length() ;
  OBT_ASSERT( header.substr( 0, length ) == Recorder::HEADER && "Not the good header" ) ;
  // Version
  if( header.substr( length ) == "0" )
  {
    read( initialisationSequence.meshFile ) ;
    read( initialisationSequence.humanName ) ;
    read( initialisationSequence.useShadows ) ;
    read( initialisationSequence.generalScale ) ;
    read( initialisationSequence.rootQuat ) ;
    read( initialisationSequence.rootPos ) ;
    read( initialisationSequence.boneNumber ) ;
    read( initialisationSequence.postureQuat ) ;
  }
  else
  {
    OBT_ASSERT( false && "not the good version" ) ; // version
  }

  _initRead = true ;
  return *this ;
}

Player & Player::read	(	unsigned int &	date,
		PostureData &	posture
	)

The posture reader.

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

See setLoop to know the behavior at the end of the file.

Definition at line 121 of file HBTPlayer.cpp.

References _file, _initRead, _lastDate, _lastPosture, _loop, HBT::PostureData::generalScale, HBT::PostureData::postureQuat, HBT::PostureData::quatModified, read(), HBT::PostureData::rootPos, and HBT::PostureData::rootQuat.

{
  OBT_ASSERT( _file.is_open() && "The file is not opened" ) ;
  OBT_ASSERT( _initRead && "You must read InitialisationSequence before reading the posture data" ) ;
  _file.peek() ;
  if( !_file.eof() )
  {
    read( _lastDate ) ; 
    read( _lastPosture.rootPos ) ; 
    read( _lastPosture.rootQuat ) ;    
    read( _lastPosture.generalScale ) ;
    read( _lastPosture.postureQuat ) ; 
    read( _lastPosture.quatModified ) ;
  }
  else if( _loop )
  {
    _file.clear() ;
    InitialisationSequence initialisationSequence ;
    read( initialisationSequence ) ;
  }
  date = _lastDate ;
  posture = _lastPosture ;
  return *this ;
}

void HBT::Player::setLoop

(

bool

loop = true

)

[inline]

Set the behiavor at the end of the file.

Parameters:

[in]

loop,the

flag.

The behavior depends of the flag value

• true, the file is rewind to the begining and the posture does a loop.
• false, at the end of the file, the posture given by the operator >> ( PostureData& ) "stream operator" is the last one.

This flag can be set at any time.

Definition at line 75 of file HBTPlayer.h.

Referenced by OMK::HumanoPlayer::computeParameters(), and OMK::HumanoPlayer::loadParameters().

{ _loop = loop ; }

void Player::read

(

std::string &

txt

)

[protected]

Read a string.

Definition at line 36 of file HBTPlayer.cpp.

References _file.

{
  size_t size ;
  _file.read( (char*)&size, sizeof(size) ) ;
  char* txtTmp = new char[ size ] ;
  _file.read( txtTmp, size ) ;
  txt = txtTmp ;
  delete[] txtTmp ;
}

void Player::read

(

bool &

flag

)

[protected]

Read a bool.

Definition at line 46 of file HBTPlayer.cpp.

References _file.

{
  char tmp ;
  _file.read( &tmp, 1 ) ;
  flag = tmp == '1' ;
}

void Player::read

(

Ogre::Vector3 &

vect

)

[protected]

Read an Ogre::Vector3.

Definition at line 59 of file HBTPlayer.cpp.

References _file.

{
  _file.read( (char*)&vect.x, sizeof( Ogre::Real ) ) ;
  _file.read( (char*)&vect.y, sizeof( Ogre::Real ) ) ;
  _file.read( (char*)&vect.z, sizeof( Ogre::Real ) ) ;
}

void Player::read

(

Ogre::Quaternion &

quat

)

[protected]

Read an Ogre::Quaternion.

Definition at line 66 of file HBTPlayer.cpp.

References _file.

{
  _file.read( (char*)&quat.w, sizeof( Ogre::Real ) ) ;
  _file.read( (char*)&quat.x, sizeof( Ogre::Real ) ) ;
  _file.read( (char*)&quat.y, sizeof( Ogre::Real ) ) ;
  _file.read( (char*)&quat.z, sizeof( Ogre::Real ) ) ;
}

template<typename T>

void Player::read

(

std::vector< T > &

tab

)

[protected]

Read a vector of T.

Definition at line 75 of file HBTPlayer.cpp.

References _file, and read().

{
  tab.clear() ;
  size_t size ;
  _file.read( (char*)&size, sizeof( size_t ) ) ;
  for( ; size != 0 ; size-- )
  {
    T val ;
    read( val ) ;
    tab.push_back( val ) ;
  }
}

template<typename T>

void Player::read

(

T &

val

)

[protected]

Read a T.

Definition at line 54 of file HBTPlayer.cpp.

References _file.

{
  _file.read( (char*)&val, sizeof( T ) ) ;
}

---

Member Data Documentation

bool HBT::Player::_initRead [protected]

The flag to know if the initialisation sequence is read.

Definition at line 78 of file HBTPlayer.h.

Referenced by open(), and read().

bool HBT::Player::_loop [protected]

The flag to loop at the end of the file.

See setLoop.

Definition at line 81 of file HBTPlayer.h.

Referenced by read().

std::ifstream HBT::Player::_file [protected]

The file where the data will be written.

Definition at line 83 of file HBTPlayer.h.

Referenced by open(), read(), and ~Player().

PostureData HBT::Player::_lastPosture [protected]

The last read posture.

Used when the loop is set to false.

Definition at line 86 of file HBTPlayer.h.

Referenced by read().

unsigned int HBT::Player::_lastDate [protected]

The last read date.

Used when the loop is set to false.

Definition at line 89 of file HBTPlayer.h.

Referenced by read().

---