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

« back to all changes in this revision

Viewing changes to doc/pasdoc/html/X3DFields.TMFColorRGBA.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 TMFColorRGBA</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="TMFColorRGBA"></a><h1 class="cio">Class TMFColorRGBA</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>Properties</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 TMFColorRGBA = class(<a class="normal" href="X3DFields.TMFVec4f.html">TMFVec4f</a>)</code></p>
 
22
<h2 class="description">Description</h2>
 
23
<div class="nodescription">no description available, TMFVec4f description follows</div><div class="nodescription">no description available, TX3DSimpleMultField description follows</div><p>
 
24
Field holding multiple values. Remember that such field may always have any number of items, including zero.
 
25
 
 
26
<p>Note that we keep MF fields contents in TFPSList or <a class="normal" href="CastleStringUtils.TCastleStringList.html">TCastleStringList</a> instances (<a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a> in this class, also accessible as Items (with more concrete class) in descendants). This means that they are in compact form, easy for reading, or even for feeding the list into OpenGL. That's the main reason why I did not simply implement <code>TX3DSimpleMultField</code> as a descendant of TX3DSingleFieldsList: A long list of vertexes, MFVec3f, would be kept as a list of pointers to a lot of <a class="normal" href="X3DFields.TSFVec3f.html">TSFVec3f</a> instances. This would be quite memory-consuming, and very uncomfortable for access. On the contrary, current implementation keeps all these vertexes inside one <a class="normal" href="CastleVectors.TVector3SingleList.html">TVector3SingleList</a> instance, that internally keeps all items in one continuos piece of memory.
 
27
 
 
28
<p><i>Descendants implementors notes</i>: to make new descendant:
 
29
 
 
30
<p></p>
 
31
 
 
32
<ul class="paragraph_spacing">
 
33
  <li><p>In <a class="normal" href="X3DFields.TX3DField.html#CreateUndefined">CreateUndefined</a> you have to initialize FItemClass and create <a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a>. In destructor of this class, <a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a> are freed, so don't worry about this.</p></li>
 
34
  <li><p>Override RawItemsAdd.</p></li>
 
35
  <li><p> If your <a class="normal" href="X3DFields.TX3DSimpleMultField.html#ItemClass">ItemClass</a> doesn't work 100% correctly when it's initialized by <a class="normal" href="X3DFields.TX3DField.html#CreateUndefined">CreateUndefined</a>, you may have to override CreateItemBeforeParse. Fortunately, VRML specification was careful to choose as multi-valued field types' only fields that can behave nicely when initialized by <a class="normal" href="X3DFields.TX3DField.html#CreateUndefined">CreateUndefined</a> (and in fact VRML 2.0 removed the &quot;bad fields&quot; entirely).</p></li>
 
36
  <li><p>Not strictly required, but usually it's comfortable to have a constructor that allows you to init default field value from some &quot;array of TXxx&quot;.</p></li>
 
37
</ul>
 
38
 
 
39
<p></p>
 
40
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
 
41
<ul class="hierarchy"><li class="ancestor">TPersistent</li>
 
42
<li class="ancestor"><a class="normal" href="CastleInterfaces.TNonRefCountedInterfacedPersistent.html">TNonRefCountedInterfacedPersistent</a></li>
 
43
<li class="ancestor"><a class="normal" href="X3DFields.TX3DFileItem.html">TX3DFileItem</a></li>
 
44
<li class="ancestor"><a class="normal" href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</a></li>
 
45
<li class="ancestor"><a class="normal" href="X3DFields.TX3DField.html">TX3DField</a></li>
 
46
<li class="ancestor"><a class="normal" href="X3DFields.TX3DMultField.html">TX3DMultField</a></li>
 
47
<li class="ancestor"><a class="normal" href="X3DFields.TX3DSimpleMultField.html">TX3DSimpleMultField</a></li>
 
48
<li class="ancestor"><a class="normal" href="X3DFields.TMFVec4f.html">TMFVec4f</a></li>
 
49
<li class="thisitem">TMFColorRGBA</li></ul><h2 class="overview">Overview</h2>
 
50
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
 
51
<table class="summary wide_list">
 
52
<tr class="list">
 
53
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
54
<td class="itemcode"><code>class function <b><a  href="X3DFields.TMFColorRGBA.html#TypeName">TypeName</a></b>: string; override;</code></td>
 
55
</tr>
 
56
<tr class="list2">
 
57
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
58
<td class="itemcode"><code>procedure <b><a  href="X3DFields.TMFColorRGBA.html#Send">Send</a></b>(const AValue: array of <a  href="CastleVectors.html#TVector4Single">TVector4Single</a>); override;</code></td>
 
59
</tr>
 
60
</table>
 
61
<h2 class="description">Description</h2>
 
62
<h3 class="detail">Methods</h3>
 
63
<table class="detail wide_list">
 
64
<tr class="list">
 
65
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
66
<td class="itemcode"><a name="TypeName"></a><code>class function <b>TypeName</b>: string; override;</code></td>
 
67
</tr>
 
68
<tr><td colspan="2">
 
69
&nbsp;</td></tr>
 
70
</table>
 
71
<table class="detail wide_list">
 
72
<tr class="list">
 
73
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
74
<td class="itemcode"><a name="Send"></a><code>procedure <b>Send</b>(const AValue: array of <a  href="CastleVectors.html#TVector4Single">TVector4Single</a>); override;</code></td>
 
75
</tr>
 
76
<tr><td colspan="2">
 
77
&nbsp;</td></tr>
 
78
</table>
 
79
<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>
 
80
</span>
 
81
</td></tr></table></body></html>