<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: cstool/framedataholder.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<h1>cstool/framedataholder.h</h1><a href="framedataholder_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2004 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment"> (C) 2004 by Frank Richter</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_CSTOOL_FRAMEDATAHOLDER_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSTOOL_FRAMEDATAHOLDER_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="math_8h.html" title="Generic mathematic utility functions.">csgeom/math.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00030"></a>00030
<a name="l00037"></a>00037 <span class="keyword">template</span> <<span class="keyword">class</span> T>
<a name="l00038"></a><a class="code" href="classcsFrameDataHolder.html">00038</a> <span class="keyword">class </span><a class="code" href="classcsFrameDataHolder.html" title="Helper template to retrieve an instance of some type that has not yet been used in...">csFrameDataHolder</a>
<a name="l00039"></a>00039 {
<a name="l00041"></a>00041 <span class="keyword">struct </span>FrameData
<a name="l00042"></a>00042 {
<a name="l00044"></a>00044 <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> lastFrame;
<a name="l00046"></a>00046 T data;
<a name="l00047"></a>00047 };
<a name="l00049"></a>00049 <a class="code" href="classcsArray.html" title="A templated array class.">csArray<FrameData></a> data;
<a name="l00051"></a>00051 <span class="keywordtype">size_t</span> lastData;
<a name="l00053"></a>00053 <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> nextShrink;
<a name="l00055"></a>00055 <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> lastFrame;
<a name="l00057"></a>00057 <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> clearReq;
<a name="l00058"></a>00058
<a name="l00060"></a>00060 <span class="keywordtype">void</span> NewFrame()
<a name="l00061"></a>00061 {
<a name="l00062"></a>00062 <span class="keywordflow">if</span> (clearReq != (<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a>)~0)
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064 data.<a class="code" href="classcsArray.html#2b5ebb745f73aefdbbe3210853b648bc" title="Clear entire array, releasing all allocated memory.">DeleteAll</a>();
<a name="l00065"></a>00065 clearReq = (<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a>)~0;
<a name="l00066"></a>00066 }
<a name="l00067"></a>00067 <span class="comment">// Try to shrink the cache to a size that reflects what's needed</span>
<a name="l00068"></a>00068 <span class="keywordflow">if</span> (lastFrame > nextShrink)
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 <span class="comment">/* lastData is reset every frame, so it gives a good indicator</span>
<a name="l00071"></a>00071 <span class="comment"> * on how much has been used the last frame */</span>
<a name="l00072"></a>00072 data.<a class="code" href="classcsArray.html#510c6484ddc358bc86919aecee24724b" title="Truncate array to specified number of elements.">Truncate</a> (<a class="code" href="group__geom__utils.html#g16a5d316a30efbd72510b608e3233ea1" title="Returns smaller of a and b.">csMin</a>(lastData+1, data.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a> ()));
<a name="l00073"></a>00073 data.<a class="code" href="classcsArray.html#d4ba5bb3e96e26c2c6623c0d1d94b411" title="Make the array just as big as it needs to be.">ShrinkBestFit</a> ();
<a name="l00074"></a>00074 nextShrink = (<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a>)~0;
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (lastData+1 < data.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a>())
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 <span class="comment">// Last frame we used less cache than available.</span>
<a name="l00079"></a>00079 <span class="comment">// "Schedule" a shrink in the future.</span>
<a name="l00080"></a>00080 nextShrink = lastFrame + 5;
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082 lastData = 0;
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084 <span class="keyword">public</span>:
<a name="l00085"></a><a class="code" href="classcsFrameDataHolder.html#a8ebb2a597a704a121b8b25e01393990">00085</a> <a class="code" href="classcsFrameDataHolder.html#a8ebb2a597a704a121b8b25e01393990">csFrameDataHolder</a> () : lastData(0), nextShrink((<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a>)~0),
<a name="l00086"></a>00086 lastFrame((<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a>)~0), clearReq((<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a>)~0)
<a name="l00087"></a>00087 { }
<a name="l00088"></a><a class="code" href="classcsFrameDataHolder.html#8428ad67f33a0efa18cc6ac80b489241">00088</a> <a class="code" href="classcsFrameDataHolder.html#8428ad67f33a0efa18cc6ac80b489241">~csFrameDataHolder</a> () { }
<a name="l00089"></a>00089
<a name="l00097"></a><a class="code" href="classcsFrameDataHolder.html#7abe3b6e519c553caf54140ee3f39ce7">00097</a> T& <a class="code" href="classcsFrameDataHolder.html#7abe3b6e519c553caf54140ee3f39ce7" title="Retrieve an instance of the type T whose associated frame number differs from frameNumber...">GetUnusedData</a> (<span class="keywordtype">bool</span>& created, <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> frameNumber)
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <span class="keywordflow">if</span> (lastFrame != frameNumber)
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 NewFrame();
<a name="l00102"></a>00102 lastFrame = frameNumber;
<a name="l00103"></a>00103 }
<a name="l00104"></a>00104 created = <span class="keyword">false</span>;
<a name="l00105"></a>00105 <span class="keywordflow">if</span> ((data.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a>() == 0) || (data[lastData].lastFrame == frameNumber))
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 <span class="keywordtype">size_t</span> startPoint = lastData;
<a name="l00108"></a>00108 <span class="comment">//check the list</span>
<a name="l00109"></a>00109 <span class="keywordflow">if</span> (data.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a>() > 0)
<a name="l00110"></a>00110 {
<a name="l00111"></a>00111 <span class="keywordflow">do</span>
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113 <span class="keywordflow">if</span> (data[lastData].lastFrame != frameNumber)
<a name="l00114"></a>00114 <span class="keywordflow">break</span>;
<a name="l00115"></a>00115 lastData++;
<a name="l00116"></a>00116 <span class="keywordflow">if</span> (lastData >= data.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a>()) lastData = 0;
<a name="l00117"></a>00117 }
<a name="l00118"></a>00118 <span class="keywordflow">while</span> (lastData != startPoint);
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120 <span class="keywordflow">if</span> (lastData == startPoint)
<a name="l00121"></a>00121 {
<a name="l00122"></a>00122 data.<a class="code" href="classcsArray.html#3f69105af97a9482396260e379a45f37" title="Set the actual number of items in this array.">SetSize</a> ((lastData = data.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a> ()) + 1);
<a name="l00123"></a>00123 created = <span class="keyword">true</span>;
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 FrameData& frameData = data[lastData];
<a name="l00128"></a>00128 frameData.lastFrame = frameNumber;
<a name="l00129"></a>00129 <span class="keywordflow">return</span> frameData.data;
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131
<a name="l00141"></a><a class="code" href="classcsFrameDataHolder.html#52141cd05ceb5766c2921eb65097393c">00141</a> <span class="keywordtype">void</span> <a class="code" href="classcsFrameDataHolder.html#52141cd05ceb5766c2921eb65097393c" title="Remove all allocated instances.">Clear</a> (<span class="keywordtype">bool</span> instaClear = <span class="keyword">false</span>)
<a name="l00142"></a>00142 {
<a name="l00143"></a>00143 <span class="keywordflow">if</span> (instaClear)
<a name="l00144"></a>00144 data.<a class="code" href="classcsArray.html#2b5ebb745f73aefdbbe3210853b648bc" title="Clear entire array, releasing all allocated memory.">DeleteAll</a>();
<a name="l00145"></a>00145 <span class="keywordflow">else</span>
<a name="l00146"></a>00146 <span class="comment">// Don't clear just yet, rather, clear when we enter the next frame.</span>
<a name="l00147"></a>00147 clearReq = lastFrame;
<a name="l00148"></a>00148 }
<a name="l00149"></a>00149 };
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="preprocessor">#endif // __CS_CSTOOL_FRAMEDATAHOLDER_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
1550
