File: CastleTerrain.TTerrainGrid.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 (191 lines) | stat: -rw-r--r-- 11,585 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
 
<!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: CastleTerrain: Class TTerrainGrid</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="TTerrainGrid"></a><h1 class="cio">Class TTerrainGrid</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="CastleTerrain.html">CastleTerrain</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TTerrainGrid = class(<a class="normal" href="CastleTerrain.TTerrain.html">TTerrain</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Terrain data from a grid of values with specified width * height. Used when your underlying data is a simple 2D array of <a class="normal" href="CastleTerrain.TTerrainGrid.html#GridSizeX">GridSizeX</a> * <a class="normal" href="CastleTerrain.TTerrainGrid.html#GridSizeY">GridSizeY</a> heights. The idea is that on such terrain, there are special grid points where the height data is accurate. Everything else is an interpolation derived from this data.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor"><a class="normal" href="CastleTerrain.TTerrain.html">TTerrain</a></li>
<li class="thisitem">TTerrainGrid</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="CastleTerrain.TTerrainGrid.html#Create">Create</a></b>;</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="CastleTerrain.TTerrainGrid.html#Height">Height</a></b>(const X, Y: Single): Single; override;</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="CastleTerrain.TTerrainGrid.html#GridHeight">GridHeight</a></b>(const X, Y: Cardinal): Single; 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="CastleTerrain.TTerrainGrid.html#GridSizeX">GridSizeX</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>function <b><a  href="CastleTerrain.TTerrainGrid.html#GridSizeY">GridSizeY</a></b>: Cardinal; 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="CastleTerrain.TTerrainGrid.html#GridX1">GridX1</a></b>: Single read FGridX1 write FGridX1 default 0;</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="CastleTerrain.TTerrainGrid.html#GridY1">GridY1</a></b>: Single read FGridY1 write FGridY1 default 0;</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="CastleTerrain.TTerrainGrid.html#GridX2">GridX2</a></b>: Single read FGridX2 write FGridX2 default 1;</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="CastleTerrain.TTerrainGrid.html#GridY2">GridY2</a></b>: Single read FGridY2 write FGridY2 default 1;</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="CastleTerrain.TTerrainGrid.html#GridHeightScale">GridHeightScale</a></b>: Single read FGridHeightScale write FGridHeightScale default 1;</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>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="Height"></a><code>function <b>Height</b>(const X, Y: Single): Single; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Get height of the terrain at specified 2D point.

<p>This is implemented in <a class="normal" href="CastleTerrain.TTerrainGrid.html">TTerrainGrid</a> class, using the data returned by <a class="normal" href="CastleTerrain.TTerrainGrid.html#GridHeight">GridHeight</a>. For float X in 0..1 range, we return grid values for grid points 0..GridSizeX - 1. Outside 0..1 range, we clamp (that is, take nearest value from 0..1 range) &mdash; this way the terrain seemingly continues into the infinity.

<p>In comparison to <a class="normal" href="CastleTerrain.TTerrainGrid.html#GridHeight">GridHeight</a>, it's (very slightly) slower, and it doesn't really present any more interesting information (in contrast to typical procedural terrain, where there can be always more and more detail at each level).</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="GridHeight"></a><code>function <b>GridHeight</b>(const X, Y: Cardinal): Single; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
<a class="normal" href="CastleTerrain.TTerrainGrid.html#GridSizeX">GridSizeX</a>, <a class="normal" href="CastleTerrain.TTerrainGrid.html#GridSizeY">GridSizeY</a> specify grid dimensions. Use <code>GridHeight</code>(0..GridSizeX - 1, 0..GridSizeY - 1) to get height at particular grid point. </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="GridSizeX"></a><code>function <b>GridSizeX</b>: Cardinal; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="GridSizeY"></a><code>function <b>GridSizeY</b>: Cardinal; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="GridX1"></a><code>property <b>GridX1</b>: Single read FGridX1 write FGridX1 default 0;</code></td>
</tr>
<tr><td colspan="2">
<p>
Specify where terrain is located, for <a class="normal" href="CastleTerrain.TTerrainGrid.html#Height">Height</a> method. These do not affect <a class="normal" href="CastleTerrain.TTerrainGrid.html#GridHeight">GridHeight</a> method. </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="GridY1"></a><code>property <b>GridY1</b>: Single read FGridY1 write FGridY1 default 0;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="GridX2"></a><code>property <b>GridX2</b>: Single read FGridX2 write FGridX2 default 1;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="GridY2"></a><code>property <b>GridY2</b>: Single read FGridY2 write FGridY2 default 1;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="GridHeightScale"></a><code>property <b>GridHeightScale</b>: Single read FGridHeightScale write FGridHeightScale default 1;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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>