- Cal3D 0.11 API Reference -

CalLoader Class Reference

The loader class. More...

#include <loader.h>

List of all members.

Static Public Member Functions

static CalCoreAnimationPtr loadCoreAnimation (const std::string &strFilename, CalCoreSkeleton *skel=NULL)
 Loads a core animation instance.
static CalCoreMaterialPtr loadCoreMaterial (const std::string &strFilename)
 Loads a core material instance.
static CalCoreMeshPtr loadCoreMesh (const std::string &strFilename)
 Loads a core mesh instance.
static CalCoreSkeletonPtr loadCoreSkeleton (const std::string &strFilename)
 Loads a core skeleton instance.
static CalCoreAnimationPtr loadCoreAnimation (std::istream &inputStream, CalCoreSkeleton *skel=NULL)
 Loads a core animation instance.
static CalCoreMaterialPtr loadCoreMaterial (std::istream &inputStream)
 Loads a core material instance.
static CalCoreMeshPtr loadCoreMesh (std::istream &inputStream)
 Loads a core mesh instance.
static CalCoreSkeletonPtr loadCoreSkeleton (std::istream &inputStream)
 Loads a core skeleton instance.
static CalCoreAnimationPtr loadCoreAnimation (void *inputBuffer, CalCoreSkeleton *skel=NULL)
 Loads a core animation instance.
static CalCoreMaterialPtr loadCoreMaterial (void *inputBuffer)
 Loads a core material instance.
static CalCoreMeshPtr loadCoreMesh (void *inputBuffer)
 Loads a core mesh instance.
static CalCoreSkeletonPtr loadCoreSkeleton (void *inputBuffer)
 Loads a core skeleton instance.
static CalCoreAnimationPtr loadCoreAnimation (CalDataSource &inputSrc, CalCoreSkeleton *skel=NULL)
 Loads a core animation instance.
static CalCoreMaterialPtr loadCoreMaterial (CalDataSource &inputSrc)
 Loads a core material instance.
static CalCoreMeshPtr loadCoreMesh (CalDataSource &inputSrc)
 Loads a core mesh instance.
static CalCoreSkeletonPtr loadCoreSkeleton (CalDataSource &inputSrc)
 Loads a core skeleton instance.
static void setLoadingMode (int flags)
 Sets optional flags which affect how the model is loaded into memory.

Detailed Description

The loader class.

Member Function Documentation

CalCoreAnimationPtr CalLoader::loadCoreAnimation (  CalDataSource &  dataSrc,
CalCoreSkeleton *  skel = NULL
)  [static]
 

Loads a core animation instance.

This function loads a core animation instance from a data source.

Parameters:
dataSrc The data source to load the core animation instance from.
Returns:
One of the following values:
  • a pointer to the core animation
  • 0 if an error happened

CalCoreAnimationPtr CalLoader::loadCoreAnimation (  void *  inputBuffer,
CalCoreSkeleton *  skel = NULL
)  [static]
 

Loads a core animation instance.

This function loads a core animation instance from a memory buffer.

Parameters:
inputBuffer The memory buffer to load the core animation instance from. This buffer should be initialized and ready to be read from.
Returns:
One of the following values:
  • a pointer to the core animation
  • 0 if an error happened

CalCoreAnimationPtr CalLoader::loadCoreAnimation (  std::istream &  inputStream,
CalCoreSkeleton *  skel = NULL
)  [static]
 

Loads a core animation instance.

This function loads a core animation instance from an input stream.

Parameters:
inputStream The stream to load the core animation instance from. This stream should be initialized and ready to be read from.
Returns:
One of the following values:
  • a pointer to the core animation
  • 0 if an error happened

CalCoreAnimationPtr CalLoader::loadCoreAnimation (  const std::string &  strFilename,
CalCoreSkeleton *  skel = NULL
)  [static]
 

Loads a core animation instance.

This function loads a core animation instance from a file.

Parameters:
strFilename The file to load the core animation instance from.
Returns:
One of the following values:
  • a pointer to the core animation
  • 0 if an error happened

CalCoreMaterialPtr CalLoader::loadCoreMaterial (  CalDataSource &  dataSrc  )  [static]
 

Loads a core material instance.

This function loads a core material instance from a data source.

Parameters:
dataSrc The data source to load the core material instance from.
Returns:
One of the following values:
  • a pointer to the core material
  • 0 if an error happened

CalCoreMaterialPtr CalLoader::loadCoreMaterial (  void *  inputBuffer  )  [static]
 

Loads a core material instance.

This function loads a core material instance from a memory buffer.

Parameters:
inputBuffer The memory buffer to load the core material instance from. This buffer should be initialized and ready to be read from.
Returns:
One of the following values:
  • a pointer to the core material
  • 0 if an error happened

CalCoreMaterialPtr CalLoader::loadCoreMaterial (  std::istream &  inputStream  )  [static]
 

Loads a core material instance.

This function loads a core material instance from an input stream.

Parameters:
inputStream The stream to load the core material instance from. This stream should be initialized and ready to be read from.
Returns:
One of the following values:
  • a pointer to the core material
  • 0 if an error happened

CalCoreMaterialPtr CalLoader::loadCoreMaterial (  const std::string &  strFilename  )  [static]
 

Loads a core material instance.

This function loads a core material instance from a file.

Parameters:
strFilename The file to load the core material instance from.
Returns:
One of the following values:
  • a pointer to the core material
  • 0 if an error happened

CalCoreMeshPtr CalLoader::loadCoreMesh (  CalDataSource &  dataSrc  )  [static]
 

Loads a core mesh instance.

This function loads a core mesh instance from a data source.

Parameters:
dataSrc The data source to load the core mesh instance from.
Returns:
One of the following values:
  • a pointer to the core mesh
  • 0 if an error happened

CalCoreMeshPtr CalLoader::loadCoreMesh (  void *  inputBuffer  )  [static]
 

Loads a core mesh instance.

This function loads a core mesh instance from a memory buffer.

Parameters:
inputBuffer The memory buffer to load the core mesh instance from. This buffer should be initialized and ready to be read from.
Returns:
One of the following values:
  • a pointer to the core mesh
  • 0 if an error happened

CalCoreMeshPtr CalLoader::loadCoreMesh (  std::istream &  inputStream  )  [static]
 

Loads a core mesh instance.

This function loads a core mesh instance from an input stream.

Parameters:
inputStream The stream to load the core mesh instance from. This stream should be initialized and ready to be read from.
Returns:
One of the following values:
  • a pointer to the core mesh
  • 0 if an error happened

CalCoreMeshPtr CalLoader::loadCoreMesh (  const std::string &  strFilename  )  [static]
 

Loads a core mesh instance.

This function loads a core mesh instance from a file.

Parameters:
strFilename The file to load the core mesh instance from.
Returns:
One of the following values:
  • a pointer to the core mesh
  • 0 if an error happened

CalCoreSkeletonPtr CalLoader::loadCoreSkeleton (  CalDataSource &  dataSrc  )  [static]
 

Loads a core skeleton instance.

This function loads a core skeleton instance from a data source.

Parameters:
dataSrc The data source to load the core skeleton instance from.
Returns:
One of the following values:
  • a pointer to the core skeleton
  • 0 if an error happened

CalCoreSkeletonPtr CalLoader::loadCoreSkeleton (  void *  inputBuffer  )  [static]
 

Loads a core skeleton instance.

This function loads a core skeleton instance from a memory buffer.

Parameters:
inputBuffer The memory buffer to load the core skeleton instance from. This buffer should be initialized and ready to be read from.
Returns:
One of the following values:
  • a pointer to the core skeleton
  • 0 if an error happened

CalCoreSkeletonPtr CalLoader::loadCoreSkeleton (  std::istream &  inputStream  )  [static]
 

Loads a core skeleton instance.

This function loads a core skeleton instance from an input stream.

Parameters:
inputStream The stream to load the core skeleton instance from. This stream should be initialized and ready to be read from.
Returns:
One of the following values:
  • a pointer to the core skeleton
  • 0 if an error happened

CalCoreSkeletonPtr CalLoader::loadCoreSkeleton (  const std::string &  strFilename  )  [static]
 

Loads a core skeleton instance.

This function loads a core skeleton instance from a file.

Parameters:
strFilename The file to load the core skeleton instance from.
Returns:
One of the following values:
  • a pointer to the core skeleton
  • 0 if an error happened

void CalLoader::setLoadingMode (  int  flags  )  [static]
 

Sets optional flags which affect how the model is loaded into memory.

This function sets the loading mode for all future loader calls.

Parameters:
flags A boolean OR of any of the following flags
  • LOADER_ROTATE_X_AXIS will rotate the mesh 90 degrees about the X axis, which has the effect of swapping Y/Z coordinates.
  • LOADER_INVERT_V_COORD will substitute (1-v) for any v texture coordinate to eliminate the need for texture inversion after export.

The documentation for this class was generated from the following files:
Generated at Thu Jun 29 19:03:59 2006 by The Cal3D Team with Doxygen 1.4.6