← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/pasdoc/html/X3DNodes.TSFStringShaderType.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:
doc/pasdoc/html/X3DNodes.TSFStringShaderType.html
 
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: X3DNodes: Class TSFStringShaderType</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="TSFStringShaderType"></a><h1 class="cio">Class TSFStringShaderType</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="X3DNodes.html">X3DNodes</a></p>
 
19
<h2 class="declaration">Declaration</h2>
 
20
<p class="declaration">
 
21
<code>type TSFStringShaderType = class(<a class="normal" href="X3DFields.TSFString.html">TSFString</a>)</code></p>
 
22
<h2 class="description">Description</h2>
 
23
<div class="nodescription">no description available, TSFString description follows</div><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="ancestor"><a class="normal" href="X3DFields.TSFString.html">TSFString</a></li>
 
52
<li class="thisitem">TSFStringShaderType</li></ul><h2 class="overview">Overview</h2>
 
53
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
 
54
<table class="summary wide_list">
 
55
<tr class="list">
 
56
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
57
<td class="itemcode"><code>function <b><a  href="X3DNodes.TSFStringShaderType.html#GetValue">GetValue</a></b>(out AValue: <a  href="CastleShaders.html#TShaderType">TShaderType</a>): boolean;</code></td>
 
58
</tr>
 
59
</table>
 
60
<h2 class="description">Description</h2>
 
61
<h3 class="detail">Methods</h3>
 
62
<table class="detail wide_list">
 
63
<tr class="list">
 
64
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
65
<td class="itemcode"><a name="GetValue"></a><code>function <b>GetValue</b>(out AValue: <a  href="CastleShaders.html#TShaderType">TShaderType</a>): boolean;</code></td>
 
66
</tr>
 
67
<tr><td colspan="2">
 
68
&nbsp;</td></tr>
 
69
</table>
 
70
<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:56</em>
 
71
</span>
 
72
</td></tr></table></body></html>