File: X3DFields.TX3DMultField.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 (139 lines) | stat: -rw-r--r-- 9,171 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
 
<!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: X3DFields: Class TX3DMultField</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="TX3DMultField"></a><h1 class="cio">Class TX3DMultField</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="X3DFields.html">X3DFields</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TX3DMultField = class(<a class="normal" href="X3DFields.TX3DField.html">TX3DField</a>)</code></p>
<h2 class="description">Description</h2>
<div class="nodescription">no description available, TX3DField description follows</div><p>
Base class for all VRML/X3D fields.

<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.

<p>Most of descendants include constructor that initializes both DefaultValue and Value to the same thing, as this is what you usually want.

<p>Some notes about <code>Assign</code> method (inherited from TPersistent and overridied appropriately in <code>TX3DField</code> descendants):

<p></p>

<ol class="paragraph_spacing">
  <li value="1"><p>There are some exceptions, but usually assignment is possible only when source and destination field classes are equal.</p></li>
  <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.

<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>.

<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>
</ol>

<p></p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TPersistent</li>
<li class="ancestor"><a class="normal" href="CastleInterfaces.TNonRefCountedInterfacedPersistent.html">TNonRefCountedInterfacedPersistent</a></li>
<li class="ancestor"><a class="normal" href="X3DFields.TX3DFileItem.html">TX3DFileItem</a></li>
<li class="ancestor"><a class="normal" href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</a></li>
<li class="ancestor"><a class="normal" href="X3DFields.TX3DField.html">TX3DField</a></li>
<li class="thisitem">TX3DMultField</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a  href="X3DFields.TX3DMultField.html#GetCount">GetCount</a></b>: Integer; virtual; abstract;</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="X3DFields.TX3DMultField.html#SetCount">SetCount</a></b>(const Value: Integer); 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="X3DFields.TX3DMultField.html#CheckCountEqual">CheckCountEqual</a></b>(SecondValue: <a  href="X3DFields.TX3DMultField.html">TX3DMultField</a>);</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="X3DFields.TX3DMultField.html#Count">Count</a></b>: Integer read <a  href="X3DFields.TX3DMultField.html#GetCount">GetCount</a> write <a  href="X3DFields.TX3DMultField.html#SetCount">SetCount</a>;</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetCount"></a><code>function <b>GetCount</b>: Integer; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Get or set the number of items, see <a class="normal" href="X3DFields.TX3DMultField.html#Count">Count</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="SetCount"></a><code>procedure <b>SetCount</b>(const Value: Integer); 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="CheckCountEqual"></a><code>procedure <b>CheckCountEqual</b>(SecondValue: <a  href="X3DFields.TX3DMultField.html">TX3DMultField</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
If SecondValue.Count &lt;&gt; Count, raises <a class="normal" href="X3DFields.EX3DMultFieldDifferentCount.html">EX3DMultFieldDifferentCount</a></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="Count"></a><code>property <b>Count</b>: Integer read <a  href="X3DFields.TX3DMultField.html#GetCount">GetCount</a> write <a  href="X3DFields.TX3DMultField.html#SetCount">SetCount</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Number of items in this field.

<p>Remember that increasing this generally sets new items to undefined values (see <a class="normal" href="X3DFields.TX3DMultField.html#SetCount">SetCount</a> documentation of particular descendant for docs). So you usually want to initialize them afterwards to something correct.</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:13</em>
</span>
</td></tr></table></body></html>