File: CastleSpaceFillingCurves.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (204 lines) | stat: -rw-r--r-- 12,598 bytes parent folder | download
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
<!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</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">
<h1 class="unit">Unit CastleSpaceFillingCurves</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Uses">Uses</a></td><td><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></td><td><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></td><td><a class="section" href="#PasDoc-Types">Types</a></td><td><a class="section" href="#PasDoc-Constants">Constants</a></td><td>Variables</td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Generate space-filling curves (<a class="normal" href="CastleSpaceFillingCurves.TSwapScanCurve.html">TSwapScanCurve</a>, <a class="normal" href="CastleSpaceFillingCurves.THilbertCurve.html">THilbertCurve</a>, <a class="normal" href="CastleSpaceFillingCurves.TPeanoCurve.html">TPeanoCurve</a>). These are sequences of points that completely fill some 2D space.</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>SysUtils</li><li><a  href="CastleVectors.html">CastleVectors</a></li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Classes"></a><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
<table class="classestable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html"><code>TSpaceFillingCurve</code></a></td>
<td class="itemdesc">Base abstract space-filling curve class.</td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleSpaceFillingCurves.TPrecalcCurve.html"><code>TPrecalcCurve</code></a></td>
<td class="itemdesc">Abstract space-filling curve class, helping implementing curves that precalculate points at construction.</td>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleSpaceFillingCurves.TSwapScanCurve.html"><code>TSwapScanCurve</code></a></td>
<td class="itemdesc">Simple space-filling curve that goes row by row, swapping direction.</td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleSpaceFillingCurves.THilbertCurve.html"><code>THilbertCurve</code></a></td>
<td class="itemdesc">Space-filling Hilbert curve.</td>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleSpaceFillingCurves.TPeanoCurve.html"><code>TPeanoCurve</code></a></td>
<td class="itemdesc">Space-filling Peano curve.</td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleSpaceFillingCurves.EInvalidSFCurveClassName.html"><code>EInvalidSFCurveClassName</code></a></td>
<td class="itemdesc">&nbsp;</td>
</tr>
</table>
<a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>procedure <b><a  href="CastleSpaceFillingCurves.html#PeanoCurve">PeanoCurve</a></b>(InitialOrient: boolean; Angle: <a  href="CastleSpaceFillingCurves.html#TSFCAngle">TSFCAngle</a>; InitialLevel: Cardinal; Step: <a  href="CastleSpaceFillingCurves.html#TSFCStepFunction">TSFCStepFunction</a>; StepData: Pointer);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a  href="CastleSpaceFillingCurves.html#HilbertCurve">HilbertCurve</a></b>(InitialOrient: boolean; Angle: <a  href="CastleSpaceFillingCurves.html#TSFCAngle">TSFCAngle</a>; InitialLevel: Cardinal; Step: <a  href="CastleSpaceFillingCurves.html#TSFCStepFunction">TSFCStepFunction</a>; StepData: Pointer);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a  href="CastleSpaceFillingCurves.html#StrToSFCurveClass">StrToSFCurveClass</a></b>(const s: string): <a  href="CastleSpaceFillingCurves.html#TSpaceFillingCurveClass">TSpaceFillingCurveClass</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a  href="CastleSpaceFillingCurves.html#AllSFCurveClassesNames">AllSFCurveClassesNames</a></b>: string;</code></td>
</tr>
</table>
<a name="PasDoc-Types"></a><h3 class="summary">Types</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a  href="CastleSpaceFillingCurves.html#TSFCAngle">TSFCAngle</a></b> = 0..3;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a  href="CastleSpaceFillingCurves.html#TSFCStepFunction">TSFCStepFunction</a></b> = procedure (Angle: <a  href="CastleSpaceFillingCurves.html#TSFCAngle">TSFCAngle</a>; StepFuncData: Pointer);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a  href="CastleSpaceFillingCurves.html#TSpaceFillingCurveClass">TSpaceFillingCurveClass</a></b> = class of <a  href="CastleSpaceFillingCurves.TSpaceFillingCurve.html">TSpaceFillingCurve</a>;</code></td>
</tr>
</table>
<a name="PasDoc-Constants"></a><h3 class="summary">Constants</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a  href="CastleSpaceFillingCurves.html#AvailableSFCurveClasses">AvailableSFCurveClasses</a></b>: array[0..2]of <a  href="CastleSpaceFillingCurves.html#TSpaceFillingCurveClass">TSpaceFillingCurveClass</a>=
  (<a  href="CastleSpaceFillingCurves.TSwapScanCurve.html">TSwapScanCurve</a>, <a  href="CastleSpaceFillingCurves.THilbertCurve.html">THilbertCurve</a>, <a  href="CastleSpaceFillingCurves.TPeanoCurve.html">TPeanoCurve</a>);</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="PeanoCurve"></a><code>procedure <b>PeanoCurve</b>(InitialOrient: boolean; Angle: <a  href="CastleSpaceFillingCurves.html#TSFCAngle">TSFCAngle</a>; InitialLevel: Cardinal; Step: <a  href="CastleSpaceFillingCurves.html#TSFCStepFunction">TSFCStepFunction</a>; StepData: Pointer);</code></td>
</tr>
<tr><td colspan="1">
<p>
Low-level procedures to generate consecutive Peano and Hilbert curve points. See e.g. &quot;Graphic Gems II&quot; (gem I.8) or <a  href="http://en.wikipedia.org/wiki/Space-filling_curve">http://en.wikipedia.org/wiki/Space-filling_curve</a> for nice description.

<p>Step is a function that goes to a neighbor 2D point, and &quot;marks&quot; it (whatever it means for your usage). If the starting point is &quot;marked&quot; at the beginning, using Peano or Hilbert curve guarantees that you will eventually &quot;mark&quot; the whole 2D space.

<p>Peano curve fills a plane size 3&circ;Level, Hilbert curve fills size 2&circ;Level.

<p>Angle is an initial orientation, determining in which direction the curve will be drawn. If you want to fill the space up and to the left from the initial point (according to conventions that Angle = 0 is right, Angle = 1 is up, and so on (CCW)), then use:

<p></p>

<ul class="compact_spacing">
  <li><p>InitialOrient = false and Angle = 0 for <code>PeanoCurve</code>.</p></li>
  <li><p>InitialOrient = true and Angle = 0 for <a class="normal" href="CastleSpaceFillingCurves.html#HilbertCurve">HilbertCurve</a>.</p></li>
</ul>

<p>

<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="HilbertCurve"></a><code>procedure <b>HilbertCurve</b>(InitialOrient: boolean; Angle: <a  href="CastleSpaceFillingCurves.html#TSFCAngle">TSFCAngle</a>; InitialLevel: Cardinal; Step: <a  href="CastleSpaceFillingCurves.html#TSFCStepFunction">TSFCStepFunction</a>; StepData: Pointer);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="StrToSFCurveClass"></a><code>function <b>StrToSFCurveClass</b>(const s: string): <a  href="CastleSpaceFillingCurves.html#TSpaceFillingCurveClass">TSpaceFillingCurveClass</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
For curve name (matching some <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html#SFCName">TSpaceFillingCurve.SFCName</a>), return appropriate class. Not case-sensitive. </p>
<h6 class="description_section">Exceptions raised</h6>
<dl class="exceptions_raised">
<dt><a class="normal" href="CastleSpaceFillingCurves.EInvalidSFCurveClassName.html">EInvalidSFCurveClassName</a></dt>
<dd>For unknown curve names.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="AllSFCurveClassesNames"></a><code>function <b>AllSFCurveClassesNames</b>: string;</code></td>
</tr>
<tr><td colspan="1">
<p>
All non-abstract space-filling curve names. Separated by commas, in apostrophes.</p>
</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TSFCAngle"></a><code><b>TSFCAngle</b> = 0..3;</code></td>
</tr>
<tr><td colspan="1">
<p>
Angle for space-filling curves.

<p>Let's say 0 = 0 degrees, 1 = 90 degrees, 2 = 180, 3 = 270, but actually it doesn't matter much &mdash; it all a matter of convention here.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TSFCStepFunction"></a><code><b>TSFCStepFunction</b> = procedure (Angle: <a  href="CastleSpaceFillingCurves.html#TSFCAngle">TSFCAngle</a>; StepFuncData: Pointer);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TSpaceFillingCurveClass"></a><code><b>TSpaceFillingCurveClass</b> = class of <a  href="CastleSpaceFillingCurves.TSpaceFillingCurve.html">TSpaceFillingCurve</a>;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<h3 class="detail">Constants</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="AvailableSFCurveClasses"></a><code><b>AvailableSFCurveClasses</b>: array[0..2]of <a  href="CastleSpaceFillingCurves.html#TSpaceFillingCurveClass">TSpaceFillingCurveClass</a>=
  (<a  href="CastleSpaceFillingCurves.TSwapScanCurve.html">TSwapScanCurve</a>, <a  href="CastleSpaceFillingCurves.THilbertCurve.html">THilbertCurve</a>, <a  href="CastleSpaceFillingCurves.TPeanoCurve.html">TPeanoCurve</a>);</code></td>
</tr>
<tr><td colspan="1">
<p>
Available space-filling curves (non-abstract <a class="normal" href="CastleSpaceFillingCurves.TSpaceFillingCurve.html">TSpaceFillingCurve</a> descendants).</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&amp;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>