- Cal3D 0.9 API Reference -

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   Related Pages  

CalBufferSource Class Reference

CalBufferSource class. More...

#include <buffersource.h>

Inheritance diagram for CalBufferSource:

CalDataSource List of all members.

Public Methods

 CalBufferSource (void *inputBuffer)
 Constructs a buffer source instance from an existing memory buffer. More...

virtual ~CalBufferSource ()
 Destruct the CalBufferSource. More...

virtual bool ok () const
 Checks whether the data source is in a good state. More...

virtual void setError () const
 Sets the error code and message related to a memory buffer source.

virtual bool readBytes (void *pBuffer, int length)
 Reads a number of bytes. More...

virtual bool readFloat (float &value)
 Reads a float. More...

virtual bool readInteger (int &value)
 Reads an integer. More...

virtual bool readString (std::string &strValue)
 Reads a string. More...


Protected Attributes

void * mInputBuffer
unsigned int mOffset

Detailed Description

CalBufferSource class.

This is an object designed to represent a source of Cal3d data as coming from a memory buffer.

Constructor & Destructor Documentation

CalBufferSource::CalBufferSource (  void *    inputBuffer ) 
 

Constructs a buffer source instance from an existing memory buffer.

This function is the only constructor of the buffer source.

Parameters:
inputBuffer  The input buffer to read from

CalBufferSource::~CalBufferSource (    )  [virtual]
 

Destruct the CalBufferSource.

Note that the memory is not deleted here; this should be handled externally.

Member Function Documentation

bool CalBufferSource::ok (    )  const [virtual]
 

Checks whether the data source is in a good state.

This function checks if the buffer is NULL or not.

Returns:
One of the following values:
  • true if data source is in a good state
  • false if not

Implements CalDataSource.

bool CalBufferSource::readBytes (  void *    pBuffer,
int    length
)  [virtual]
 

Reads a number of bytes.

This function reads a given number of bytes from this data source.

Parameters:
pBuffer  A pointer to the buffer where the bytes are stored into.
length  The number of bytes that should be read.
Returns:
One of the following values:
  • true if successful
  • false if an error happend

Implements CalDataSource.

bool CalBufferSource::readFloat (  float &    value )  [virtual]
 

Reads a float.

This function reads a float from this data source.

Parameters:
value  A reference to the float into which the data is read.
Returns:
One of the following values:
  • true if successful
  • false if an error happend

Implements CalDataSource.

bool CalBufferSource::readInteger (  int &    value )  [virtual]
 

Reads an integer.

This function reads an integer from this data source.

Parameters:
value  A reference to the integer into which the data is read.
Returns:
One of the following values:
  • true if successful
  • false if an error happend

Implements CalDataSource.

bool CalBufferSource::readString (  std::string &    strValue )  [virtual]
 

Reads a string.

This function reads a string from this data source.

Parameters:
value  A reference to the string into which the data is read.
Returns:
One of the following values:
  • true if successful
  • false if an error happend

Implements CalDataSource.

The documentation for this class was generated from the following files:
Generated at Sun Oct 12 18:38:48 2003 by The Cal3D Team with doxygen 1.2.14 © 1997-2001 Dimitri van Heesch