1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleSpaceFillingCurves: Class TSpaceFillingCurve</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TSpaceFillingCurve"></a><h1 class="cio">Class TSpaceFillingCurve</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="CastleSpaceFillingCurves.html">CastleSpaceFillingCurves</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TSpaceFillingCurve = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
Base abstract space-filling curve class.
<p>Generates consecutive points by <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#NextPixel">NextPixel</a>, until <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#EndOfPixels">EndOfPixels</a> = <code>True</code>, filling the 2D space in [0..SizeX-1, 0..SizeY-1]. To process (exactly once) each point of your 2D space, you can use something like
<p></p>
<pre class="longcode"> <span class="pascal_keyword">while</span> <span class="pascal_keyword">not</span> SFCurve.EndOfPixels <span class="pascal_keyword">do</span> DoSomethingOnPixel(SFCurve.NextPixel); </pre>
<p>
<p>We try to make <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#NextPixel">NextPixel</a> and <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#EndOfPixels">EndOfPixels</a> work instantly fast, preferably making some preprocessing at construction time.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TSpaceFillingCurve</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#Create">Create</a></b>(ASizeX, ASizeY: Cardinal); virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#EndOfPixels">EndOfPixels</a></b>: boolean; virtual; abstract;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#NextPixel">NextPixel</a></b>: <a href="CastleVectors.html#TVector2Cardinal">TVector2Cardinal</a>; virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#SkipPixels">SkipPixels</a></b>(SkipCount: Cardinal); virtual; abstract;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#Reset">Reset</a></b>; virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#PixelsDone">PixelsDone</a></b>: Cardinal; virtual; abstract;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#SFCName">SFCName</a></b>: string; virtual; abstract;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#SizeX">SizeX</a></b>: Cardinal read FSizeX;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#SizeY">SizeY</a></b>: Cardinal read FSizeY;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#PixelsCount">PixelsCount</a></b>: Cardinal read FPixelsCount;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(ASizeX, ASizeY: Cardinal); virtual;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="EndOfPixels"></a><code>function <b>EndOfPixels</b>: boolean; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="NextPixel"></a><code>function <b>NextPixel</b>: <a href="CastleVectors.html#TVector2Cardinal">TVector2Cardinal</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Get next point. Do not ever call this when <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#EndOfPixels">EndOfPixels</a> = <code>True</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="SkipPixels"></a><code>procedure <b>SkipPixels</b>(SkipCount: Cardinal); virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Skip next SkipCount curve points. Just like you would call <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#NextPixel">NextPixel</a> SkipCount times, ignoring the result. Although may be implemented much faster, so don't worry about calling with large SkipCount values.
<p>Do not ever try to skip beyond the end of points. That is, do not use <code>SkipCount > <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#PixelsCount">PixelsCount</a> - <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#PixelsDone">PixelsDone</a></code>. For example, do not use SkipCount > 0 if currently <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#EndOfPixels">EndOfPixels</a> - <code>True</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Reset"></a><code>procedure <b>Reset</b>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Start generating points back from the beginning.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="PixelsDone"></a><code>function <b>PixelsDone</b>: Cardinal; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
How many curve points were generated. Number of generated points (by <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#NextPixel">NextPixel</a> or skipped by <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#SkipPixels">SkipPixels</a>), since the last <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#Reset">Reset</a> or constructor.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="SFCName"></a><code>class function <b>SFCName</b>: string; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Nice curve name, like 'swapscan', 'hilbert' or 'peano'.</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="SizeX"></a><code>property <b>SizeX</b>: Cardinal read FSizeX;</code></td>
</tr>
<tr><td colspan="2">
<p>
Size of the 2D space filled by space-filling curve. It's OK even if they are 0 (then <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#EndOfPixels">EndOfPixels</a> = <code>True</code> instantly). </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="SizeY"></a><code>property <b>SizeY</b>: Cardinal read FSizeY;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="PixelsCount"></a><code>property <b>PixelsCount</b>: Cardinal read FPixelsCount;</code></td>
</tr>
<tr><td colspan="2">
<p>
Shortcut for <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#SizeX">SizeX</a> * <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#SizeY">SizeY</a>.</p>
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:12</em>
</span>
</td></tr></table></body></html>
|