File: CastleControl.TCastleControl.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 (189 lines) | stat: -rw-r--r-- 11,735 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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
<!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: CastleControl: Class TCastleControl</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="TCastleControl"></a><h1 class="cio">Class TCastleControl</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="CastleControl.html">CastleControl</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCastleControl = class(<a class="normal" href="CastleControl.TCastleControlCustom.html">TCastleControlCustom</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Render 3D world and GUI controls. Add your game stuff (3D descending from <a class="normal" href="Castle3D.T3D.html">T3D</a>, like <a class="normal" href="CastleScene.TCastleScene.html">TCastleScene</a>) to the scene manager available in <a class="normal" href="CastleControl.TCastleControl.html#SceneManager">SceneManager</a> property. Add your GUI stuff to the <a class="normal" href="CastleControl.TCastleControlCustom.html#Controls">TCastleControlCustom.Controls</a> property (from ancestor <a class="normal" href="CastleControl.TCastleControlCustom.html">TCastleControlCustom</a>).

<p>You can directly access the <a class="normal" href="CastleControl.TCastleControl.html#SceneManager">SceneManager</a> and configure it however you like.

<p>You have comfortable <a class="normal" href="CastleControl.TCastleControl.html#Load">Load</a> method that simply loads a single 3D model to your world.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TCustomOpenGLControl</li>
<li class="ancestor"><a class="normal" href="CastleControl.TCastleControlCustom.html">TCastleControlCustom</a></li>
<li class="thisitem">TCastleControl</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="CastleControl.TCastleControl.html#Create">Create</a></b>(AOwner: TComponent); 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="CastleControl.TCastleControl.html#Load">Load</a></b>(const SceneURL: string);</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="CastleControl.TCastleControl.html#Load">Load</a></b>(ARootNode: <a  href="X3DNodes.TX3DRootNode.html">TX3DRootNode</a>; const OwnsRootNode: 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>function <b><a  href="CastleControl.TCastleControl.html#MainScene">MainScene</a></b>: <a  href="CastleScene.TCastleScene.html">TCastleScene</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="CastleControl.TCastleControl.html#Camera">Camera</a></b>: <a  href="CastleCameras.TCamera.html">TCamera</a>;</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleControl.TCastleControl.html#SceneManager">SceneManager</a></b>: <a  href="CastleControl.TControlGameSceneManager.html">TControlGameSceneManager</a> read FSceneManager;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleControl.TCastleControl.html#OnCameraChanged">OnCameraChanged</a></b>: TNotifyEvent
      read GetOnCameraChanged write SetOnCameraChanged;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleControl.TCastleControl.html#ShadowVolumes">ShadowVolumes</a></b>: boolean
      read GetShadowVolumes write SetShadowVolumes
      default <a  href="CastleSceneManager.TCastleAbstractViewport.html#DefaultShadowVolumes">TCastleAbstractViewport.DefaultShadowVolumes</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleControl.TCastleControl.html#ShadowVolumesRender">ShadowVolumesRender</a></b>: boolean
      read GetShadowVolumesRender write SetShadowVolumesRender 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="Create"></a><code>constructor <b>Create</b>(AOwner: TComponent); 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="Load"></a><code>procedure <b>Load</b>(const SceneURL: string);</code></td>
</tr>
<tr><td colspan="2">
<p>
Load a single 3D model to your world (removing other models, and resetting the camera).

<p>This is nice for simple 3D model browsers, but usually for games you don't want to use this method &mdash; it's more flexible to create <a class="normal" href="CastleScene.TCastleScene.html">TCastleScene</a> yourself, and add it to scene manager yourself, see engine examples like scene_manager_basic.lpr.</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="Load"></a><code>procedure <b>Load</b>(ARootNode: <a  href="X3DNodes.TX3DRootNode.html">TX3DRootNode</a>; const OwnsRootNode: boolean);</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="MainScene"></a><code>function <b>MainScene</b>: <a  href="CastleScene.TCastleScene.html">TCastleScene</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="Camera"></a><code>function <b>Camera</b>: <a  href="CastleCameras.TCamera.html">TCamera</a>;</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="SceneManager"></a><code>property <b>SceneManager</b>: <a  href="CastleControl.TControlGameSceneManager.html">TControlGameSceneManager</a> read FSceneManager;</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="OnCameraChanged"></a><code>property <b>OnCameraChanged</b>: TNotifyEvent
      read GetOnCameraChanged write SetOnCameraChanged;</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="ShadowVolumes"></a><code>property <b>ShadowVolumes</b>: boolean
      read GetShadowVolumes write SetShadowVolumes
      default <a  href="CastleSceneManager.TCastleAbstractViewport.html#DefaultShadowVolumes">TCastleAbstractViewport.DefaultShadowVolumes</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
See <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#ShadowVolumes">TCastleAbstractViewport.ShadowVolumes</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="ShadowVolumesRender"></a><code>property <b>ShadowVolumesRender</b>: boolean
      read GetShadowVolumesRender write SetShadowVolumesRender default false;</code></td>
</tr>
<tr><td colspan="2">
<p>
See <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#ShadowVolumesRender">TCastleAbstractViewport.ShadowVolumesRender</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:09</em>
</span>
</td></tr></table></body></html>