-
Notifications
You must be signed in to change notification settings - Fork 1
/
affine2d.html
206 lines (199 loc) · 7.76 KB
/
affine2d.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
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<title> affine2d - 2D affine transforms </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 = 'affine2d'
var PROJECT = 'affine2d'
//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> affine2d </h1>
<h2> 2D affine transforms </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/affine2d" class="btn btn-rightside btn-github"><span class="icon"></span>View on GitHub</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/affine2d/tarball/master" class="btn btn-rightside">Download as .tar.gz</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/affine2d/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/affine2d/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-affine2d" style="background-image: url('bg/affine2d.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-matrix-requireaffine2d"><code>local matrix = require'affine2d'</code></h2>
<table>
<tbody>
<tr class="odd">
<td align="left"><code>matrix(xx, yx, xy, yy, x0, y0) -> mt</code> <br> <code>matrix() -> mt</code></td>
<td align="left">Create a new matrix object. Defaults to identity matrix <code>1, 0, 0, 1, 0, 0</code>.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:set(xx, yx, xy, yy, x0, y0) -> mt</code></td>
<td align="left">Set the matrix fields.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:reset() -> mt</code></td>
<td align="left">Set the matrix to the identity matrix <code>1, 0, 0, 1, 0, 0</code>.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:unpack() -> xx, yx, xy, yy, x0, y0</code></td>
<td align="left">Unpack the matrix fields.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:copy() -> newmt</code></td>
<td align="left">Create a new matrix object with the same fields as <code>mt</code>.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:transform_point(x, y) -> tx, ty</code> <br> <code>mt(x, y) -> tx, ty</code></td>
<td align="left">Transform a 2D point.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:transform_distance(x, y) -> dx, dy</code></td>
<td align="left">Transform a point ignoring translation.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:multiply(bxx, byx, bxy, byy, bx0, by0) -> mt</code></td>
<td align="left">Multiply <code>mt * b</code> and store the result in <code>mt</code>.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:transform(bxx, byx, bxy, byy, bx0, by0) -> mt</code></td>
<td align="left">Multiply <code>b * mt</code> and store the result in <code>mt</code>.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:determinant() -> det</code></td>
<td align="left">Compute the matrix determinant.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:is_invertible() -> true | false</code></td>
<td align="left">Check if the matrix is invertible, that is, if the determinant is not 0, 1/0 or -1/0.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:scalar_multilpy(s) -> mt</code></td>
<td align="left">Mulitply each field of the matrix with a scalar value.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:inverse() -> newmt</code></td>
<td align="left">Return the inverse matrix, or nothing if the matrix is not invertible.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:translate(x, y) -> mt</code></td>
<td align="left">Translate the matrix.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:scale(sx, sy) -> mt</code> <br> <code>mt:scale(s)</code></td>
<td align="left">Scale the matrix.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:rotate(angle) -> mt</code></td>
<td align="left">Rotate the matrix. The angle is in degrees.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:skew(angle_x, angle_y) -> mt</code></td>
<td align="left">Skew the matrix. Angles are in degrees.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:is_identity() -> true | false</code></td>
<td align="left">Check if the matrix is the identity matrix, thus having no effect on the input.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:has_unity_scale() -> true | false</code></td>
<td align="left">Check that no scaling is done with this transform, only flipping and multiple-of-90-degree rotation.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:has_uniform_scale() -> true | false</code></td>
<td align="left">Check that scaling with this transform is uniform on both axes.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:scale_factor() -> s</code></td>
<td align="left">Largest dimension of the bounding box of the transformed unit square.</td>
</tr>
<tr class="even">
<td align="left"><code>mt:is_pixel_exact() -> true | false</code></td>
<td align="left">Check that pixels map 1:1 with this transform so that no filtering is necessary to project an image to the screen for example.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt:is_straight() -> true | false</code></td>
<td align="left">Check that there's no skew and that there's no rotation other than multiple-of-90-degree rotation.</td>
</tr>
<tr class="even">
<td align="left"><code>mt1 * mt2 -> newmt</code></td>
<td align="left">Multiply two matrices and return the result as a new matrix.</td>
</tr>
<tr class="odd">
<td align="left"><code>mt1 == mt2</code></td>
<td align="left">Test two matrices for equality. Matrices are considered equal when their fields are equal.</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>