File: CastleRectangles.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 (167 lines) | stat: -rw-r--r-- 9,356 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
 
<!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: CastleRectangles</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">
<h1 class="unit">Unit CastleRectangles</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Uses">Uses</a></td><td><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></td><td><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></td><td><a class="section" href="#PasDoc-Types">Types</a></td><td>Constants</td><td>Variables</td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Rectangle representation (<a class="normal" href="CastleRectangles.TRectangle.html">TRectangle</a>).</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li><a  href="CastleGenericLists.html">CastleGenericLists</a></li><li><a  href="CastleVectors.html">CastleVectors</a></li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Classes"></a><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
<table class="classestable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname">Object&nbsp;<a class="bold" href="CastleRectangles.TRectangle.html"><code>TRectangle</code></a></td>
<td class="itemdesc">2D rectangle with integer coordinates.</td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleRectangles.TRectangleList.html"><code>TRectangleList</code></a></td>
<td class="itemdesc">&nbsp;</td>
</tr>
</table>
<a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>function <b><a  href="CastleRectangles.html#Rectangle">Rectangle</a></b>(const Left, Bottom: Integer; const Width, Height: Cardinal): <a  href="CastleRectangles.TRectangle.html">TRectangle</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a  href="CastleRectangles.html#Rectangle">Rectangle</a></b>(const LeftBottom: <a  href="CastleVectors.html#TVector2Integer">TVector2Integer</a>; const Width, Height: Cardinal): <a  href="CastleRectangles.TRectangle.html">TRectangle</a>;</code></td>
</tr>
</table>
<a name="PasDoc-Types"></a><h3 class="summary">Types</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a  href="CastleRectangles.html#THorizontalPosition">THorizontalPosition</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a  href="CastleRectangles.html#TVerticalPosition">TVerticalPosition</a></b> = (...);</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="Rectangle"></a><code>function <b>Rectangle</b>(const Left, Bottom: Integer; const Width, Height: Cardinal): <a  href="CastleRectangles.TRectangle.html">TRectangle</a>;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="Rectangle"></a><code>function <b>Rectangle</b>(const LeftBottom: <a  href="CastleVectors.html#TVector2Integer">TVector2Integer</a>; const Width, Height: Cardinal): <a  href="CastleRectangles.TRectangle.html">TRectangle</a>;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="THorizontalPosition"></a><code><b>THorizontalPosition</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
Horizontal position of one control/rectangle with respect to another.

<p>This is used by <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Align">TUIRectangularControl.Align</a> and <a class="normal" href="CastleRectangles.TRectangle.html#Align">TRectangle.Align</a> to specify the alignment of one control/rectangle with respect to another. In case of <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Align">TUIRectangularControl.Align</a>, this specifies the align of control with respect to the container (<a class="normal" href="CastleWindow.TCastleWindow.html">TCastleWindow</a> or <a class="normal" href="CastleControl.TCastleControl.html">TCastleControl</a>).

<p>This is used to talk about position of the control and the container.

<p></p>

<ol class="paragraph_spacing">
  <li value="1"><p> When we talk about the position of the control (for example ControlPosition for <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Align">TUIRectangularControl.Align</a>), it determines which border of the control to align.</p></li>
  <li value="2"><p> When we talk about the position of the container (for example ContainerPosition for <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Align">TUIRectangularControl.Align</a>), this specifies the container border.</p></li>
</ol>

<p>

<p>In most cases you use equal both control and container borders. For example, both ControlPosition and ContainerPosition are usually equal for TUIControlPos.Align call. This allows to align left control edge to left container edge, or right control edge to right container edge, or to center control within the container &mdash; which is the most common usage.

<p></p>

<ul class="paragraph_spacing">
  <li><p>If both are <a class="normal" href="CastleUIControls.html#prLeft">prLeft</a>, then X specifies position of left control border relative to left container border. X should be &gt;= 0 if you want to see the control completely within the container.</p></li>
  <li><p>If both are prMiddle, then X (most often just 0) specifies the shift between container middle to control middle. If X is zero, then control is just in the middle of the container.</p></li>
  <li><p>If both are <a class="normal" href="CastleUIControls.html#prRight">prRight</a>, then X specifies position of right control border relative to right container border. X should be &lt;= 0 if you want to see the control completely within the container.</p></li>
</ul>

<p>

<p></p>
<h6 class="description_section">See also</h6>
<dl class="see_also">
  <dt><a class="normal" href="CastleRectangles.html#TVerticalPosition">TVerticalPosition</a></dt>
  <dd>Vertical position of one control/rectangle with respect to another.</dd>
</dl>
<h6 class="description_section">Values</h6>
<ul>
<li>
hpLeft: &nbsp;</li>
<li>
hpMiddle: &nbsp;</li>
<li>
hpRight: &nbsp;</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TVerticalPosition"></a><code><b>TVerticalPosition</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
Vertical position of one control/rectangle with respect to another. </p>
<h6 class="description_section">See also</h6>
<dl class="see_also">
  <dt><a class="normal" href="CastleRectangles.html#THorizontalPosition">THorizontalPosition</a></dt>
  <dd>Horizontal position of one control/rectangle with respect to another.</dd>
</dl>
<h6 class="description_section">Values</h6>
<ul>
<li>
vpBottom: &nbsp;</li>
<li>
vpMiddle: &nbsp;</li>
<li>
vpTop: &nbsp;</li>
</ul>
</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:11</em>
</span>
</td></tr></table></body></html>