File: CastleShapes.TShapeTree.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 (170 lines) | stat: -rw-r--r-- 11,281 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
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
 
<!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: CastleShapes: Class TShapeTree</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="TShapeTree"></a><h1 class="cio">Class TShapeTree</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="CastleShapes.html">CastleShapes</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TShapeTree = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
Tree of shapes.

<p>Although VRML/X3D model already provides the tree (graph of VRML/X3D nodes), it's a little too complicated to be used at each render call. It's especially true for VRML &lt;= 1.0 (where properties may &quot;leak out&quot; from one node to the next), VRML/X3D &gt;= 2.0 cleaned a lot here but still some work must be done when traversing (like accumulating transformations).

<p>So we process VRML/X3D tree to this tree, which is much simpler with all the geometry nodes (<a class="normal" href="X3DNodes.TAbstractGeometryNode.html">TAbstractGeometryNode</a>) along with their state (<a class="normal" href="X3DNodes.TX3DGraphTraverseState.html">TX3DGraphTraverseState</a>) as leafs (<a class="normal" href="CastleShapes.TShape.html">TShape</a>).</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TShapeTree</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a  href="CastleShapes.TShapeTree.html#Create">Create</a></b>(AParentScene: TObject);</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="CastleShapes.TShapeTree.html#Traverse">Traverse</a></b>(Func: <a  href="CastleShapes.html#TShapeTraverseFunc">TShapeTraverseFunc</a>; const OnlyActive: boolean; const OnlyVisible: boolean = false; const OnlyCollidable: boolean = false); 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>function <b><a  href="CastleShapes.TShapeTree.html#ShapesCount">ShapesCount</a></b>(const OnlyActive: boolean; const OnlyVisible: boolean = false; const OnlyCollidable: boolean = false): Cardinal; virtual; abstract;</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="CastleShapes.TShapeTree.html#FindGeometryNodeName">FindGeometryNodeName</a></b>(const GeometryNodeName: string; OnlyActive: boolean = false): <a  href="CastleShapes.TShape.html">TShape</a>;</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="CastleShapes.TShapeTree.html#FindShapeWithParentNamed">FindShapeWithParentNamed</a></b>(const ParentNodeName: string; OnlyActive: boolean = false): <a  href="CastleShapes.TShape.html">TShape</a>;</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="CastleShapes.TShapeTree.html#EnumerateTextures">EnumerateTextures</a></b>(Enumerate: <a  href="CastleShapes.html#TEnumerateShapeTexturesFunction">TEnumerateShapeTexturesFunction</a>); 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>function <b><a  href="CastleShapes.TShapeTree.html#DebugInfo">DebugInfo</a></b>(const Indent: string = ''): string; virtual; abstract;</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="CastleShapes.TShapeTree.html#ParentScene">ParentScene</a></b>: TObject read FParentScene write FParentScene;</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(AParentScene: TObject);</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="Traverse"></a><code>procedure <b>Traverse</b>(Func: <a  href="CastleShapes.html#TShapeTraverseFunc">TShapeTraverseFunc</a>; const OnlyActive: boolean; const OnlyVisible: boolean = false; const OnlyCollidable: boolean = false); 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="ShapesCount"></a><code>function <b>ShapesCount</b>(const OnlyActive: boolean; const OnlyVisible: boolean = false; const OnlyCollidable: boolean = false): Cardinal; 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="FindGeometryNodeName"></a><code>function <b>FindGeometryNodeName</b>(const GeometryNodeName: string; OnlyActive: boolean = false): <a  href="CastleShapes.TShape.html">TShape</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Look for shape with Geometry.NodeName = GeometryNodeName. Returns <code>Nil</code> if not found.</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="FindShapeWithParentNamed"></a><code>function <b>FindShapeWithParentNamed</b>(const ParentNodeName: string; OnlyActive: boolean = false): <a  href="CastleShapes.TShape.html">TShape</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Look for shape with Geometry that has a parent named ParentNodeName. Parent is searched by Geometry.TryFindParentNodeByName. Returns <code>Nil</code> if not found.</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="EnumerateTextures"></a><code>procedure <b>EnumerateTextures</b>(Enumerate: <a  href="CastleShapes.html#TEnumerateShapeTexturesFunction">TEnumerateShapeTexturesFunction</a>); virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Enumerate all single texture nodes (possibly) used by the shapes. This looks into all shapes (not only active, so e.g. it looks into all Switch/LOD children, not only the chosen one).

<p>This looks into the Appearance.texture field (and if it's MultiTexture, looks into it's children). Also it looks into shaders textures. Also, for VRML 1.0, looks into LastNodes.Texture2.</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="DebugInfo"></a><code>function <b>DebugInfo</b>(const Indent: string = ''): string; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="ParentScene"></a><code>property <b>ParentScene</b>: TObject read FParentScene write FParentScene;</code></td>
</tr>
<tr><td colspan="2">
<p>
Parent <a class="normal" href="CastleSceneCore.TCastleSceneCore.html">TCastleSceneCore</a> instance. This cannot be declared here as <a class="normal" href="CastleSceneCore.TCastleSceneCore.html">TCastleSceneCore</a> (this would create circular unit dependency), but it always is <a class="normal" href="CastleSceneCore.TCastleSceneCore.html">TCastleSceneCore</a>.</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:12</em>
</span>
</td></tr></table></body></html>