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 245 246 247 248 249
|
<!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 TSFBitMask</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="TSFBitMask"></a><h1 class="cio">Class TSFBitMask</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 TSFBitMask = class(<a class="normal" href="X3DFields.TX3DSingleField.html">TX3DSingleField</a>)</code></p>
<h2 class="description">Description</h2>
<p>
SFBitMask VRML 1.0 field.
<p><code>TSFBitMask</code> is one of the exceptional field types that cannot be 100% correctly initialized by <a class="normal" href="X3DFields.TX3DField.html#CreateUndefined">CreateUndefined</a>, since EnumNames will be left undefined.</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="ancestor"><a class="normal" href="X3DFields.TX3DSingleField.html">TX3DSingleField</a></li>
<li class="thisitem">TSFBitMask</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>procedure <b><a href="X3DFields.TSFBitMask.html#SaveToStreamValue">SaveToStreamValue</a></b>(Writer: <a href="X3DFields.TX3DWriter.html">TX3DWriter</a>); override;</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="X3DFields.TSFBitMask.html#FlagsCount">FlagsCount</a></b>: integer;</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.TSFBitMask.html#ParseValue">ParseValue</a></b>(Lexer: <a href="X3DLexer.TX3DLexer.html">TX3DLexer</a>; Reader: <a href="X3DFields.TX3DReader.html">TX3DReader</a>); override;</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="X3DFields.TSFBitMask.html#AreAllFlags">AreAllFlags</a></b>(value: boolean): boolean;</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="X3DFields.TSFBitMask.html#Create">Create</a></b>(AParentNode: <a href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>; const AName: string; const AFlagNames: array of string; const ANoneString, AAllString: string; const AFlags: array of boolean);</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="X3DFields.TSFBitMask.html#Destroy">Destroy</a></b>; 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="X3DFields.TSFBitMask.html#Equals">Equals</a></b>(SecondValue: <a href="X3DFields.TX3DField.html">TX3DField</a>; const EqualityEpsilon: Double): boolean; override;</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>procedure <b><a href="X3DFields.TSFBitMask.html#Assign">Assign</a></b>(Source: TPersistent); 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="X3DFields.TSFBitMask.html#AssignValue">AssignValue</a></b>(Source: <a href="X3DFields.TX3DField.html">TX3DField</a>); override;</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="X3DFields.TSFBitMask.html#TypeName">TypeName</a></b>: string; 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="X3DFields.TSFBitMask.html#Flags">Flags</a></b>[i:integer]: boolean read GetFlags write SetFlags;</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="X3DFields.TSFBitMask.html#FlagNames">FlagNames</a></b>[i:integer]: string read GetFlagNames;</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="X3DFields.TSFBitMask.html#AllString">AllString</a></b>: string read fAllString;</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="X3DFields.TSFBitMask.html#NoneString">NoneString</a></b>: string read fNoneString;</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="SaveToStreamValue"></a><code>procedure <b>SaveToStreamValue</b>(Writer: <a href="X3DFields.TX3DWriter.html">TX3DWriter</a>); override;</code></td>
</tr>
<tr><td colspan="2">
</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="FlagsCount"></a><code>function <b>FlagsCount</b>: integer;</code></td>
</tr>
<tr><td colspan="2">
</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="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>
</tr>
<tr><td colspan="2">
</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="AreAllFlags"></a><code>function <b>AreAllFlags</b>(value: boolean): boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Are all flag values set to <code>True</code> currently.</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>(AParentNode: <a href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>; const AName: string; const AFlagNames: array of string; const ANoneString, AAllString: string; const AFlags: array of boolean);</code></td>
</tr>
<tr><td colspan="2">
<p>
Constructor.
<p>Remember that arrays AFlagNames and AFlags (AFlags is initial value of Flags) must have equal length. Eventually, AFlags may be longer (excessive items will be ignored).</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">
</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="Equals"></a><code>function <b>Equals</b>(SecondValue: <a href="X3DFields.TX3DField.html">TX3DField</a>; const EqualityEpsilon: Double): boolean; override;</code></td>
</tr>
<tr><td colspan="2">
</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="Assign"></a><code>procedure <b>Assign</b>(Source: TPersistent); override;</code></td>
</tr>
<tr><td colspan="2">
</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="AssignValue"></a><code>procedure <b>AssignValue</b>(Source: <a href="X3DFields.TX3DField.html">TX3DField</a>); override;</code></td>
</tr>
<tr><td colspan="2">
</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="TypeName"></a><code>class function <b>TypeName</b>: string; override;</code></td>
</tr>
<tr><td colspan="2">
</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="Flags"></a><code>property <b>Flags</b>[i:integer]: boolean read GetFlags write SetFlags;</code></td>
</tr>
<tr><td colspan="2">
<p>
Value of this field. You can use Index from the range 0 .. <a class="normal" href="X3DFields.TSFBitMask.html#FlagsCount">FlagsCount</a> - 1.</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="FlagNames"></a><code>property <b>FlagNames</b>[i:integer]: string read GetFlagNames;</code></td>
</tr>
<tr><td colspan="2">
</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="AllString"></a><code>property <b>AllString</b>: string read fAllString;</code></td>
</tr>
<tr><td colspan="2">
<p>
Special strings that will be understood by parser as ALL or NONE bit values. <code>AllString</code> selects all flags, <a class="normal" href="X3DFields.TSFBitMask.html#NoneString">NoneString</a> selects none. <code>AllString</code> may be '' is there's no such string, <a class="normal" href="X3DFields.TSFBitMask.html#NoneString">NoneString</a> should never be '' (otherwise, user could not be able to specify some SFBitMask values — <a class="normal" href="X3DFields.TSFBitMask.html#NoneString">NoneString</a> is the only way to specify 0).
<p>There is usually little sense in using them like "ALL | something" (because it means just "ALL") or "NONE | something" (because it means just "something"). But it's allowed syntactically.
<p></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="NoneString"></a><code>property <b>NoneString</b>: string read fNoneString;</code></td>
</tr>
<tr><td colspan="2">
</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&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>
|