Mahtan/wagic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
wagic/JGE/docs/html/class_j_spline.html
wagic.the.homebrew d45e3b101b
2008-11-02 09:50:16 +00:00

373 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>JGE++: JSpline Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>JSpline Class Reference</h1><!-- doxytag: class="JSpline" --><code>#include &lt;JSpline.h&gt;</code>
<p>
<p>
<a href="class_j_spline-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_spline.html#d84387c488970a4f8341214d15b63e3e">JSpline</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_spline.html#5eb089829d7d16c9d649b2235d5fbb4f">Load</a> (const char *filename, float xscale=1.0f, float yscale=1.0f)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_spline.html#3ab9a70b69163265521ca2d27b81163c">AddControlPoint</a> (const <a class="el" href="class_point.html">Point</a> &amp;pt)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_spline.html#43193538f34114329b061951ccdf1576">GetControlPoint</a> (<a class="el" href="class_point.html">Point</a> &amp;point, int index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_spline.html#86a4b5d5c0526ad2c848fd9ff059b3ef">GeneratePixels</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_spline.html#ad3ffd8c832afe9a9dcd75b9ebcf36ab">PointOnCurve</a> (<a class="el" href="class_point.html">Point</a> &amp;out, float t, const <a class="el" href="class_point.html">Point</a> &amp;p0, const <a class="el" href="class_point.html">Point</a> &amp;p1, const <a class="el" href="class_point.html">Point</a> &amp;p2, const <a class="el" href="class_point.html">Point</a> &amp;p3)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_spline.html#d2524b5535ba554ff9863cac5081d312">GetPixelCount</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_spline.html#fc83fe27b83afc1189865db4ae72c57f">GetPixel</a> (<a class="el" href="class_point.html">Point</a> &amp;point, int index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_spline.html#e52f4f21e5be8afdea4bcbfdb55ffd66">Render</a> (float x, float y, PIXEL_TYPE color=ARGB(255, 255, 255, 255), PIXEL_TYPE controlColor=ARGB(192, 0, 192, 0))</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Catmull Rom spline. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="d84387c488970a4f8341214d15b63e3e"></a><!-- doxytag: member="JSpline::JSpline" ref="d84387c488970a4f8341214d15b63e3e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JSpline::JSpline </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5eb089829d7d16c9d649b2235d5fbb4f"></a><!-- doxytag: member="JSpline::Load" ref="5eb089829d7d16c9d649b2235d5fbb4f" args="(const char *filename, float xscale=1.0f, float yscale=1.0f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool JSpline::Load </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>xscale</em> = <code>1.0f</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>yscale</em> = <code>1.0f</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load spline from a file.<p>
Here is a sample spline definition file:<p>
<div class="fragment"><pre class="fragment"> &lt;?xml version=<span class="stringliteral">"1.0"</span> standalone=<span class="stringliteral">"no"</span> ?&gt;
&lt;path&gt;
&lt;contro_point x=<span class="stringliteral">"89"</span> y=<span class="stringliteral">"270"</span> /&gt;
&lt;contro_point x=<span class="stringliteral">"113"</span> y=<span class="stringliteral">"154"</span> /&gt;
&lt;contro_point x=<span class="stringliteral">"227"</span> y=<span class="stringliteral">"94"</span> /&gt;
&lt;contro_point x=<span class="stringliteral">"347"</span> y=<span class="stringliteral">"154"</span> /&gt;
&lt;contro_point x=<span class="stringliteral">"367"</span> y=<span class="stringliteral">"278"</span> /&gt;
&lt;/path&gt;
</pre></div><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>filename</em>&nbsp;</td><td>- Name of spline definition file. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>xscale</em>&nbsp;</td><td>- Scaling factor for X of all control points. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>yscale</em>&nbsp;</td><td>- Scaling factor for Y of all control points.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if loaded. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3ab9a70b69163265521ca2d27b81163c"></a><!-- doxytag: member="JSpline::AddControlPoint" ref="3ab9a70b69163265521ca2d27b81163c" args="(const Point &amp;pt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JSpline::AddControlPoint </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_point.html">Point</a> &amp;&nbsp;</td>
<td class="paramname"> <em>pt</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a control point to the spline.<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>pt</em>&nbsp;</td><td>- Control point. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="43193538f34114329b061951ccdf1576"></a><!-- doxytag: member="JSpline::GetControlPoint" ref="43193538f34114329b061951ccdf1576" args="(Point &amp;point, int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JSpline::GetControlPoint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_point.html">Point</a> &amp;&nbsp;</td>
<td class="paramname"> <em>point</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>index</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a control point of the spline.<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>index</em>&nbsp;</td><td>- Control point index.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Control point. </dd></dl>
</div>
</div><p>
<a class="anchor" name="86a4b5d5c0526ad2c848fd9ff059b3ef"></a><!-- doxytag: member="JSpline::GeneratePixels" ref="86a4b5d5c0526ad2c848fd9ff059b3ef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JSpline::GeneratePixels </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Work out all pixels of the spline.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Have to call this function before calling GetPixel, GetPixelCount and Render. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ad3ffd8c832afe9a9dcd75b9ebcf36ab"></a><!-- doxytag: member="JSpline::PointOnCurve" ref="ad3ffd8c832afe9a9dcd75b9ebcf36ab" args="(Point &amp;out, float t, const Point &amp;p0, const Point &amp;p1, const Point &amp;p2, const Point &amp;p3)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JSpline::PointOnCurve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_point.html">Point</a> &amp;&nbsp;</td>
<td class="paramname"> <em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_point.html">Point</a> &amp;&nbsp;</td>
<td class="paramname"> <em>p0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_point.html">Point</a> &amp;&nbsp;</td>
<td class="paramname"> <em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_point.html">Point</a> &amp;&nbsp;</td>
<td class="paramname"> <em>p2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_point.html">Point</a> &amp;&nbsp;</td>
<td class="paramname"> <em>p3</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a point between 2nd and 3rd control point.<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>t</em>&nbsp;</td><td>- Fraction of the curve between 2nd and 3rd control point. (0.0f ~ 1.0f) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p0</em>&nbsp;</td><td>- 1st control point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p1</em>&nbsp;</td><td>- 2nd control point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p2</em>&nbsp;</td><td>- 3rd control point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p3</em>&nbsp;</td><td>- 4th control point.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Position of the desire point. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d2524b5535ba554ff9863cac5081d312"></a><!-- doxytag: member="JSpline::GetPixelCount" ref="d2524b5535ba554ff9863cac5081d312" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int JSpline::GetPixelCount </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a number of pixels for this spline.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of pixels for this spline. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fc83fe27b83afc1189865db4ae72c57f"></a><!-- doxytag: member="JSpline::GetPixel" ref="fc83fe27b83afc1189865db4ae72c57f" args="(Point &amp;point, int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JSpline::GetPixel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_point.html">Point</a> &amp;&nbsp;</td>
<td class="paramname"> <em>point</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>index</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pixel on the spline.<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>index</em>&nbsp;</td><td>- Pixel index.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Position of the desire point. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e52f4f21e5be8afdea4bcbfdb55ffd66"></a><!-- doxytag: member="JSpline::Render" ref="e52f4f21e5be8afdea4bcbfdb55ffd66" args="(float x, float y, PIXEL_TYPE color=ARGB(255, 255, 255, 255), PIXEL_TYPE controlColor=ARGB(192, 0, 192, 0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JSpline::Render </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PIXEL_TYPE&nbsp;</td>
<td class="paramname"> <em>color</em> = <code>ARGB(255,&nbsp;255,&nbsp;255,&nbsp;255)</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PIXEL_TYPE&nbsp;</td>
<td class="paramname"> <em>controlColor</em> = <code>ARGB(192,&nbsp;0,&nbsp;192,&nbsp;0)</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Render the spline to screen.
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 22 00:28:23 2007 for JGE++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink