- Cal3D 0.11 API Reference -

Static Public Member Functions | Static Protected Member Functions
CalSaver Class Reference

The saver class. More...

#include <saver.h>

List of all members.

Static Public Member Functions

static bool saveCoreAnimation (const std::string &strFilename, CalCoreAnimation *pCoreAnimation)
 Saves a core animation instance.
static bool saveCoreMaterial (const std::string &strFilename, CalCoreMaterial *pCoreMaterial)
 Saves a core material instance.
static bool saveCoreMesh (const std::string &strFilename, CalCoreMesh *pCoreMesh)
 Saves a core mesh instance.
static bool saveCoreSkeleton (const std::string &strFilename, CalCoreSkeleton *pCoreSkeleton)
 Saves a core skeleton instance.

Static Protected Member Functions

static bool saveCoreBones (std::ofstream &file, const std::string &strFilename, CalCoreBone *pCoreBone)
 Saves a core bone instance.
static bool saveCoreKeyframe (std::ofstream &file, const std::string &strFilename, CalCoreKeyframe *pCoreKeyframe)
 Saves a core keyframe instance.
static bool saveCoreSubmesh (std::ofstream &file, const std::string &strFilename, CalCoreSubmesh *pCoreSubmesh)
 Saves a core submesh instance.
static bool saveCoreTrack (std::ofstream &file, const std::string &strFilename, CalCoreTrack *pCoreTrack)
 Saves a core track instance.
static bool saveXmlCoreSkeleton (const std::string &strFilename, CalCoreSkeleton *pCoreSkeleton)
 Saves a core skeleton instance to a XML file.
static bool saveXmlCoreAnimation (const std::string &strFilename, CalCoreAnimation *pCoreAnimation)
 Saves a core animation instance in a XML file.
static bool saveXmlCoreMesh (const std::string &strFilename, CalCoreMesh *pCoreMesh)
 Saves a core mesh instance in a XML file.
static bool saveXmlCoreMaterial (const std::string &strFilename, CalCoreMaterial *pCoreMaterial)
 Saves a core material instance to a XML file.

Detailed Description

The saver class.


Member Function Documentation

bool CalSaver::saveCoreAnimation ( const std::string &  strFilename,
CalCoreAnimation pCoreAnimation 
) [static]

Saves a core animation instance.

This function saves a core animation instance to a file.

Parameters:
strFilenameThe name of the file to save the core animation instance to.
pCoreAnimationA pointer to the core animation instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveCoreBones ( std::ofstream &  file,
const std::string &  strFilename,
CalCoreBone pCoreBone 
) [static, protected]

Saves a core bone instance.

This function saves a core bone instance to a file stream.

Parameters:
fileThe file stream to save the core bone instance to.
strFilenameThe name of the file stream.
pCoreBoneA pointer to the core bone instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveCoreKeyframe ( std::ofstream &  file,
const std::string &  strFilename,
CalCoreKeyframe pCoreKeyframe 
) [static, protected]

Saves a core keyframe instance.

This function saves a core keyframe instance to a file stream.

Parameters:
fileThe file stream to save the core keyframe instance to.
strFilenameThe name of the file stream.
pCoreKeyframeA pointer to the core keyframe instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveCoreMaterial ( const std::string &  strFilename,
CalCoreMaterial pCoreMaterial 
) [static]

Saves a core material instance.

This function saves a core material instance to a file.

Parameters:
strFilenameThe name of the file to save the core material instance to.
pCoreMaterialA pointer to the core material instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveCoreMesh ( const std::string &  strFilename,
CalCoreMesh pCoreMesh 
) [static]

Saves a core mesh instance.

This function saves a core mesh instance to a file.

Parameters:
strFilenameThe name of the file to save the core mesh instance to.
pCoreMeshA pointer to the core mesh instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveCoreSkeleton ( const std::string &  strFilename,
CalCoreSkeleton pCoreSkeleton 
) [static]

Saves a core skeleton instance.

This function saves a core skeleton instance to a file.

Parameters:
strFilenameThe name of the file to save the core skeleton instance to.
pCoreSkeletonA pointer to the core skeleton instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveCoreSubmesh ( std::ofstream &  file,
const std::string &  strFilename,
CalCoreSubmesh pCoreSubmesh 
) [static, protected]

Saves a core submesh instance.

This function saves a core submesh instance to a file stream.

Parameters:
fileThe file stream to save the core submesh instance to.
strFilenameThe name of the file stream.
pCoreSubmeshA pointer to the core submesh instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveCoreTrack ( std::ofstream &  file,
const std::string &  strFilename,
CalCoreTrack pCoreTrack 
) [static, protected]

Saves a core track instance.

This function saves a core track instance to a file stream.

Parameters:
fileThe file stream to save the core track instance to.
strFilenameThe name of the file stream.
pCoreTrackA pointer to the core track instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveXmlCoreAnimation ( const std::string &  strFilename,
CalCoreAnimation pCoreAnimation 
) [static, protected]

Saves a core animation instance in a XML file.

This function saves a core animation instance to a XML file.

Parameters:
strFilenameThe name of the file to save the core animation instance to.
pCoreAnimationA pointer to the core animation instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveXmlCoreMaterial ( const std::string &  strFilename,
CalCoreMaterial pCoreMaterial 
) [static, protected]

Saves a core material instance to a XML file.

This function saves a core material instance to a XML file.

Parameters:
strFilenameThe name of the file to save the core material instance to.
pCoreMaterialA pointer to the core material instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveXmlCoreMesh ( const std::string &  strFilename,
CalCoreMesh pCoreMesh 
) [static, protected]

Saves a core mesh instance in a XML file.

This function saves a core mesh instance to a XML file.

Parameters:
strFilenameThe name of the file to save the core mesh instance to.
pCoreMeshA pointer to the core mesh instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalSaver::saveXmlCoreSkeleton ( const std::string &  strFilename,
CalCoreSkeleton pCoreSkeleton 
) [static, protected]

Saves a core skeleton instance to a XML file.

This function saves a core skeleton instance to a XML file.

Parameters:
strFilenameThe name of the file to save the core skeleton instance to.
pCoreSkeletonA pointer to the core skeleton instance that should be saved.
Returns:
One of the following values:
  • true if successful
  • false if an error happend

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

Generated at Sat Jul 2 2011 13:53:45 by The Cal3D Team with Doxygen 1.7.4