<html>
<head>
<title>Cal3D: CalBufferSource Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table width="100%" border="0" cellspacing="0" cellpadding="5" align="center">
<tr>
<td class="md" align="center">
<small>
<b>- Cal3D 0.11 API Reference -</b>
</small>
</td>
</tr>
</table>
<br>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>CalBufferSource Class Reference</h1><!-- doxytag: class="CalBufferSource" --><!-- doxytag: inherits="CalDataSource" --><a class="el" href="classCalBufferSource.html" title="CalBufferSource class.">CalBufferSource</a> class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="buffersource_8h_source.html">buffersource.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for CalBufferSource:</div>
<div class="dynsection">
<p><center><img src="classCalBufferSource.png" usemap="#CalBufferSource_map" border="0" alt=""></center>
<map name="CalBufferSource_map">
<area href="classCalDataSource.html" alt="CalDataSource" shape="rect" coords="0,0,107,24">
</map>
</div>
<p>
<a href="classCalBufferSource-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalBufferSource.html#0dccf4eada180db0a0aeb7c281ed3737">CalBufferSource</a> (void *inputBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a buffer source instance from an existing memory buffer. <a href="#0dccf4eada180db0a0aeb7c281ed3737"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalBufferSource.html#7e9d2d80ebdc4625cfb31800ddd722c8">~CalBufferSource</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destruct the <a class="el" href="classCalBufferSource.html" title="CalBufferSource class.">CalBufferSource</a>. <a href="#7e9d2d80ebdc4625cfb31800ddd722c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalBufferSource.html#95f1ea057b9aa8d7c27a1bbd9055368b">ok</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the data source is in a good state. <a href="#95f1ea057b9aa8d7c27a1bbd9055368b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee2abf22b24e2f77259f8beddc1c6270"></a><!-- doxytag: member="CalBufferSource::setError" ref="ee2abf22b24e2f77259f8beddc1c6270" args="() const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalBufferSource.html#ee2abf22b24e2f77259f8beddc1c6270">setError</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the error code and message related to a memory buffer source. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalBufferSource.html#d7539bf4d2c73e07ce93b2a3be9dd170">readBytes</a> (void *pBuffer, int length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a number of bytes. <a href="#d7539bf4d2c73e07ce93b2a3be9dd170"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalBufferSource.html#742ede25513701a2ca9a8c6e284adfe7">readFloat</a> (float &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a float. <a href="#742ede25513701a2ca9a8c6e284adfe7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalBufferSource.html#9b5daecb0b42a826df3386186661d36a">readInteger</a> (int &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an integer. <a href="#9b5daecb0b42a826df3386186661d36a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalBufferSource.html#a1cab3d32910eda89632004260fff9c7">readString</a> (std::string &strValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a string. <a href="#a1cab3d32910eda89632004260fff9c7"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="159ebd5c487c1d6422695ae6ef16a49f"></a><!-- doxytag: member="CalBufferSource::mInputBuffer" ref="159ebd5c487c1d6422695ae6ef16a49f" args="" -->
void * </td><td class="memItemRight" valign="bottom"><b>mInputBuffer</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="059d697b21f5da65f244eaf63ae0428b"></a><!-- doxytag: member="CalBufferSource::mOffset" ref="059d697b21f5da65f244eaf63ae0428b" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><b>mOffset</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classCalBufferSource.html" title="CalBufferSource class.">CalBufferSource</a> class.
<p>
This is an object designed to represent a source of Cal3d data as coming from a memory buffer. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0dccf4eada180db0a0aeb7c281ed3737"></a><!-- doxytag: member="CalBufferSource::CalBufferSource" ref="0dccf4eada180db0a0aeb7c281ed3737" args="(void *inputBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalBufferSource::CalBufferSource </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>inputBuffer</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs a buffer source instance from an existing memory buffer.
<p>
This function is the only constructor of the buffer source.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>inputBuffer</em> </td><td>The input buffer to read from </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="7e9d2d80ebdc4625cfb31800ddd722c8"></a><!-- doxytag: member="CalBufferSource::~CalBufferSource" ref="7e9d2d80ebdc4625cfb31800ddd722c8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalBufferSource::~CalBufferSource </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destruct the <a class="el" href="classCalBufferSource.html" title="CalBufferSource class.">CalBufferSource</a>.
<p>
Note that the memory is not deleted here; this should be handled externally.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="95f1ea057b9aa8d7c27a1bbd9055368b"></a><!-- doxytag: member="CalBufferSource::ok" ref="95f1ea057b9aa8d7c27a1bbd9055368b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalBufferSource::ok </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether the data source is in a good state.
<p>
This function checks if the buffer is NULL or not.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if data source is in a good state </li>
<li><b>false</b> if not </li>
</ul>
</dd></dl>
<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="d7539bf4d2c73e07ce93b2a3be9dd170"></a><!-- doxytag: member="CalBufferSource::readBytes" ref="d7539bf4d2c73e07ce93b2a3be9dd170" args="(void *pBuffer, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalBufferSource::readBytes </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>pBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads a number of bytes.
<p>
This function reads a given number of bytes from this data source.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pBuffer</em> </td><td>A pointer to the buffer where the bytes are stored into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>The number of bytes that should be read.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>
<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="742ede25513701a2ca9a8c6e284adfe7"></a><!-- doxytag: member="CalBufferSource::readFloat" ref="742ede25513701a2ca9a8c6e284adfe7" args="(float &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalBufferSource::readFloat </td>
<td>(</td>
<td class="paramtype">float & </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads a float.
<p>
This function reads a float from this data source.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>A reference to the float into which the data is read.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>
<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="9b5daecb0b42a826df3386186661d36a"></a><!-- doxytag: member="CalBufferSource::readInteger" ref="9b5daecb0b42a826df3386186661d36a" args="(int &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalBufferSource::readInteger </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads an integer.
<p>
This function reads an integer from this data source.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>A reference to the integer into which the data is read.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>
<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="a1cab3d32910eda89632004260fff9c7"></a><!-- doxytag: member="CalBufferSource::readString" ref="a1cab3d32910eda89632004260fff9c7" args="(std::string &strValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalBufferSource::readString </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>strValue</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads a string.
<p>
This function reads a string from this data source.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>A reference to the string into which the data is read.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>
<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="buffersource_8h_source.html">buffersource.h</a><li>buffersource.cpp</ul>
</div>
<hr>
<center>
<small>
Generated at Fri Jul 24 21:14:57 2009 by
<a href="http://gna.org/projects/cal3d/">The Cal3D Team</a>
with
<a href="http://www.doxygen.org/index.html">
Doxygen 1.5.9
</a>
</small>
</center>
</body>
</html>
