Skip to content

Commit 3ba7397

Browse files
committed
Added jsdocs.
1 parent 8d97b1a commit 3ba7397

9 files changed

Lines changed: 1742 additions & 142 deletions

File tree

src/math/Matrix3.js

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,25 @@ var Matrix3 = new Class({
77

88
initialize:
99

10+
/**
11+
* [description]
12+
*
13+
* @class Matrix3
14+
* @memberOf Phaser.Math
15+
* @constructor
16+
* @since 3.0.0
17+
*
18+
* @param {Phaser.Math.Matrix3} [m] - [description]
19+
*/
1020
function Matrix3 (m)
1121
{
22+
23+
/**
24+
* [description]
25+
*
26+
* @property {Float32Array} val
27+
* @since 3.0.0
28+
*/
1229
this.val = new Float32Array(9);
1330

1431
if (m)
@@ -23,16 +40,44 @@ var Matrix3 = new Class({
2340
}
2441
},
2542

43+
/**
44+
* [description]
45+
*
46+
* @method Phaser.Math.Matrix3#clone
47+
* @since 3.0.0
48+
*
49+
* @return {[type]} [description]
50+
*/
2651
clone: function ()
2752
{
2853
return new Matrix3(this);
2954
},
3055

56+
/**
57+
* [description]
58+
*
59+
* @method Phaser.Math.Matrix3#set
60+
* @since 3.0.0
61+
*
62+
* @param {[type]} src - [description]
63+
*
64+
* @return {[type]} [description]
65+
*/
3166
set: function (src)
3267
{
3368
return this.copy(src);
3469
},
3570

71+
/**
72+
* [description]
73+
*
74+
* @method Phaser.Math.Matrix3#copy
75+
* @since 3.0.0
76+
*
77+
* @param {[type]} src - [description]
78+
*
79+
* @return {[type]} [description]
80+
*/
3681
copy: function (src)
3782
{
3883
var out = this.val;
@@ -51,6 +96,16 @@ var Matrix3 = new Class({
5196
return this;
5297
},
5398

99+
/**
100+
* [description]
101+
*
102+
* @method Phaser.Math.Matrix3#fromMat4
103+
* @since 3.0.0
104+
*
105+
* @param {[type]} m - [description]
106+
*
107+
* @return {[type]} [description]
108+
*/
54109
fromMat4: function (m)
55110
{
56111
var a = m.val;
@@ -69,6 +124,16 @@ var Matrix3 = new Class({
69124
return this;
70125
},
71126

127+
/**
128+
* [description]
129+
*
130+
* @method Phaser.Math.Matrix3#fromArray
131+
* @since 3.0.0
132+
*
133+
* @param {[type]} a - [description]
134+
*
135+
* @return {[type]} [description]
136+
*/
72137
fromArray: function (a)
73138
{
74139
var out = this.val;
@@ -86,6 +151,14 @@ var Matrix3 = new Class({
86151
return this;
87152
},
88153

154+
/**
155+
* [description]
156+
*
157+
* @method Phaser.Math.Matrix3#identity
158+
* @since 3.0.0
159+
*
160+
* @return {[type]} [description]
161+
*/
89162
identity: function ()
90163
{
91164
var out = this.val;
@@ -103,6 +176,14 @@ var Matrix3 = new Class({
103176
return this;
104177
},
105178

179+
/**
180+
* [description]
181+
*
182+
* @method Phaser.Math.Matrix3#transpose
183+
* @since 3.0.0
184+
*
185+
* @return {[type]} [description]
186+
*/
106187
transpose: function ()
107188
{
108189
var a = this.val;
@@ -120,6 +201,14 @@ var Matrix3 = new Class({
120201
return this;
121202
},
122203

204+
/**
205+
* [description]
206+
*
207+
* @method Phaser.Math.Matrix3#invert
208+
* @since 3.0.0
209+
*
210+
* @return {[type]} [description]
211+
*/
123212
invert: function ()
124213
{
125214
var a = this.val;
@@ -161,6 +250,14 @@ var Matrix3 = new Class({
161250
return this;
162251
},
163252

253+
/**
254+
* [description]
255+
*
256+
* @method Phaser.Math.Matrix3#adjoint
257+
* @since 3.0.0
258+
*
259+
* @return {[type]} [description]
260+
*/
164261
adjoint: function ()
165262
{
166263
var a = this.val;
@@ -188,6 +285,14 @@ var Matrix3 = new Class({
188285
return this;
189286
},
190287

288+
/**
289+
* [description]
290+
*
291+
* @method Phaser.Math.Matrix3#determinant
292+
* @since 3.0.0
293+
*
294+
* @return {[type]} [description]
295+
*/
191296
determinant: function ()
192297
{
193298
var a = this.val;
@@ -205,6 +310,16 @@ var Matrix3 = new Class({
205310
return a00 * (a22 * a11 - a12 * a21) + a01 * (-a22 * a10 + a12 * a20) + a02 * (a21 * a10 - a11 * a20);
206311
},
207312

313+
/**
314+
* [description]
315+
*
316+
* @method Phaser.Math.Matrix3#multiply
317+
* @since 3.0.0
318+
*
319+
* @param {[type]} src - [description]
320+
*
321+
* @return {[type]} [description]
322+
*/
208323
multiply: function (src)
209324
{
210325
var a = this.val;
@@ -246,6 +361,16 @@ var Matrix3 = new Class({
246361
return this;
247362
},
248363

364+
/**
365+
* [description]
366+
*
367+
* @method Phaser.Math.Matrix3#translate
368+
* @since 3.0.0
369+
*
370+
* @param {[type]} v - [description]
371+
*
372+
* @return {[type]} [description]
373+
*/
249374
translate: function (v)
250375
{
251376
var a = this.val;
@@ -259,6 +384,16 @@ var Matrix3 = new Class({
259384
return this;
260385
},
261386

387+
/**
388+
* [description]
389+
*
390+
* @method Phaser.Math.Matrix3#rotate
391+
* @since 3.0.0
392+
*
393+
* @param {[type]} rad - [description]
394+
*
395+
* @return {[type]} [description]
396+
*/
262397
rotate: function (rad)
263398
{
264399
var a = this.val;
@@ -284,6 +419,16 @@ var Matrix3 = new Class({
284419
return this;
285420
},
286421

422+
/**
423+
* [description]
424+
*
425+
* @method Phaser.Math.Matrix3#scale
426+
* @since 3.0.0
427+
*
428+
* @param {[type]} v - [description]
429+
*
430+
* @return {[type]} [description]
431+
*/
287432
scale: function (v)
288433
{
289434
var a = this.val;
@@ -301,6 +446,16 @@ var Matrix3 = new Class({
301446
return this;
302447
},
303448

449+
/**
450+
* [description]
451+
*
452+
* @method Phaser.Math.Matrix3#fromQuat
453+
* @since 3.0.0
454+
*
455+
* @param {[type]} q - [description]
456+
*
457+
* @return {[type]} [description]
458+
*/
304459
fromQuat: function (q)
305460
{
306461
var x = q.x;
@@ -341,6 +496,16 @@ var Matrix3 = new Class({
341496
return this;
342497
},
343498

499+
/**
500+
* [description]
501+
*
502+
* @method Phaser.Math.Matrix3#normalFromMat4
503+
* @since 3.0.0
504+
*
505+
* @param {[type]} m - [description]
506+
*
507+
* @return {[type]} [description]
508+
*/
344509
normalFromMat4: function (m)
345510
{
346511
var a = m.val;

0 commit comments

Comments
 (0)