-
Notifications
You must be signed in to change notification settings - Fork 1
/
box2d.html
271 lines (264 loc) · 9.87 KB
/
box2d.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<title> box2d - rectangle math </title>
<script src="jquery.js"></script>
<script src="jquery-cookie.js"></script>
<script src="jquery-tablesorter.js"></script>
<script src="strftime.js"></script>
<script src="mustache.js"></script>
<script src="config.js"></script>
<script src="main.js"></script>
<link rel="stylesheet" type="text/css" href="templates/reset.css" />
<link rel="stylesheet" type="text/css" href="templates/hack.css" />
<link rel="stylesheet" type="text/css" id="lights_css" />
<script>
var DOCNAME = 'box2d'
var PROJECT = 'box2d'
//set the lights before rendering starts
set_lights()
</script>
</head>
<body>
<header>
<div class="container">
<div class="btn-container btn-lights-container">
<a href="#" class="btn btn-lights" id="lights">lights</a>
</div>
<div class="btn-container btn-home-container">
<a href="/" class="btn btn-home">luapower</a>
</div>
<table id="header_table">
<tr>
<td style="vertical-align: middle;" width="100%">
<h1> box2d </h1>
<h2> rectangle math </h2>
</td>
<td style="vertical-align: middle;" align="right" style="height: 150px">
<table><tr><td>
<div class="doc" id="package_info_container">
<div id="package_info"> </div>
<div id="commit_log"> </div>
</div>
<a href="https://github.com/luapower/box2d" class="btn btn-rightside btn-github"><span class="icon"></span>View on GitHub</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/box2d/tarball/master" class="btn btn-rightside">Download as .tar.gz</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/box2d/zipball/master" class="btn btn-rightside">Download as .zip</a>
</td></tr></table>
</td>
</tr>
</table>
<div class="btn-container btn-discuss-container">
<a href="https://github.com/luapower/box2d/issues/new" target="_blank"
class="btn btn-rightside btn-discuss"><span class="icon"></span>Discuss</a>
</div>
</div>
</header>
<div class="bg-container">
<div class="bg-center-container">
<div class="bg bg-box2d" style="background-image: url('bg/box2d.png');"></div>
</div>
</div>
<div class="under-header">
<div class="container">
<div id="toc_container" class="toc_container doc"></div>
<button id=tab1_button class="tab_button hidden">Documentation</button>
<button id=tab2_button class="tab_button hidden">Package Info</button>
<div id="tabs_cointainer">
<div id="tab1_container">
<section class="doc">
<span id="module_info"></span>
<h2 id="local-box-requirebox2d"><code>local box = require'box2d'</code></h2>
<p>Math for 2D rectangles defined as <code>(x, y, w, h)</code>.</p>
<table>
<col width="56%" />
<col width="43%" />
<tbody>
<tr class="odd">
<td align="left"><strong>representation forms</strong></td>
<td align="left"></td>
</tr>
<tr class="even">
<td align="left"><code>box.corners(x, y, w, h) -> x1, y1, x2, y2</code></td>
<td align="left">left,top and right,bottom corners</td>
</tr>
<tr class="odd">
<td align="left"><code>box.rect(x1, y1, x2, y2) -> x, y, w, h</code></td>
<td align="left">box given left,top and right,bottom corners</td>
</tr>
<tr class="even">
<td align="left"><strong>layouting</strong></td>
<td align="left"></td>
</tr>
<tr class="odd">
<td align="left"><code>box.align(w, h, halign, valign,</code><br /><code>bx, by, bw, bh) -> x, y, w, h</code></td>
<td align="left">align a box in another box</td>
</tr>
<tr class="even">
<td align="left"><code>box.vsplit(i, sh, x, y, w, h) -> x, y, w, h</code></td>
<td align="left">slice a box horizontally at a certain height and return the i'th box. if sh is negative, slicing is done from the bottom side.</td>
</tr>
<tr class="odd">
<td align="left"><code>box.hsplit(i, sw, x, y, w, h) -> x, y, w, h</code></td>
<td align="left">slice a box vertically at a certain width and return the i'th box. if sw is negative, slicing is done from the right side.</td>
</tr>
<tr class="even">
<td align="left"><code>box.nsplit(i, n, direction, x, y, w, h) -> x, y, w, h</code></td>
<td align="left">slice a box in n equal slices, vertically or horizontally, and return the i'th box. direction = 'v' or 'h'</td>
</tr>
<tr class="odd">
<td align="left"><code>box.translate(x0, y0, x, y, w, h) -> x, y, w, h</code></td>
<td align="left">move a box</td>
</tr>
<tr class="even">
<td align="left"><code>box.offset(d, x, y, w, h) -> x, y, w, h</code></td>
<td align="left">offset a box by d, outward if d is positive</td>
</tr>
<tr class="odd">
<td align="left"><code>box.fit(w, h, bw, bh) -> w, h</code></td>
<td align="left">fit a box into another box preserving aspect ratio. use align() to position the box</td>
</tr>
<tr class="even">
<td align="left"><strong>hit testing</strong></td>
<td align="left"></td>
</tr>
<tr class="odd">
<td align="left"><code>box.hit(x0, y0, x, y, w, h) -> true | false</code></td>
<td align="left">check if a point (x0, y0) is inside rect (x, y, w, h)</td>
</tr>
<tr class="even">
<td align="left"><code>box.hit_edges(x0, y0, d, x, y, w, h)</code><br /><code>-> hit, left, top, right, bottom</code></td>
<td align="left">hit test for edges and corners</td>
</tr>
<tr class="odd">
<td align="left"><strong>edge snapping</strong></td>
<td align="left"></td>
</tr>
<tr class="even">
<td align="left"><code>box.snap_edges(d, x, y, w, h, rectangles[, opaque])</code><br /><code>-> x, y, w, h</code></td>
<td align="left">snap the sides of a rectangle against a list of rectangles of form <code>{{x=,y=,w=,h=},...}</code>. if <code>opaque = true</code>, the rectangles are considered opaque, in which case they must be sorted front-to-back.</td>
</tr>
<tr class="odd">
<td align="left"><code>box.snap_pos(d, x, y, w, h, rectangles[, opaque])</code><br /><code>-> x, y, w, h</code></td>
<td align="left">snap the position of a rectangle against a list of rectangles.</td>
</tr>
<tr class="even">
<td align="left"><code>box.snapped_edges(d, x1, y1, w1, h1, x2, y2, w2, h2[, opaque])</code><br /><code>-> snapped, left, top, right, bottom</code></td>
<td align="left">check if two boxes are snapped and on which edges.</td>
</tr>
<tr class="odd">
<td align="left"><strong>overlapping test</strong></td>
<td align="left"></td>
</tr>
<tr class="even">
<td align="left"><code>box.overlapping(x1, y1, w1, h1, x2, y2, w2, h2) -> true | false</code></td>
<td align="left">check if two boxes overlap.</td>
</tr>
<tr class="odd">
<td align="left"><strong>clipping</strong></td>
<td align="left"></td>
</tr>
<tr class="even">
<td align="left"><code>box.clip(x, y, w, h, x0, y0, w0, h0) -> x1, y1, w1, h1</code></td>
<td align="left">clip box (x, y, w, h) to fit inside box (x0, y0, w0, h0)</td>
</tr>
</tbody>
</table>
<h2 id="oop-api">OOP API</h2>
<p>Operations never mutate the object, instead they return a new one.</p>
<table>
<tbody>
<tr class="odd">
<td align="left"><code>box(x, y, w, h) -> box</code></td>
<td align="left">create a new box object</td>
</tr>
<tr class="even">
<td align="left"><code>box.x, box.y, box.w, box.h</code></td>
<td align="left">box coordinates (for reading and writing)</td>
</tr>
<tr class="odd">
<td align="left"><code>box:rect() -> x, y, w, h</code> <br> <code>box() -> x, y, w, h</code></td>
<td align="left">coordinates unpacked</td>
</tr>
<tr class="even">
<td align="left"><code>box:corners() -> x1, y1, x2, y2</code></td>
<td align="left">left,top and right,bottom corners</td>
</tr>
<tr class="odd">
<td align="left"><code>box:align(halign, valign, parent_box) -> box</code></td>
<td align="left">align</td>
</tr>
<tr class="even">
<td align="left"><code>box:vsplit(i, sh) -> box</code></td>
<td align="left">split vertically</td>
</tr>
<tr class="odd">
<td align="left"><code>box:hsplit(i, sw) -> box</code></td>
<td align="left">split horizontally</td>
</tr>
<tr class="even">
<td align="left"><code>box:nsplit(i, n, direction) -> box</code></td>
<td align="left">split in equal parts</td>
</tr>
<tr class="odd">
<td align="left"><code>box:translate(x0, y0) -> box</code></td>
<td align="left">translate</td>
</tr>
<tr class="even">
<td align="left"><code>box:offset(d) -> box</code></td>
<td align="left">offset by d (outward if d is positive)</td>
</tr>
<tr class="odd">
<td align="left"><code>box:fit(parent_box, halign, valign) -> box</code></td>
<td align="left">enlarge/shrink-to-fit and align</td>
</tr>
<tr class="even">
<td align="left"><code>box:hit(x0, y0) -> true | false</code></td>
<td align="left">hit test</td>
</tr>
<tr class="odd">
<td align="left"><code>box:hit_edges(x0, y0, d) -> hit, left, top, right, bottom</code></td>
<td align="left">hit test for edges</td>
</tr>
<tr class="even">
<td align="left"><code>box:snap_edges(d, boxes) -> box</code></td>
<td align="left">snap the edges to a list of boxes</td>
</tr>
<tr class="odd">
<td align="left"><code>box:snap_pos(d, boxes) -> box</code></td>
<td align="left">snap the position</td>
</tr>
<tr class="even">
<td align="left"><code>box:overlapping(box) -> true | false</code></td>
<td align="left">overlapping test</td>
</tr>
<tr class="odd">
<td align="left"><code>box:clip(box) -> box</code></td>
<td align="left">clip box to fit inside another box</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="tab2_container" class="doc"></div>
</div>
</div>
<div class="container">
<footer>
<div id="disqus_thread"></div>
<div class="faint">[email protected] | <a href="http://unlicense.org/">public domain</a></div>
</footer>
</div>
</div>
<script type="text/x-mustache" id=info_tab_template>
<h3>Modules</h3>
<ul>
{{#module_array}}
<li>{{name}}</li>
{{/module_array}}
</ul>
</script>
</body>
</html>