File: CastleShapes.TShapeTreeLOD.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 (158 lines) | stat: -rw-r--r-- 11,144 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
 
<!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 TShapeTreeLOD</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="TShapeTreeLOD"></a><h1 class="cio">Class TShapeTreeLOD</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 TShapeTreeLOD = class(<a class="normal" href="CastleShapes.TShapeTreeGroup.html">TShapeTreeGroup</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Node of the <a class="normal" href="CastleShapes.TShapeTree.html">TShapeTree</a> representing the LOD (level of detail) alternative. It chooses one child from it's children list as active. Represents the VRML &gt;= 2.0 LOD node (not possible for VRML 1.0 LOD node, as it may affect also other nodes after LOD).

<p>To choose which child is active we need to know the LOD node, with it's transformation in VRML graph. This information is in <a class="normal" href="CastleShapes.TShapeTreeLOD.html#LODNode">LODNode</a> and <a class="normal" href="CastleShapes.TShapeTreeLOD.html#LODInvertedTransform">LODInvertedTransform</a> properties.

<p>Also, we need to know the current camera position. This is passed as CameraPosition to <a class="normal" href="CastleShapes.TShapeTreeLOD.html#CalculateLevel">CalculateLevel</a>. Note that this class doesn't call <a class="normal" href="CastleShapes.TShapeTreeLOD.html#CalculateLevel">CalculateLevel</a> by itself, never. You have to call <a class="normal" href="CastleShapes.TShapeTreeLOD.html#CalculateLevel">CalculateLevel</a>, and use it to set Level property, from parent scene to make this LOD work. (Reasoning behind this decision: parent scene has CameraPosition and such, and parent scene knows whether to initiate level_changes event sending.)</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor"><a class="normal" href="CastleShapes.TShapeTree.html">TShapeTree</a></li>
<li class="ancestor"><a class="normal" href="CastleShapes.TShapeTreeGroup.html">TShapeTreeGroup</a></li>
<li class="thisitem">TShapeTreeLOD</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>function <b><a  href="CastleShapes.TShapeTreeLOD.html#LODInvertedTransform">LODInvertedTransform</a></b>: <a  href="CastleVectors.html#PMatrix4Single">PMatrix4Single</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>function <b><a  href="CastleShapes.TShapeTreeLOD.html#CalculateLevel">CalculateLevel</a></b>(const CameraPosition: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>): Cardinal;</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="CastleShapes.TShapeTreeLOD.html#Traverse">Traverse</a></b>(Func: <a  href="CastleShapes.html#TShapeTraverseFunc">TShapeTraverseFunc</a>; const OnlyActive: boolean; const OnlyVisible: boolean = false; const OnlyCollidable: boolean = false); 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="CastleShapes.TShapeTreeLOD.html#ShapesCount">ShapesCount</a></b>(const OnlyActive: boolean; const OnlyVisible: boolean = false; const OnlyCollidable: boolean = false): Cardinal; 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="CastleShapes.TShapeTreeLOD.html#LODNode">LODNode</a></b>: <a  href="X3DNodes.TAbstractLODNode.html">TAbstractLODNode</a> read FLODNode write FLODNode;</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="CastleShapes.TShapeTreeLOD.html#Level">Level</a></b>: Cardinal read FLevel write FLevel default 0;</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="CastleShapes.TShapeTreeLOD.html#WasLevel_ChangedSend">WasLevel_ChangedSend</a></b>: boolean
      read FWasLevel_ChangedSend write FWasLevel_ChangedSend default false;</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="LODInvertedTransform"></a><code>function <b>LODInvertedTransform</b>: <a  href="CastleVectors.html#PMatrix4Single">PMatrix4Single</a>;</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="CalculateLevel"></a><code>function <b>CalculateLevel</b>(const CameraPosition: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>): Cardinal;</code></td>
</tr>
<tr><td colspan="2">
<p>
Calculate <a class="normal" href="CastleShapes.TShapeTreeLOD.html#Level">Level</a>. This only calculates level, doesn't assign <a class="normal" href="CastleShapes.TShapeTreeLOD.html#Level">Level</a> property or send level_changed event.</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="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); override;</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; override;</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="LODNode"></a><code>property <b>LODNode</b>: <a  href="X3DNodes.TAbstractLODNode.html">TAbstractLODNode</a> read FLODNode write FLODNode;</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="Level"></a><code>property <b>Level</b>: Cardinal read FLevel write FLevel default 0;</code></td>
</tr>
<tr><td colspan="2">
<p>
Current level, that is index of the active child of this LOD node. This is always &lt; Children.Count, unless there are no children. In this case it's 0.

<p>Should be calculated by <a class="normal" href="CastleShapes.TShapeTreeLOD.html#CalculateLevel">CalculateLevel</a>. By default we simply use the first (highest-detail) LOD as active. So if you never assign this (e.g. because <a class="normal" href="CastleSceneCore.TCastleSceneCore.html#CameraViewKnown">TCastleSceneCore.CameraViewKnown</a> = <code>False</code>, that is user position is never known) we'll always use the highest-detail children.</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="WasLevel_ChangedSend"></a><code>property <b>WasLevel_ChangedSend</b>: boolean
      read FWasLevel_ChangedSend write FWasLevel_ChangedSend default false;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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>