OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::SkeletonSerializer Class Reference

Class for serialising skeleton data to/from an OGRE .skeleton file. More...

#include <OgreSkeletonSerializer.h>

+ Inheritance diagram for Ogre::SkeletonSerializer:
+ Collaboration diagram for Ogre::SkeletonSerializer:

Public Types

enum  Endian { ENDIAN_NATIVE, ENDIAN_BIG, ENDIAN_LITTLE }
 The endianness of written files. More...
 

Public Member Functions

 SkeletonSerializer ()
 
virtual ~SkeletonSerializer ()
 
void exportSkeleton (const Skeleton *pSkeleton, const String &filename, SkeletonVersion ver=SKELETON_VERSION_LATEST, Endian endianMode=ENDIAN_NATIVE)
 Exports a skeleton to the file specified. More...
 
void exportSkeleton (const Skeleton *pSkeleton, DataStreamPtr stream, SkeletonVersion ver=SKELETON_VERSION_LATEST, Endian endianMode=ENDIAN_NATIVE)
 Exports a skeleton to the stream specified. More...
 
void importSkeleton (DataStreamPtr &stream, Skeleton *pDest)
 Imports Skeleton and animation data from a .skeleton file DataStream. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 

Protected Member Functions

virtual void backpedalChunkHeader (DataStreamPtr &stream)
 
size_t calcAnimationSize (const Skeleton *pSkel, const Animation *pAnim, SkeletonVersion ver)
 
size_t calcAnimationTrackSize (const Skeleton *pSkel, const OldNodeAnimationTrack *pTrack)
 
size_t calcBoneParentSize (const Skeleton *pSkel)
 
size_t calcBoneSize (const Skeleton *pSkel, const OldBone *pBone)
 
size_t calcBoneSizeWithoutScale (const Skeleton *pSkel, const OldBone *pBone)
 
virtual size_t calcChunkHeaderSize ()
 
size_t calcKeyFrameSize (const Skeleton *pSkel, const TransformKeyFrame *pKey)
 
size_t calcKeyFrameSizeWithoutScale (const Skeleton *pSkel, const TransformKeyFrame *pKey)
 
size_t calcSkeletonAnimationLinkSize (const Skeleton *pSkel, const LinkedSkeletonAnimationSource &link)
 
size_t calcStringSize (const String &string)
 
virtual void determineEndianness (DataStreamPtr &stream)
 Determine the endianness of the incoming stream compared to native. More...
 
virtual void determineEndianness (Endian requestedEndian)
 Determine the endianness to write with based on option. More...
 
virtual void flipEndian (void *pData, size_t size, size_t count)
 
virtual void flipEndian (void *pData, size_t size)
 
virtual void flipFromLittleEndian (void *pData, size_t size, size_t count=1)
 
virtual void flipToLittleEndian (void *pData, size_t size, size_t count=1)
 
virtual void popInnerChunk (const DataStreamPtr &stream)
 
virtual void pushInnerChunk (const DataStreamPtr &stream)
 
void readAnimation (DataStreamPtr &stream, Skeleton *pSkel)
 
void readAnimationTrack (DataStreamPtr &stream, Animation *anim, Skeleton *pSkel)
 
void readBone (DataStreamPtr &stream, Skeleton *pSkel)
 
void readBoneParent (DataStreamPtr &stream, Skeleton *pSkel)
 
void readBools (DataStreamPtr &stream, bool *pDest, size_t count)
 
virtual unsigned short readChunk (DataStreamPtr &stream)
 
void readFileHeader (DataStreamPtr &stream)
 
void readFloats (DataStreamPtr &stream, float *pDest, size_t count)
 
void readFloats (DataStreamPtr &stream, double *pDest, size_t count)
 
void readInts (DataStreamPtr &stream, uint32 *pDest, size_t count)
 
void readKeyFrame (DataStreamPtr &stream, OldNodeAnimationTrack *track, Skeleton *pSkel)
 
void readObject (DataStreamPtr &stream, Vector3 &pDest)
 
void readObject (DataStreamPtr &stream, Quaternion &pDest)
 
void readShorts (DataStreamPtr &stream, uint16 *pDest, size_t count)
 
void readSkeletonAnimationLink (DataStreamPtr &stream, Skeleton *pSkel)
 
String readString (DataStreamPtr &stream)
 
String readString (DataStreamPtr &stream, size_t numChars)
 
void setWorkingVersion (SkeletonVersion ver)
 
void writeAnimation (const Skeleton *pSkel, const Animation *anim, SkeletonVersion ver)
 
void writeAnimationTrack (const Skeleton *pSkel, const OldNodeAnimationTrack *track)
 
void writeBone (const Skeleton *pSkel, const OldBone *pBone)
 
void writeBoneParent (const Skeleton *pSkel, unsigned short boneId, unsigned short parentId)
 
void writeBools (const bool *const pLong, size_t count)
 
virtual void writeChunkHeader (uint16 id, size_t size)
 
void writeData (const void *const buf, size_t size, size_t count)
 
virtual void writeFileHeader (void)
 Default to native endian, derive from header. More...
 
void writeFloats (const float *const pfloat, size_t count)
 
void writeFloats (const double *const pfloat, size_t count)
 
void writeInts (const uint32 *const pInt, size_t count)
 
void writeKeyFrame (const Skeleton *pSkel, const TransformKeyFrame *key)
 
void writeObject (const Vector3 &vec)
 
void writeObject (const Quaternion &q)
 
void writeShorts (const uint16 *const pShort, size_t count)
 
void writeSkeleton (const Skeleton *pSkel, SkeletonVersion ver)
 
void writeSkeletonAnimationLink (const Skeleton *pSkel, const LinkedSkeletonAnimationSource &link)
 
void writeString (const String &string)
 

Protected Attributes

uint32 mCurrentstreamLen
 
bool mFlipEndian
 
DataStreamPtr mStream
 
String mVersion
 

Detailed Description

Class for serialising skeleton data to/from an OGRE .skeleton file.

Remarks
This class allows exporters to write OGRE .skeleton files easily, and allows the OGRE engine to import .skeleton files into instantiated OGRE Skeleton objects. Note that a .skeleton file includes not only the Skeleton, but also definitions of any Animations it uses.
To export a Skeleton:
  1. Create a Skeleton object and populate it using it's methods.
  2. Call the exportSkeleton method

Definition at line 69 of file OgreSkeletonSerializer.h.

Member Enumeration Documentation

enum Ogre::Serializer::Endian
inherited

The endianness of written files.

Enumerator
ENDIAN_NATIVE 

Use the platform native endian.

ENDIAN_BIG 

Use big endian (0x1000 is serialised as 0x10 0x00)

ENDIAN_LITTLE 

Use little endian (0x1000 is serialised as 0x00 0x10)

Definition at line 59 of file OgreSerializer.h.

Constructor & Destructor Documentation

Ogre::SkeletonSerializer::SkeletonSerializer ( )
virtual Ogre::SkeletonSerializer::~SkeletonSerializer ( )
virtual

Member Function Documentation

virtual void Ogre::Serializer::backpedalChunkHeader ( DataStreamPtr stream)
protectedvirtualinherited
size_t Ogre::SkeletonSerializer::calcAnimationSize ( const Skeleton pSkel,
const Animation pAnim,
SkeletonVersion  ver 
)
protected
size_t Ogre::SkeletonSerializer::calcAnimationTrackSize ( const Skeleton pSkel,
const OldNodeAnimationTrack pTrack 
)
protected
size_t Ogre::SkeletonSerializer::calcBoneParentSize ( const Skeleton pSkel)
protected
size_t Ogre::SkeletonSerializer::calcBoneSize ( const Skeleton pSkel,
const OldBone pBone 
)
protected
size_t Ogre::SkeletonSerializer::calcBoneSizeWithoutScale ( const Skeleton pSkel,
const OldBone pBone 
)
protected
virtual size_t Ogre::Serializer::calcChunkHeaderSize ( )
protectedvirtualinherited
size_t Ogre::SkeletonSerializer::calcKeyFrameSize ( const Skeleton pSkel,
const TransformKeyFrame pKey 
)
protected
size_t Ogre::SkeletonSerializer::calcKeyFrameSizeWithoutScale ( const Skeleton pSkel,
const TransformKeyFrame pKey 
)
protected
size_t Ogre::SkeletonSerializer::calcSkeletonAnimationLinkSize ( const Skeleton pSkel,
const LinkedSkeletonAnimationSource link 
)
protected
size_t Ogre::Serializer::calcStringSize ( const String string)
protectedinherited
virtual void Ogre::Serializer::determineEndianness ( DataStreamPtr stream)
protectedvirtualinherited

Determine the endianness of the incoming stream compared to native.

virtual void Ogre::Serializer::determineEndianness ( Endian  requestedEndian)
protectedvirtualinherited

Determine the endianness to write with based on option.

void Ogre::SkeletonSerializer::exportSkeleton ( const Skeleton pSkeleton,
const String filename,
SkeletonVersion  ver = SKELETON_VERSION_LATEST,
Endian  endianMode = ENDIAN_NATIVE 
)

Exports a skeleton to the file specified.

Remarks
This method takes an externally created Skeleton object, and exports both it and animations it uses to a .skeleton file.
Parameters
pSkeletonWeak reference to the Skeleton to export
filenameThe destination filename
endianModeThe endian mode to write in
void Ogre::SkeletonSerializer::exportSkeleton ( const Skeleton pSkeleton,
DataStreamPtr  stream,
SkeletonVersion  ver = SKELETON_VERSION_LATEST,
Endian  endianMode = ENDIAN_NATIVE 
)

Exports a skeleton to the stream specified.

Remarks
This method takes an externally created Skeleton object, and exports both it and animations it uses to a .skeleton file.
Parameters
pSkeletonWeak reference to the Skeleton to export
streamThe destination stream
endianModeThe endian mode to write in
virtual void Ogre::Serializer::flipEndian ( void *  pData,
size_t  size,
size_t  count 
)
protectedvirtualinherited
virtual void Ogre::Serializer::flipEndian ( void *  pData,
size_t  size 
)
protectedvirtualinherited
virtual void Ogre::Serializer::flipFromLittleEndian ( void *  pData,
size_t  size,
size_t  count = 1 
)
protectedvirtualinherited
virtual void Ogre::Serializer::flipToLittleEndian ( void *  pData,
size_t  size,
size_t  count = 1 
)
protectedvirtualinherited
void Ogre::SkeletonSerializer::importSkeleton ( DataStreamPtr stream,
Skeleton pDest 
)

Imports Skeleton and animation data from a .skeleton file DataStream.

Remarks
This method imports data from a DataStream opened from a .skeleton file and places it's contents into the Skeleton object which is passed in.
Parameters
streamThe DataStream holding the .skeleton data. Must be initialised (pos at the start of the buffer).
pDestWeak reference to the Skeleton object which will receive the data. Should be blank already.
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Serializer::popInnerChunk ( const DataStreamPtr stream)
protectedvirtualinherited
virtual void Ogre::Serializer::pushInnerChunk ( const DataStreamPtr stream)
protectedvirtualinherited
void Ogre::SkeletonSerializer::readAnimation ( DataStreamPtr stream,
Skeleton pSkel 
)
protected
void Ogre::SkeletonSerializer::readAnimationTrack ( DataStreamPtr stream,
Animation anim,
Skeleton pSkel 
)
protected
void Ogre::SkeletonSerializer::readBone ( DataStreamPtr stream,
Skeleton pSkel 
)
protected
void Ogre::SkeletonSerializer::readBoneParent ( DataStreamPtr stream,
Skeleton pSkel 
)
protected
void Ogre::Serializer::readBools ( DataStreamPtr stream,
bool *  pDest,
size_t  count 
)
protectedinherited
virtual unsigned short Ogre::Serializer::readChunk ( DataStreamPtr stream)
protectedvirtualinherited
void Ogre::SkeletonSerializer::readFileHeader ( DataStreamPtr stream)
protectedvirtual

Reimplemented from Ogre::Serializer.

void Ogre::Serializer::readFloats ( DataStreamPtr stream,
float *  pDest,
size_t  count 
)
protectedinherited
void Ogre::Serializer::readFloats ( DataStreamPtr stream,
double *  pDest,
size_t  count 
)
protectedinherited
void Ogre::Serializer::readInts ( DataStreamPtr stream,
uint32 pDest,
size_t  count 
)
protectedinherited
void Ogre::SkeletonSerializer::readKeyFrame ( DataStreamPtr stream,
OldNodeAnimationTrack track,
Skeleton pSkel 
)
protected
void Ogre::Serializer::readObject ( DataStreamPtr stream,
Vector3 pDest 
)
protectedinherited
void Ogre::Serializer::readObject ( DataStreamPtr stream,
Quaternion pDest 
)
protectedinherited
void Ogre::Serializer::readShorts ( DataStreamPtr stream,
uint16 pDest,
size_t  count 
)
protectedinherited
void Ogre::SkeletonSerializer::readSkeletonAnimationLink ( DataStreamPtr stream,
Skeleton pSkel 
)
protected
String Ogre::Serializer::readString ( DataStreamPtr stream)
protectedinherited
String Ogre::Serializer::readString ( DataStreamPtr stream,
size_t  numChars 
)
protectedinherited
void Ogre::SkeletonSerializer::setWorkingVersion ( SkeletonVersion  ver)
protected
void Ogre::SkeletonSerializer::writeAnimation ( const Skeleton pSkel,
const Animation anim,
SkeletonVersion  ver 
)
protected
void Ogre::SkeletonSerializer::writeAnimationTrack ( const Skeleton pSkel,
const OldNodeAnimationTrack track 
)
protected
void Ogre::SkeletonSerializer::writeBone ( const Skeleton pSkel,
const OldBone pBone 
)
protected
void Ogre::SkeletonSerializer::writeBoneParent ( const Skeleton pSkel,
unsigned short  boneId,
unsigned short  parentId 
)
protected
void Ogre::Serializer::writeBools ( const bool *const  pLong,
size_t  count 
)
protectedinherited
virtual void Ogre::Serializer::writeChunkHeader ( uint16  id,
size_t  size 
)
protectedvirtualinherited
void Ogre::Serializer::writeData ( const void *const  buf,
size_t  size,
size_t  count 
)
protectedinherited
virtual void Ogre::Serializer::writeFileHeader ( void  )
protectedvirtualinherited

Default to native endian, derive from header.

void Ogre::Serializer::writeFloats ( const float *const  pfloat,
size_t  count 
)
protectedinherited
void Ogre::Serializer::writeFloats ( const double *const  pfloat,
size_t  count 
)
protectedinherited
void Ogre::Serializer::writeInts ( const uint32 *const  pInt,
size_t  count 
)
protectedinherited
void Ogre::SkeletonSerializer::writeKeyFrame ( const Skeleton pSkel,
const TransformKeyFrame key 
)
protected
void Ogre::Serializer::writeObject ( const Vector3 vec)
protectedinherited
void Ogre::Serializer::writeObject ( const Quaternion q)
protectedinherited
void Ogre::Serializer::writeShorts ( const uint16 *const  pShort,
size_t  count 
)
protectedinherited
void Ogre::SkeletonSerializer::writeSkeleton ( const Skeleton pSkel,
SkeletonVersion  ver 
)
protected
void Ogre::SkeletonSerializer::writeSkeletonAnimationLink ( const Skeleton pSkel,
const LinkedSkeletonAnimationSource link 
)
protected
void Ogre::Serializer::writeString ( const String string)
protectedinherited

Member Data Documentation

uint32 Ogre::Serializer::mCurrentstreamLen
protectedinherited

Definition at line 72 of file OgreSerializer.h.

bool Ogre::Serializer::mFlipEndian
protectedinherited

Definition at line 75 of file OgreSerializer.h.

DataStreamPtr Ogre::Serializer::mStream
protectedinherited

Definition at line 73 of file OgreSerializer.h.

String Ogre::Serializer::mVersion
protectedinherited

Definition at line 74 of file OgreSerializer.h.


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