File: CastleCurves.TControlPointsCurve.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 (244 lines) | stat: -rw-r--r-- 16,635 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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
<!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: CastleCurves: Class TControlPointsCurve</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="TControlPointsCurve"></a><h1 class="cio">Class TControlPointsCurve</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><a class="section" href="#PasDoc-Fields">Fields</a></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="CastleCurves.html">CastleCurves</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TControlPointsCurve = class(<a class="normal" href="CastleCurves.TCurve.html">TCurve</a>)</code></p>
<h2 class="description">Description</h2>
<p>
A basic abstract class for curves determined my some set of <a class="normal" href="CastleCurves.TControlPointsCurve.html#ControlPoints">ControlPoints</a>. Note: it is <i>not</i> defined in this class any correspondence between values of T (argument for Point function) and <a class="normal" href="CastleCurves.TControlPointsCurve.html#ControlPoints">ControlPoints</a>.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TComponent</li>
<li class="ancestor"><a class="normal" href="Castle3D.T3D.html">T3D</a></li>
<li class="ancestor"><a class="normal" href="CastleCurves.TCurve.html">TCurve</a></li>
<li class="thisitem">TControlPointsCurve</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Fields"></a><h3 class="summary">Fields</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><b><a  href="CastleCurves.TControlPointsCurve.html#ControlPoints">ControlPoints</a></b>: <a  href="CastleVectors.TVector3SingleList.html">TVector3SingleList</a>;</code></td>
</tr>
</table>
<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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleCurves.TControlPointsCurve.html#CreateConvexHullPoints">CreateConvexHullPoints</a></b>: <a  href="CastleVectors.TVector3SingleList.html">TVector3SingleList</a>; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleCurves.TControlPointsCurve.html#DestroyConvexHullPoints">DestroyConvexHullPoints</a></b>(Points: <a  href="CastleVectors.TVector3SingleList.html">TVector3SingleList</a>); virtual;</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="CastleCurves.TControlPointsCurve.html#RenderControlPoints">RenderControlPoints</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="CastleCurves.TControlPointsCurve.html#BoundingBox">BoundingBox</a></b>: <a  href="CastleBoxes.TBox3D.html">TBox3D</a>; 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>procedure <b><a  href="CastleCurves.TControlPointsCurve.html#UpdateControlPoints">UpdateControlPoints</a></b>; 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>class function <b><a  href="CastleCurves.TControlPointsCurve.html#NiceClassName">NiceClassName</a></b>: string; 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="CastleCurves.TControlPointsCurve.html#RenderConvexHull">RenderConvexHull</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>constructor <b><a  href="CastleCurves.TControlPointsCurve.html#Create">Create</a></b>(AOwner: TComponent); 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>constructor <b><a  href="CastleCurves.TControlPointsCurve.html#CreateDivideCasScriptCurve">CreateDivideCasScriptCurve</a></b>(CasScriptCurve: <a  href="CastleCurves.TCasScriptCurve.html">TCasScriptCurve</a>; ControlPointsCount: Cardinal);</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>destructor <b><a  href="CastleCurves.TControlPointsCurve.html#Destroy">Destroy</a></b>; override;</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="CastleCurves.TControlPointsCurve.html#ControlPointsColor">ControlPointsColor</a></b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a> read FControlPointsColor write FControlPointsColor;</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="CastleCurves.TControlPointsCurve.html#ConvexHullColor">ConvexHullColor</a></b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a> read FConvexHullColor write FConvexHullColor;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</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="ControlPoints"></a><code><b>ControlPoints</b>: <a  href="CastleVectors.TVector3SingleList.html">TVector3SingleList</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CreateConvexHullPoints"></a><code>function <b>CreateConvexHullPoints</b>: <a  href="CastleVectors.TVector3SingleList.html">TVector3SingleList</a>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Using these function you can control how Convex Hull (for <a class="normal" href="CastleCurves.TControlPointsCurve.html#RenderConvexHull">RenderConvexHull</a>) is calculated: <code>CreateConvexHullPoints</code> should return points that must be in convex hull (we will run <a class="normal" href="CastleConvexHull.html#ConvexHull">ConvexHull</a> function on those points), <a class="normal" href="CastleCurves.TControlPointsCurve.html#DestroyConvexHullPoints">DestroyConvexHullPoints</a> should finalize them.

<p>This way you can create new object in <code>CreateConvexHullPoints</code> and free it in <a class="normal" href="CastleCurves.TControlPointsCurve.html#DestroyConvexHullPoints">DestroyConvexHullPoints</a>, but you can also give in <code>CreateConvexHullPoints</code> reference to some already existing object and do nothing in <a class="normal" href="CastleCurves.TControlPointsCurve.html#DestroyConvexHullPoints">DestroyConvexHullPoints</a>. (we will not modify object given as <code>CreateConvexHullPoints</code> in any way)

<p>Default implementation in this class returns <a class="normal" href="CastleCurves.TControlPointsCurve.html#ControlPoints">ControlPoints</a> as <code>CreateConvexHullPoints</code>. (and does nothing in <a class="normal" href="CastleCurves.TControlPointsCurve.html#DestroyConvexHullPoints">DestroyConvexHullPoints</a>)</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="DestroyConvexHullPoints"></a><code>procedure <b>DestroyConvexHullPoints</b>(Points: <a  href="CastleVectors.TVector3SingleList.html">TVector3SingleList</a>); virtual;</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="RenderControlPoints"></a><code>procedure <b>RenderControlPoints</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Render control points, using <a class="normal" href="CastleCurves.TControlPointsCurve.html#ControlPointsColor">ControlPointsColor</a>.</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="BoundingBox"></a><code>function <b>BoundingBox</b>: <a  href="CastleBoxes.TBox3D.html">TBox3D</a>; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
This class provides implementation for <code>BoundingBox</code>: it is simply a <code>BoundingBox</code> of <a class="normal" href="CastleCurves.TControlPointsCurve.html#ControlPoints">ControlPoints</a>. Subclasses may (but don't have to) override this to calculate better (more accurate) <code>BoundingBox</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="UpdateControlPoints"></a><code>procedure <b>UpdateControlPoints</b>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Always after changing <a class="normal" href="CastleCurves.TControlPointsCurve.html#ControlPoints">ControlPoints</a> or <a class="normal" href="CastleCurves.TCurve.html#TBegin">TBegin</a> or <a class="normal" href="CastleCurves.TCurve.html#TEnd">TEnd</a> and before calling Point, <a class="normal" href="CastleCurves.TControlPointsCurve.html#BoundingBox">BoundingBox</a> (and anything that calls them, e.g. Render calls Point) call this method. It recalculates necessary things. ControlPoints.Count must be &gt;= 2.

<p>When overriding: always call inherited first.</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="NiceClassName"></a><code>class function <b>NiceClassName</b>: string; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Nice class name, with spaces, starts with a capital letter. Much better than ClassName. Especially under FPC 1.0.x where ClassName is always uppercased.</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="RenderConvexHull"></a><code>procedure <b>RenderConvexHull</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Render convex hull polygon, using <a class="normal" href="CastleCurves.TControlPointsCurve.html#ConvexHullColor">ConvexHullColor</a>. Ignores Z-coord of <a class="normal" href="CastleCurves.TControlPointsCurve.html#ControlPoints">ControlPoints</a>.</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="Create"></a><code>constructor <b>Create</b>(AOwner: TComponent); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Constructor. It has to be virtual because it's called by <a class="normal" href="CastleCurves.TControlPointsCurve.html#CreateDivideCasScriptCurve">CreateDivideCasScriptCurve</a>.</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="CreateDivideCasScriptCurve"></a><code>constructor <b>CreateDivideCasScriptCurve</b>(CasScriptCurve: <a  href="CastleCurves.TCasScriptCurve.html">TCasScriptCurve</a>; ControlPointsCount: Cardinal);</code></td>
</tr>
<tr><td colspan="2">
<p>
Calculates <a class="normal" href="CastleCurves.TControlPointsCurve.html#ControlPoints">ControlPoints</a> taking Point(i, ControlPointsCount-1) for i in [0 .. ControlPointsCount-1] from CasScriptCurve. <a class="normal" href="CastleCurves.TCurve.html#TBegin">TBegin</a> and <a class="normal" href="CastleCurves.TCurve.html#TEnd">TEnd</a> are copied from CasScriptCurve.</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="Destroy"></a><code>destructor <b>Destroy</b>; override;</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="ControlPointsColor"></a><code>property <b>ControlPointsColor</b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a> read FControlPointsColor write FControlPointsColor;</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="ConvexHullColor"></a><code>property <b>ConvexHullColor</b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a> read FConvexHullColor write FConvexHullColor;</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:09</em>
</span>
</td></tr></table></body></html>