Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2332

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: csgeom/spline.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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csgeom/spline.h</h1><a href="spline_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) 2001 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">    Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_SPLINE_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_SPLINE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00030"></a>00030 
<a name="l00035"></a><a class="code" href="classcsSpline.html">00035</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsSpline.html" title="A spline superclass.">csSpline</a>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">protected</span>:
<a name="l00038"></a><a class="code" href="classcsSpline.html#775d736667ddae9ca2abc153a2f95826">00038</a>   <span class="keywordtype">int</span> dimensions;
<a name="l00039"></a><a class="code" href="classcsSpline.html#573ef6eed257433b5a184396786bfcaa">00039</a>   <span class="keywordtype">int</span> num_points;
<a name="l00040"></a><a class="code" href="classcsSpline.html#57305af2a2b000723407ffaf319295aa">00040</a>   <span class="keywordtype">float</span>* time_points;
<a name="l00041"></a><a class="code" href="classcsSpline.html#7ddb738f21a73e3ddc8c06c975c41c9e">00041</a>   <span class="keywordtype">float</span>* points;
<a name="l00042"></a><a class="code" href="classcsSpline.html#c61b326da038f86594329459de7a040b">00042</a>   <span class="keywordtype">bool</span> precalculation_valid;
<a name="l00043"></a><a class="code" href="classcsSpline.html#0c2392979f5a265e94cd4b84ea122a77">00043</a>   <span class="keywordtype">int</span> idx;
<a name="l00044"></a>00044 
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00047"></a>00047   <a class="code" href="classcsSpline.html" title="A spline superclass.">csSpline</a> (<span class="keywordtype">int</span> d, <span class="keywordtype">int</span> p);
<a name="l00048"></a>00048 
<a name="l00050"></a>00050   <span class="keyword">virtual</span> ~<a class="code" href="classcsSpline.html" title="A spline superclass.">csSpline</a> ();
<a name="l00051"></a>00051 
<a name="l00053"></a><a class="code" href="classcsSpline.html#45b7d6ec241747b518803e7b6bad4c6c">00053</a>   <span class="keywordtype">int</span> GetDimensionCount ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> dimensions; }
<a name="l00054"></a>00054 
<a name="l00056"></a><a class="code" href="classcsSpline.html#6a642c306e80c4ec90913e496bf2eb0a">00056</a>   <span class="keywordtype">int</span> GetPointCount ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> num_points; }
<a name="l00057"></a>00057 
<a name="l00062"></a>00062   <span class="keywordtype">void</span> InsertPoint (<span class="keywordtype">int</span> idx);
<a name="l00063"></a>00063 
<a name="l00067"></a>00067   <span class="keywordtype">void</span> RemovePoint (<span class="keywordtype">int</span> idx);
<a name="l00068"></a>00068 
<a name="l00075"></a>00075   <span class="keywordtype">void</span> SetTimeValues (<span class="keywordtype">float</span> <span class="keyword">const</span>* t);
<a name="l00076"></a>00076 
<a name="l00080"></a>00080   <span class="keywordtype">void</span> SetTimeValue (<span class="keywordtype">int</span> idx, <span class="keywordtype">float</span> t);
<a name="l00081"></a>00081 
<a name="l00085"></a><a class="code" href="classcsSpline.html#4e9e2f40e6bff254fc28b3da3467b2d4">00085</a>   <span class="keywordtype">float</span> <span class="keyword">const</span>* GetTimeValues ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> time_points; }
<a name="l00086"></a>00086 
<a name="l00090"></a><a class="code" href="classcsSpline.html#5e8a8ba6de39ed175f443dbfaa6216ba">00090</a>   <span class="keywordtype">float</span> GetTimeValue (<span class="keywordtype">int</span> idx)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> GetTimeValues ()[idx]; }
<a name="l00091"></a>00091 
<a name="l00098"></a>00098   <span class="keywordtype">void</span> SetDimensionValues (<span class="keywordtype">int</span> dim, <span class="keywordtype">float</span> <span class="keyword">const</span>* d);
<a name="l00099"></a>00099 
<a name="l00103"></a>00103   <span class="keywordtype">void</span> SetDimensionValue (<span class="keywordtype">int</span> dim, <span class="keywordtype">int</span> idx, <span class="keywordtype">float</span> d);
<a name="l00104"></a>00104 
<a name="l00108"></a><a class="code" href="classcsSpline.html#3294b91acd576fbd4d547b3d20b35016">00108</a>   <span class="keywordtype">float</span> <span class="keyword">const</span>* GetDimensionValues (<span class="keywordtype">int</span> dim)<span class="keyword"> const</span>
<a name="l00109"></a>00109 <span class="keyword">  </span>{ <span class="keywordflow">return</span> &amp;points[dim*num_points]; }
<a name="l00110"></a>00110 
<a name="l00114"></a><a class="code" href="classcsSpline.html#cb73fa524b6544119c57f93c521ca36c">00114</a>   <span class="keywordtype">float</span> GetDimensionValue (<span class="keywordtype">int</span> dim, <span class="keywordtype">int</span> idx)<span class="keyword"> const</span>
<a name="l00115"></a>00115 <span class="keyword">  </span>{
<a name="l00116"></a>00116     <span class="keywordtype">float</span> <span class="keyword">const</span>* d = &amp;points[dim*num_points];
<a name="l00117"></a>00117     <span class="keywordflow">return</span> d[idx];
<a name="l00118"></a>00118   }
<a name="l00119"></a>00119 
<a name="l00123"></a>00123   <span class="keywordtype">void</span> SetIndexValues (<span class="keywordtype">int</span> idx, <span class="keywordtype">float</span> <span class="keyword">const</span>* d);
<a name="l00124"></a>00124   
<a name="l00129"></a>00129   <span class="keywordtype">float</span>* GetIndexValues (<span class="keywordtype">int</span> idx) <span class="keyword">const</span>;
<a name="l00130"></a>00130   
<a name="l00134"></a>00134   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Calculate (<span class="keywordtype">float</span> time) = 0;
<a name="l00135"></a>00135 
<a name="l00139"></a><a class="code" href="classcsSpline.html#efc81ce3d83f4f0a8b07d48794313cc3">00139</a>   <span class="keywordtype">int</span> GetCurrentIndex ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> idx; }
<a name="l00140"></a>00140 
<a name="l00145"></a>00145   <span class="keyword">virtual</span> <span class="keywordtype">float</span> GetInterpolatedDimension (<span class="keywordtype">int</span> dim) <span class="keyword">const</span> = 0;
<a name="l00146"></a>00146 };
<a name="l00147"></a>00147 
<a name="l00151"></a><a class="code" href="classcsCubicSpline.html">00151</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsCubicSpline.html" title="A cubic spline.">csCubicSpline</a> : <span class="keyword">public</span> <a class="code" href="classcsSpline.html" title="A spline superclass.">csSpline</a>
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 <span class="keyword">private</span>:
<a name="l00154"></a>00154   <span class="keywordtype">bool</span> derivatives_valid;
<a name="l00155"></a>00155   <span class="keywordtype">float</span>* derivative_points;
<a name="l00156"></a>00156 
<a name="l00157"></a>00157   <span class="comment">// The following values are calculated by Calculate() and</span>
<a name="l00158"></a>00158   <span class="comment">// are used later by GetInterpolatedDimension().</span>
<a name="l00159"></a>00159   <span class="keywordtype">float</span> A, B, C, D;     <span class="comment">// For computation of a spline value.</span>
<a name="l00160"></a>00160 
<a name="l00161"></a>00161 <span class="keyword">private</span>:
<a name="l00162"></a>00162   <span class="keywordtype">void</span> PrecalculateDerivatives (<span class="keywordtype">int</span> dim);
<a name="l00163"></a>00163   <span class="keywordtype">void</span> PrecalculateDerivatives ();
<a name="l00164"></a>00164 
<a name="l00165"></a>00165 <span class="keyword">public</span>:
<a name="l00167"></a>00167   <a class="code" href="classcsCubicSpline.html" title="A cubic spline.">csCubicSpline</a> (<span class="keywordtype">int</span> d, <span class="keywordtype">int</span> p);
<a name="l00168"></a>00168 
<a name="l00170"></a>00170   <span class="keyword">virtual</span> ~<a class="code" href="classcsCubicSpline.html" title="A cubic spline.">csCubicSpline</a> ();
<a name="l00171"></a>00171 
<a name="l00175"></a>00175   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsSpline.html#94e783a955af2d3cd6847bbc6ace4799" title="Calculate internal values for this spline given some time value.">Calculate</a> (<span class="keywordtype">float</span> time);
<a name="l00176"></a>00176 
<a name="l00181"></a>00181   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classcsSpline.html#b1b888d24b71e524524920102128012c" title="After calling Calculate() you can use this to fetch the value of some dimension.">GetInterpolatedDimension</a> (<span class="keywordtype">int</span> dim) <span class="keyword">const</span>;
<a name="l00182"></a>00182 };
<a name="l00183"></a>00183 
<a name="l00187"></a><a class="code" href="classcsBSpline.html">00187</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsBSpline.html" title="A B-spline.">csBSpline</a> : <span class="keyword">public</span> <a class="code" href="classcsSpline.html" title="A spline superclass.">csSpline</a>
<a name="l00188"></a>00188 {
<a name="l00189"></a>00189 <span class="keyword">private</span>:
<a name="l00190"></a>00190   <span class="comment">// The following values are calculated by Calculate() and</span>
<a name="l00191"></a>00191   <span class="comment">// are used later by GetInterpolatedDimension().</span>
<a name="l00192"></a>00192   <span class="keywordtype">float</span> t;
<a name="l00193"></a>00193 
<a name="l00194"></a>00194 <span class="keyword">protected</span>:
<a name="l00196"></a>00196   <span class="keyword">virtual</span> <span class="keywordtype">float</span> BaseFunction (<span class="keywordtype">int</span> i, <span class="keywordtype">float</span> t) <span class="keyword">const</span>;
<a name="l00197"></a>00197 
<a name="l00198"></a>00198 <span class="keyword">public</span>:
<a name="l00200"></a>00200   <a class="code" href="classcsBSpline.html" title="A B-spline.">csBSpline</a> (<span class="keywordtype">int</span> d, <span class="keywordtype">int</span> p);
<a name="l00201"></a>00201 
<a name="l00203"></a>00203   <span class="keyword">virtual</span> ~<a class="code" href="classcsBSpline.html" title="A B-spline.">csBSpline</a> ();
<a name="l00204"></a>00204 
<a name="l00208"></a>00208   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsSpline.html#94e783a955af2d3cd6847bbc6ace4799" title="Calculate internal values for this spline given some time value.">Calculate</a> (<span class="keywordtype">float</span> time);
<a name="l00209"></a>00209 
<a name="l00214"></a>00214   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classcsSpline.html#b1b888d24b71e524524920102128012c" title="After calling Calculate() you can use this to fetch the value of some dimension.">GetInterpolatedDimension</a> (<span class="keywordtype">int</span> dim) <span class="keyword">const</span>;
<a name="l00215"></a>00215 };
<a name="l00216"></a>00216 
<a name="l00220"></a><a class="code" href="classcsCatmullRomSpline.html">00220</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsCatmullRomSpline.html" title="A CatmullRom spline.">csCatmullRomSpline</a> : <span class="keyword">public</span> <a class="code" href="classcsBSpline.html" title="A B-spline.">csBSpline</a>
<a name="l00221"></a>00221 {
<a name="l00222"></a>00222 <span class="keyword">protected</span>:
<a name="l00224"></a>00224   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classcsBSpline.html#f96af08caf0e0844a01bfa1fb2f31a44" title="Base function for a cubic B-spline (i=-2..1).">BaseFunction</a> (<span class="keywordtype">int</span> i, <span class="keywordtype">float</span> t) <span class="keyword">const</span>;
<a name="l00225"></a>00225 
<a name="l00226"></a>00226 <span class="keyword">public</span>:
<a name="l00228"></a><a class="code" href="classcsCatmullRomSpline.html#057186ea1728cc483eca68c92abbdea9">00228</a>   <a class="code" href="classcsCatmullRomSpline.html" title="A CatmullRom spline.">csCatmullRomSpline</a> (<span class="keywordtype">int</span> d, <span class="keywordtype">int</span> p) : <a class="code" href="classcsBSpline.html" title="A B-spline.">csBSpline</a> (d, p) { }
<a name="l00229"></a>00229 
<a name="l00231"></a><a class="code" href="classcsCatmullRomSpline.html#8c4ec50cc95d688174099ed1388cbb0f">00231</a>   <span class="keyword">virtual</span> ~<a class="code" href="classcsCatmullRomSpline.html" title="A CatmullRom spline.">csCatmullRomSpline</a> () {}
<a name="l00232"></a>00232 
<a name="l00234"></a>00234   <a class="code" href="classcsCatmullRomSpline.html" title="A CatmullRom spline.">csCatmullRomSpline</a> * Clone();
<a name="l00235"></a>00235 };
<a name="l00236"></a>00236 
<a name="l00239"></a>00239 <span class="preprocessor">#endif // __CS_SPLINE_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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional