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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2017 David Thompson davet@gnu.org
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
A copy of the license is also available from the Free Software
Foundation Web site at http://www.gnu.org/licenses/fdl.html.
The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
-->
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Rectangles (The Chickadee Game Toolkit)</title>
<meta name="description" content="Rectangles (The Chickadee Game Toolkit)">
<meta name="keywords" content="Rectangles (The Chickadee Game Toolkit)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index.html#Index" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Math.html#Math" rel="up" title="Math">
<link href="Grid.html#Grid" rel="next" title="Grid">
<link href="Vectors.html#Vectors" rel="prev" title="Vectors">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
@media (min-width: 1140px) {
body {
margin-left: 14rem;
margin-right: 4rem;
max-width: 52rem;
}
}
@media (min-width: 800px) and (max-width: 1140px) {
body {
margin-left: 6rem;
margin-right: 4rem;
max-width: 52rem;
}
}
@media (max-width: 800px) {
body {
margin: 1rem;
}
}
-->
</style>
<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">
</head>
<body lang="en">
<a name="Rectangles"></a>
<div class="header">
<p>
Next: <a href="Grid.html#Grid" accesskey="n" rel="next">Grid</a>, Previous: <a href="Vectors.html#Vectors" accesskey="p" rel="prev">Vectors</a>, Up: <a href="Math.html#Math" accesskey="u" rel="up">Math</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Rectangles-1"></a>
<h4 class="subsection">2.2.3 Rectangles</h4>
<p>The <code>(chickadee math rect)</code> module provides an API for
manipulating axis-aligned bounding boxes (AABBs). AABBs are often
used for collision detection in games. Common use-cases are defining
“hitboxes” in platformers or using them for the “broad phase” of a
collision detection algorithm that uses a more complex (and thus
slower) method of determining the actual collisions.
</p>
<p>Like some of the other math modules, there exists a collection of
functions that do in-place modification of rectangles for use in
performance critical code paths.
</p>
<dl>
<dt><a name="index-make_002drect"></a>Procedure: <strong>make-rect</strong> <em><var>x</var> <var>y</var> <var>width</var> <var>height</var></em></dt>
<dd><p>Create a new rectangle that is <var>width</var> by <var>height</var> in size and
whose bottom-left corner is located at (<var>x</var>, <var>y</var>).
</p></dd></dl>
<dl>
<dt><a name="index-rect_003f"></a>Procedure: <strong>rect?</strong> <em><var>obj</var></em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a rectangle.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dwithin_003f"></a>Procedure: <strong>rect-within?</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
<dd><p>Return <code>#t</code> if <var>rect2</var> is completely within <var>rect1</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dintersects_003f"></a>Procedure: <strong>rect-intersects?</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
<dd><p>Return <code>#t</code> if <var>rect2</var> overlaps <var>rect1</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dcontains_003f"></a>Procedure: <strong>rect-contains?</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
<dd><p>Return <code>#t</code> if the coordinates (<var>x</var>, <var>y</var>) are within
<var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dcontains_002dvec2_003f"></a>Procedure: <strong>rect-contains-vec2?</strong> <em><var>rect</var> <var>v</var></em></dt>
<dd><p>Return <code>#t</code> if the 2D vector <var>v</var> is within the bounds of
<var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dx"></a>Procedure: <strong>rect-x</strong> <em><var>rect</var></em></dt>
<dd><p>Return the X coordinate of the lower-left corner of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dy"></a>Procedure: <strong>rect-y</strong> <em><var>rect</var></em></dt>
<dd><p>Return the Y coordinate of the lower-left corner of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dleft"></a>Procedure: <strong>rect-left</strong> <em><var>rect</var></em></dt>
<dd><p>Return the left-most X coordinate of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dright"></a>Procedure: <strong>rect-right</strong> <em><var>rect</var></em></dt>
<dd><p>Return the right-most X coordinate of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dbottom"></a>Procedure: <strong>rect-bottom</strong> <em><var>rect</var></em></dt>
<dd><p>Return the bottom-most Y coordinate of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dtop"></a>Procedure: <strong>rect-top</strong> <em><var>rect</var></em></dt>
<dd><p>Return the top-most Y coordinate of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dcenter_002dx"></a>Procedure: <strong>rect-center-x</strong> <em><var>rect</var></em></dt>
<dd><p>Return the X coordinate of the center of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dcenter_002dy"></a>Procedure: <strong>rect-center-y</strong> <em><var>rect</var></em></dt>
<dd><p>Return the Y coordinate of the center of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dwidth"></a>Procedure: <strong>rect-width</strong> <em><var>rect</var></em></dt>
<dd><p>Return the width of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dheight"></a>Procedure: <strong>rect-height</strong> <em><var>rect</var></em></dt>
<dd><p>Return the height of <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002darea"></a>Procedure: <strong>rect-area</strong> <em><var>rect</var></em></dt>
<dd><p>Return the surface area covered by <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dclamp_002dx"></a>Procedure: <strong>rect-clamp-x</strong> <em><var>rect</var> <var>x</var></em></dt>
<dd><p>Restrict <var>x</var> to the portion of the X axis covered by <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dclamp_002dy"></a>Procedure: <strong>rect-clamp-y</strong> <em><var>rect</var> <var>y</var></em></dt>
<dd><p>Restrict <var>y</var> to the portion of the Y axis covered by <var>rect</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dclamp"></a>Procedure: <strong>rect-clamp</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
<dd><p>Return a new rect that adjusts the location of <var>rect1</var> so that it
is completely within <var>rect2</var>. An exception is thrown in the case
that <var>rect1</var> cannot fit completely within <var>rect2</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dmove"></a>Procedure: <strong>rect-move</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
<dd><p>Return a new rectangle based on <var>rect</var> but moved to the
coordinates (<var>x</var>, <var>y</var>).
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dmove_002dvec2"></a>Procedure: <strong>rect-move-vec2</strong> <em><var>rect</var> <var>v</var></em></dt>
<dd><p>Return a new rectangle based on <var>rect</var> but moved to the
coordinates in the 2D vector <var>v</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dmove_002dby"></a>Procedure: <strong>rect-move-by</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
<dd><p>Return a new rectangle based on <var>rect</var> but moved by (<var>x</var>,
<var>y</var>) units relative to its current location.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dmove_002dby_002dvec2"></a>Procedure: <strong>rect-move-by-vec2</strong> <em><var>rect</var> <var>v</var></em></dt>
<dd><p>Return a new rectangle based on <var>rect</var> but moved by the 2D vector
<var>v</var> relative to its current location.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dinflate"></a>Procedure: <strong>rect-inflate</strong> <em><var>rect</var> <var>width</var> <var>height</var></em></dt>
<dd><p>Return a new rectangle based on <var>rect</var>, but expanded by
<var>width</var> units on the X axis and <var>height</var> units on the Y axis,
while keeping the rectangle centered on the same point.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dunion"></a>Procedure: <strong>rect-union</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
<dd><p>Return a new rectangle that completely covers the area of <var>rect1</var>
and <var>rect2</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dclip"></a>Procedure: <strong>rect-clip</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
<dd><p>Return a new rectangle that is the overlapping region of <var>rect1</var>
and <var>rect2</var>. If the two rectangles do not overlap, a rectangle of
0 width and 0 height is returned.
</p></dd></dl>
<dl>
<dt><a name="index-set_002drect_002dx_0021"></a>Procedure: <strong>set-rect-x!</strong> <em><var>rect</var> <var>x</var></em></dt>
<dd><p>Set the left X coordinate of <var>rect</var> to <var>x</var>.
</p></dd></dl>
<dl>
<dt><a name="index-set_002drect_002dy_0021"></a>Procedure: <strong>set-rect-y!</strong> <em><var>rect</var> <var>y</var></em></dt>
<dd><p>Set the bottom Y coordinate of <var>rect</var> to <var>y</var>.
</p></dd></dl>
<dl>
<dt><a name="index-set_002drect_002dwidth_0021"></a>Procedure: <strong>set-rect-width!</strong> <em><var>rect</var> <var>width</var></em></dt>
<dd><p>Set the width of <var>rect</var> to <var>width</var>.
</p></dd></dl>
<dl>
<dt><a name="index-set_002drect_002dheight_0021"></a>Procedure: <strong>set-rect-height!</strong> <em><var>rect</var> <var>height</var></em></dt>
<dd><p>Set the height of <var>rect</var> to <var>height</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dmove_0021"></a>Procedure: <strong>rect-move!</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
<dd><p>Move <var>rect</var> to (<var>x</var>, <var>y</var>) in-place.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dmove_002dvec2_0021"></a>Procedure: <strong>rect-move-vec2!</strong> <em><var>rect</var> <var>v</var></em></dt>
<dd><p>Move <var>rect</var> to the 2D vector <var>v</var> in-place.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dmove_002dby_0021"></a>Procedure: <strong>rect-move-by!</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
<dd><p>Move <var>rect</var> by (<var>x</var>, <var>y</var>) in-place.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dmove_002dby_002dvec2_0021"></a>Procedure: <strong>rect-move-by-vec2!</strong> <em><var>rect</var> <var>v</var></em></dt>
<dd><p>Move <var>rect</var> by the 2D vector <var>v</var> in-place.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dinflate_0021"></a>Procedure: <strong>rect-inflate!</strong> <em><var>rect</var> <var>width</var> <var>height</var></em></dt>
<dd><p>Expand <var>rect</var> by <var>width</var> and <var>height</var> in-place.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dunion_0021"></a>Procedure: <strong>rect-union!</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
<dd><p>Modify <var>rect1</var> in-place to completely cover the area of both
<var>rect1</var> and <var>rect2</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dclip_0021"></a>Procedure: <strong>rect-clip!</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
<dd><p>Modify <var>rect1</var> in-place to be the overlapping region of
<var>rect1</var> and <var>rect2</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rect_002dclamp_0021"></a>Procedure: <strong>rect-clamp!</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
<dd><p>Adjust the location of <var>rect1</var> in-place so that its bounds are
completely within <var>rect2</var>. An exception is thrown in the case
that <var>rect1</var> cannot fit completely within <var>rect2</var>.
</p></dd></dl>
<dl>
<dt><a name="index-vec2_002dclamp_002dto_002drect_0021"></a>Procedure: <strong>vec2-clamp-to-rect!</strong> <em><var>v</var> <var>rect</var></em></dt>
<dd><p>Restrict the coordinates of the 2D vector <var>v</var> so that they are
within the bounds of <var>rect</var>. <var>v</var> is modified in-place.
</p></dd></dl>
<hr>
<div class="header">
<p>
Next: <a href="Grid.html#Grid" accesskey="n" rel="next">Grid</a>, Previous: <a href="Vectors.html#Vectors" accesskey="p" rel="prev">Vectors</a>, Up: <a href="Math.html#Math" accesskey="u" rel="up">Math</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
