~ubuntu-branches/ubuntu/utopic/castle-game-engine/utopic

« back to all changes in this revision

Viewing changes to doc/pasdoc/html/X3DFields.TSFMatrix4d.html

  • Committer: Package Import Robot
  • Author(s): Abou Al Montacir
  • Date: 2013-04-27 18:06:40 UTC
  • Revision ID: package-import@ubuntu.com-20130427180640-eink4nmwzuivez1c
Tags: upstream-4.0.1
ImportĀ upstreamĀ versionĀ 4.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
 
2
<html>
 
3
<head>
 
4
<title>Castle Game Engine: X3DFields: Class TSFMatrix4d</title>
 
5
<meta name="generator" content="PasDoc 0.12.1">
 
6
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
 
7
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
 
8
</head>
 
9
<body>
 
10
<table class="container"><tr><td class="navigation">
 
11
<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">
 
12
<a name="TSFMatrix4d"></a><h1 class="cio">Class TSFMatrix4d</h1>
 
13
<table class="sections wide_list">
 
14
<tr>
 
15
<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>
 
16
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
 
17
<p class="unitlink">
 
18
<a  href="X3DFields.html">X3DFields</a></p>
 
19
<h2 class="declaration">Declaration</h2>
 
20
<p class="declaration">
 
21
<code>type TSFMatrix4d = class(<a class="normal" href="X3DFields.TX3DSingleField.html">TX3DSingleField</a>)</code></p>
 
22
<h2 class="description">Description</h2>
 
23
<div class="nodescription">no description available, TX3DSingleField description follows</div><div class="nodescription">no description available, TX3DField description follows</div><p>
 
24
Base class for all VRML/X3D fields.
 
25
 
 
26
<p>Common notes for all descendants: most of them expose field or property &quot;Value&quot;, this is (surprise, surprise!) the value of the field. Many of them also expose DefaultValue and DefaultValueExists fields/properties, these should be the default VRML value for this field. You can even change DefaultValue after the object is created.
 
27
 
 
28
<p>Most of descendants include constructor that initializes both DefaultValue and Value to the same thing, as this is what you usually want.
 
29
 
 
30
<p>Some notes about <code>Assign</code> method (inherited from TPersistent and overridied appropriately in <code>TX3DField</code> descendants):
 
31
 
 
32
<p></p>
 
33
 
 
34
<ol class="paragraph_spacing">
 
35
  <li value="1"><p>There are some exceptions, but usually assignment is possible only when source and destination field classes are equal.</p></li>
 
36
  <li value="2"><p>Assignment (by <code>Assign</code>, inherited from TPersistent) tries to copy everything: name (with alternative names), default value, <a class="normal" href="X3DFields.TX3DFieldOrEvent.html#IsClauseNames">IsClauseNames</a>, <a class="normal" href="X3DFields.TX3DField.html#ValueFromIsClause">ValueFromIsClause</a>, Exposed, and of course current value.
 
37
 
 
38
<p>Exceptions are things related to hierarchy of containers: <a class="normal" href="X3DFields.TX3DFieldOrEvent.html#ParentNode">ParentNode</a>, <a class="normal" href="X3DFields.TX3DFieldOrEvent.html#ParentInterfaceDeclaration">ParentInterfaceDeclaration</a>. Also <a class="normal" href="X3DFields.TX3DField.html#ExposedEventsLinked">ExposedEventsLinked</a>.
 
39
 
 
40
<p>If you want to copy only the current value, use <a class="normal" href="X3DFields.TX3DField.html#AssignValue">AssignValue</a> (or <a class="normal" href="X3DFields.TX3DField.html#AssignLerp">AssignLerp</a>, where available).</p></li>
 
41
</ol>
 
42
 
 
43
<p></p>
 
44
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
 
45
<ul class="hierarchy"><li class="ancestor">TPersistent</li>
 
46
<li class="ancestor"><a class="normal" href="CastleInterfaces.TNonRefCountedInterfacedPersistent.html">TNonRefCountedInterfacedPersistent</a></li>
 
47
<li class="ancestor"><a class="normal" href="X3DFields.TX3DFileItem.html">TX3DFileItem</a></li>
 
48
<li class="ancestor"><a class="normal" href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</a></li>
 
49
<li class="ancestor"><a class="normal" href="X3DFields.TX3DField.html">TX3DField</a></li>
 
50
<li class="ancestor"><a class="normal" href="X3DFields.TX3DSingleField.html">TX3DSingleField</a></li>
 
51
<li class="thisitem">TSFMatrix4d</li></ul><h2 class="overview">Overview</h2>
 
52
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
 
53
<table class="summary wide_list">
 
54
<tr class="list">
 
55
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
56
<td class="itemcode"><code>constructor <b><a  href="X3DFields.TSFMatrix4d.html#Create">Create</a></b>(AParentNode: <a  href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>; const AName: string; const AValue: <a  href="CastleVectors.html#TMatrix4Double">TMatrix4Double</a>);</code></td>
 
57
</tr>
 
58
<tr class="list2">
 
59
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
60
<td class="itemcode"><code>procedure <b><a  href="X3DFields.TSFMatrix4d.html#ParseValue">ParseValue</a></b>(Lexer: <a  href="X3DLexer.TX3DLexer.html">TX3DLexer</a>; Reader: <a  href="X3DFields.TX3DReader.html">TX3DReader</a>); override;</code></td>
 
61
</tr>
 
62
<tr class="list">
 
63
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
64
<td class="itemcode"><code>function <b><a  href="X3DFields.TSFMatrix4d.html#EqualsDefaultValue">EqualsDefaultValue</a></b>: boolean; override;</code></td>
 
65
</tr>
 
66
<tr class="list2">
 
67
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
68
<td class="itemcode"><code>function <b><a  href="X3DFields.TSFMatrix4d.html#Equals">Equals</a></b>(SecondValue: <a  href="X3DFields.TX3DField.html">TX3DField</a>; const EqualityEpsilon: Double): boolean; override;</code></td>
 
69
</tr>
 
70
<tr class="list">
 
71
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
72
<td class="itemcode"><code>function <b><a  href="X3DFields.TSFMatrix4d.html#FastEqualsValue">FastEqualsValue</a></b>(SecondValue: <a  href="X3DFields.TX3DField.html">TX3DField</a>): boolean; override;</code></td>
 
73
</tr>
 
74
<tr class="list2">
 
75
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
76
<td class="itemcode"><code>procedure <b><a  href="X3DFields.TSFMatrix4d.html#AssignLerp">AssignLerp</a></b>(const A: Double; Value1, Value2: <a  href="X3DFields.TX3DField.html">TX3DField</a>); override;</code></td>
 
77
</tr>
 
78
<tr class="list">
 
79
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
80
<td class="itemcode"><code>function <b><a  href="X3DFields.TSFMatrix4d.html#CanAssignLerp">CanAssignLerp</a></b>: boolean; override;</code></td>
 
81
</tr>
 
82
<tr class="list2">
 
83
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
84
<td class="itemcode"><code>procedure <b><a  href="X3DFields.TSFMatrix4d.html#Assign">Assign</a></b>(Source: TPersistent); override;</code></td>
 
85
</tr>
 
86
<tr class="list">
 
87
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
88
<td class="itemcode"><code>procedure <b><a  href="X3DFields.TSFMatrix4d.html#AssignValue">AssignValue</a></b>(Source: <a  href="X3DFields.TX3DField.html">TX3DField</a>); override;</code></td>
 
89
</tr>
 
90
<tr class="list2">
 
91
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
92
<td class="itemcode"><code>procedure <b><a  href="X3DFields.TSFMatrix4d.html#AssignDefaultValueFromValue">AssignDefaultValueFromValue</a></b>; override;</code></td>
 
93
</tr>
 
94
<tr class="list">
 
95
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
96
<td class="itemcode"><code>class function <b><a  href="X3DFields.TSFMatrix4d.html#TypeName">TypeName</a></b>: string; override;</code></td>
 
97
</tr>
 
98
<tr class="list2">
 
99
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
100
<td class="itemcode"><code>procedure <b><a  href="X3DFields.TSFMatrix4d.html#Send">Send</a></b>(const AValue: <a  href="CastleVectors.html#TMatrix4Double">TMatrix4Double</a>); overload;</code></td>
 
101
</tr>
 
102
</table>
 
103
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
 
104
<table class="summary wide_list">
 
105
<tr class="list">
 
106
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
107
<td class="itemcode"><code>property <b><a  href="X3DFields.TSFMatrix4d.html#Value">Value</a></b>: <a  href="CastleVectors.html#TMatrix4Double">TMatrix4Double</a> read FValue write FValue;</code></td>
 
108
</tr>
 
109
</table>
 
110
<h2 class="description">Description</h2>
 
111
<h3 class="detail">Methods</h3>
 
112
<table class="detail wide_list">
 
113
<tr class="list">
 
114
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
115
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(AParentNode: <a  href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>; const AName: string; const AValue: <a  href="CastleVectors.html#TMatrix4Double">TMatrix4Double</a>);</code></td>
 
116
</tr>
 
117
<tr><td colspan="2">
 
118
&nbsp;</td></tr>
 
119
</table>
 
120
<table class="detail wide_list">
 
121
<tr class="list">
 
122
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
123
<td class="itemcode"><a name="ParseValue"></a><code>procedure <b>ParseValue</b>(Lexer: <a  href="X3DLexer.TX3DLexer.html">TX3DLexer</a>; Reader: <a  href="X3DFields.TX3DReader.html">TX3DReader</a>); override;</code></td>
 
124
</tr>
 
125
<tr><td colspan="2">
 
126
&nbsp;</td></tr>
 
127
</table>
 
128
<table class="detail wide_list">
 
129
<tr class="list">
 
130
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
131
<td class="itemcode"><a name="EqualsDefaultValue"></a><code>function <b>EqualsDefaultValue</b>: boolean; override;</code></td>
 
132
</tr>
 
133
<tr><td colspan="2">
 
134
&nbsp;</td></tr>
 
135
</table>
 
136
<table class="detail wide_list">
 
137
<tr class="list">
 
138
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
139
<td class="itemcode"><a name="Equals"></a><code>function <b>Equals</b>(SecondValue: <a  href="X3DFields.TX3DField.html">TX3DField</a>; const EqualityEpsilon: Double): boolean; override;</code></td>
 
140
</tr>
 
141
<tr><td colspan="2">
 
142
&nbsp;</td></tr>
 
143
</table>
 
144
<table class="detail wide_list">
 
145
<tr class="list">
 
146
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
147
<td class="itemcode"><a name="FastEqualsValue"></a><code>function <b>FastEqualsValue</b>(SecondValue: <a  href="X3DFields.TX3DField.html">TX3DField</a>): boolean; override;</code></td>
 
148
</tr>
 
149
<tr><td colspan="2">
 
150
&nbsp;</td></tr>
 
151
</table>
 
152
<table class="detail wide_list">
 
153
<tr class="list">
 
154
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
155
<td class="itemcode"><a name="AssignLerp"></a><code>procedure <b>AssignLerp</b>(const A: Double; Value1, Value2: <a  href="X3DFields.TX3DField.html">TX3DField</a>); override;</code></td>
 
156
</tr>
 
157
<tr><td colspan="2">
 
158
&nbsp;</td></tr>
 
159
</table>
 
160
<table class="detail wide_list">
 
161
<tr class="list">
 
162
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
163
<td class="itemcode"><a name="CanAssignLerp"></a><code>function <b>CanAssignLerp</b>: boolean; override;</code></td>
 
164
</tr>
 
165
<tr><td colspan="2">
 
166
&nbsp;</td></tr>
 
167
</table>
 
168
<table class="detail wide_list">
 
169
<tr class="list">
 
170
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
171
<td class="itemcode"><a name="Assign"></a><code>procedure <b>Assign</b>(Source: TPersistent); override;</code></td>
 
172
</tr>
 
173
<tr><td colspan="2">
 
174
&nbsp;</td></tr>
 
175
</table>
 
176
<table class="detail wide_list">
 
177
<tr class="list">
 
178
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
179
<td class="itemcode"><a name="AssignValue"></a><code>procedure <b>AssignValue</b>(Source: <a  href="X3DFields.TX3DField.html">TX3DField</a>); override;</code></td>
 
180
</tr>
 
181
<tr><td colspan="2">
 
182
&nbsp;</td></tr>
 
183
</table>
 
184
<table class="detail wide_list">
 
185
<tr class="list">
 
186
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
187
<td class="itemcode"><a name="AssignDefaultValueFromValue"></a><code>procedure <b>AssignDefaultValueFromValue</b>; override;</code></td>
 
188
</tr>
 
189
<tr><td colspan="2">
 
190
&nbsp;</td></tr>
 
191
</table>
 
192
<table class="detail wide_list">
 
193
<tr class="list">
 
194
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
195
<td class="itemcode"><a name="TypeName"></a><code>class function <b>TypeName</b>: string; override;</code></td>
 
196
</tr>
 
197
<tr><td colspan="2">
 
198
&nbsp;</td></tr>
 
199
</table>
 
200
<table class="detail wide_list">
 
201
<tr class="list">
 
202
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
203
<td class="itemcode"><a name="Send"></a><code>procedure <b>Send</b>(const AValue: <a  href="CastleVectors.html#TMatrix4Double">TMatrix4Double</a>); overload;</code></td>
 
204
</tr>
 
205
<tr><td colspan="2">
 
206
&nbsp;</td></tr>
 
207
</table>
 
208
<h3 class="detail">Properties</h3>
 
209
<table class="detail wide_list">
 
210
<tr class="list">
 
211
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
212
<td class="itemcode"><a name="Value"></a><code>property <b>Value</b>: <a  href="CastleVectors.html#TMatrix4Double">TMatrix4Double</a> read FValue write FValue;</code></td>
 
213
</tr>
 
214
<tr><td colspan="2">
 
215
&nbsp;</td></tr>
 
216
</table>
 
217
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.12.1</a> on 2013-02-04 20:26:54</em>
 
218
</span>
 
219
</td></tr></table></body></html>