-
Notifications
You must be signed in to change notification settings - Fork 7.1k
/
Rectangle.js
505 lines (442 loc) · 14 KB
/
Rectangle.js
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var Class = require('../../utils/Class');
var Contains = require('./Contains');
var GetPoint = require('./GetPoint');
var GetPoints = require('./GetPoints');
var GEOM_CONST = require('../const');
var Line = require('../line/Line');
var Random = require('./Random');
/**
* @classdesc
* Encapsulates a 2D rectangle defined by its corner point in the top-left and its extends in x (width) and y (height)
*
* @class Rectangle
* @memberof Phaser.Geom
* @constructor
* @since 3.0.0
*
* @param {number} [x=0] - The X coordinate of the top left corner of the Rectangle.
* @param {number} [y=0] - The Y coordinate of the top left corner of the Rectangle.
* @param {number} [width=0] - The width of the Rectangle.
* @param {number} [height=0] - The height of the Rectangle.
*/
var Rectangle = new Class({
initialize:
function Rectangle (x, y, width, height)
{
if (x === undefined) { x = 0; }
if (y === undefined) { y = 0; }
if (width === undefined) { width = 0; }
if (height === undefined) { height = 0; }
/**
* The geometry constant type of this object: `GEOM_CONST.RECTANGLE`.
* Used for fast type comparisons.
*
* @name Phaser.Geom.Rectangle#type
* @type {number}
* @readonly
* @since 3.19.0
*/
this.type = GEOM_CONST.RECTANGLE;
/**
* The X coordinate of the top left corner of the Rectangle.
*
* @name Phaser.Geom.Rectangle#x
* @type {number}
* @default 0
* @since 3.0.0
*/
this.x = x;
/**
* The Y coordinate of the top left corner of the Rectangle.
*
* @name Phaser.Geom.Rectangle#y
* @type {number}
* @default 0
* @since 3.0.0
*/
this.y = y;
/**
* The width of the Rectangle, i.e. the distance between its left side (defined by `x`) and its right side.
*
* @name Phaser.Geom.Rectangle#width
* @type {number}
* @default 0
* @since 3.0.0
*/
this.width = width;
/**
* The height of the Rectangle, i.e. the distance between its top side (defined by `y`) and its bottom side.
*
* @name Phaser.Geom.Rectangle#height
* @type {number}
* @default 0
* @since 3.0.0
*/
this.height = height;
},
/**
* Checks if the given point is inside the Rectangle's bounds.
*
* @method Phaser.Geom.Rectangle#contains
* @since 3.0.0
*
* @param {number} x - The X coordinate of the point to check.
* @param {number} y - The Y coordinate of the point to check.
*
* @return {boolean} `true` if the point is within the Rectangle's bounds, otherwise `false`.
*/
contains: function (x, y)
{
return Contains(this, x, y);
},
/**
* Calculates the coordinates of a point at a certain `position` on the Rectangle's perimeter.
*
* The `position` is a fraction between 0 and 1 which defines how far into the perimeter the point is.
*
* A value of 0 or 1 returns the point at the top left corner of the rectangle, while a value of 0.5 returns the point at the bottom right corner of the rectangle. Values between 0 and 0.5 are on the top or the right side and values between 0.5 and 1 are on the bottom or the left side.
*
* @method Phaser.Geom.Rectangle#getPoint
* @since 3.0.0
*
* @generic {Phaser.Geom.Point} O - [output,$return]
*
* @param {number} position - The normalized distance into the Rectangle's perimeter to return.
* @param {(Phaser.Geom.Point|object)} [output] - An object to update with the `x` and `y` coordinates of the point.
*
* @return {(Phaser.Geom.Point|object)} The updated `output` object, or a new Point if no `output` object was given.
*/
getPoint: function (position, output)
{
return GetPoint(this, position, output);
},
/**
* Returns an array of points from the perimeter of the Rectangle, each spaced out based on the quantity or step required.
*
* @method Phaser.Geom.Rectangle#getPoints
* @since 3.0.0
*
* @generic {Phaser.Geom.Point[]} O - [output,$return]
*
* @param {number} quantity - The number of points to return. Set to `false` or 0 to return an arbitrary number of points (`perimeter / stepRate`) evenly spaced around the Rectangle based on the `stepRate`.
* @param {number} [stepRate] - If `quantity` is 0, determines the normalized distance between each returned point.
* @param {(array|Phaser.Geom.Point[])} [output] - An array to which to append the points.
*
* @return {(array|Phaser.Geom.Point[])} The modified `output` array, or a new array if none was provided.
*/
getPoints: function (quantity, stepRate, output)
{
return GetPoints(this, quantity, stepRate, output);
},
/**
* Returns a random point within the Rectangle's bounds.
*
* @method Phaser.Geom.Rectangle#getRandomPoint
* @since 3.0.0
*
* @generic {Phaser.Geom.Point} O - [point,$return]
*
* @param {Phaser.Geom.Point} [point] - The object in which to store the `x` and `y` coordinates of the point.
*
* @return {Phaser.Geom.Point} The updated `point`, or a new Point if none was provided.
*/
getRandomPoint: function (point)
{
return Random(this, point);
},
/**
* Sets the position, width, and height of the Rectangle.
*
* @method Phaser.Geom.Rectangle#setTo
* @since 3.0.0
*
* @param {number} x - The X coordinate of the top left corner of the Rectangle.
* @param {number} y - The Y coordinate of the top left corner of the Rectangle.
* @param {number} width - The width of the Rectangle.
* @param {number} height - The height of the Rectangle.
*
* @return {this} This Rectangle object.
*/
setTo: function (x, y, width, height)
{
this.x = x;
this.y = y;
this.width = width;
this.height = height;
return this;
},
/**
* Resets the position, width, and height of the Rectangle to 0.
*
* @method Phaser.Geom.Rectangle#setEmpty
* @since 3.0.0
*
* @return {this} This Rectangle object.
*/
setEmpty: function ()
{
return this.setTo(0, 0, 0, 0);
},
/**
* Sets the position of the Rectangle.
*
* @method Phaser.Geom.Rectangle#setPosition
* @since 3.0.0
*
* @param {number} x - The X coordinate of the top left corner of the Rectangle.
* @param {number} [y=x] - The Y coordinate of the top left corner of the Rectangle.
*
* @return {this} This Rectangle object.
*/
setPosition: function (x, y)
{
if (y === undefined) { y = x; }
this.x = x;
this.y = y;
return this;
},
/**
* Sets the width and height of the Rectangle.
*
* @method Phaser.Geom.Rectangle#setSize
* @since 3.0.0
*
* @param {number} width - The width to set the Rectangle to.
* @param {number} [height=width] - The height to set the Rectangle to.
*
* @return {this} This Rectangle object.
*/
setSize: function (width, height)
{
if (height === undefined) { height = width; }
this.width = width;
this.height = height;
return this;
},
/**
* Determines if the Rectangle is empty. A Rectangle is empty if its width or height is less than or equal to 0.
*
* @method Phaser.Geom.Rectangle#isEmpty
* @since 3.0.0
*
* @return {boolean} `true` if the Rectangle is empty. A Rectangle object is empty if its width or height is less than or equal to 0.
*/
isEmpty: function ()
{
return (this.width <= 0 || this.height <= 0);
},
/**
* Returns a Line object that corresponds to the top of this Rectangle.
*
* @method Phaser.Geom.Rectangle#getLineA
* @since 3.0.0
*
* @generic {Phaser.Geom.Line} O - [line,$return]
*
* @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.
*
* @return {Phaser.Geom.Line} A Line object that corresponds to the top of this Rectangle.
*/
getLineA: function (line)
{
if (line === undefined) { line = new Line(); }
line.setTo(this.x, this.y, this.right, this.y);
return line;
},
/**
* Returns a Line object that corresponds to the right of this Rectangle.
*
* @method Phaser.Geom.Rectangle#getLineB
* @since 3.0.0
*
* @generic {Phaser.Geom.Line} O - [line,$return]
*
* @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.
*
* @return {Phaser.Geom.Line} A Line object that corresponds to the right of this Rectangle.
*/
getLineB: function (line)
{
if (line === undefined) { line = new Line(); }
line.setTo(this.right, this.y, this.right, this.bottom);
return line;
},
/**
* Returns a Line object that corresponds to the bottom of this Rectangle.
*
* @method Phaser.Geom.Rectangle#getLineC
* @since 3.0.0
*
* @generic {Phaser.Geom.Line} O - [line,$return]
*
* @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.
*
* @return {Phaser.Geom.Line} A Line object that corresponds to the bottom of this Rectangle.
*/
getLineC: function (line)
{
if (line === undefined) { line = new Line(); }
line.setTo(this.right, this.bottom, this.x, this.bottom);
return line;
},
/**
* Returns a Line object that corresponds to the left of this Rectangle.
*
* @method Phaser.Geom.Rectangle#getLineD
* @since 3.0.0
*
* @generic {Phaser.Geom.Line} O - [line,$return]
*
* @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.
*
* @return {Phaser.Geom.Line} A Line object that corresponds to the left of this Rectangle.
*/
getLineD: function (line)
{
if (line === undefined) { line = new Line(); }
line.setTo(this.x, this.bottom, this.x, this.y);
return line;
},
/**
* The x coordinate of the left of the Rectangle.
* Changing the left property of a Rectangle object has no effect on the y and height properties. However it does affect the width property, whereas changing the x value does not affect the width property.
*
* @name Phaser.Geom.Rectangle#left
* @type {number}
* @since 3.0.0
*/
left: {
get: function ()
{
return this.x;
},
set: function (value)
{
if (value >= this.right)
{
this.width = 0;
}
else
{
this.width = this.right - value;
}
this.x = value;
}
},
/**
* The sum of the x and width properties.
* Changing the right property of a Rectangle object has no effect on the x, y and height properties, however it does affect the width property.
*
* @name Phaser.Geom.Rectangle#right
* @type {number}
* @since 3.0.0
*/
right: {
get: function ()
{
return this.x + this.width;
},
set: function (value)
{
if (value <= this.x)
{
this.width = 0;
}
else
{
this.width = value - this.x;
}
}
},
/**
* The y coordinate of the top of the Rectangle. Changing the top property of a Rectangle object has no effect on the x and width properties.
* However it does affect the height property, whereas changing the y value does not affect the height property.
*
* @name Phaser.Geom.Rectangle#top
* @type {number}
* @since 3.0.0
*/
top: {
get: function ()
{
return this.y;
},
set: function (value)
{
if (value >= this.bottom)
{
this.height = 0;
}
else
{
this.height = (this.bottom - value);
}
this.y = value;
}
},
/**
* The sum of the y and height properties.
* Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.
*
* @name Phaser.Geom.Rectangle#bottom
* @type {number}
* @since 3.0.0
*/
bottom: {
get: function ()
{
return this.y + this.height;
},
set: function (value)
{
if (value <= this.y)
{
this.height = 0;
}
else
{
this.height = value - this.y;
}
}
},
/**
* The x coordinate of the center of the Rectangle.
*
* @name Phaser.Geom.Rectangle#centerX
* @type {number}
* @since 3.0.0
*/
centerX: {
get: function ()
{
return this.x + (this.width / 2);
},
set: function (value)
{
this.x = value - (this.width / 2);
}
},
/**
* The y coordinate of the center of the Rectangle.
*
* @name Phaser.Geom.Rectangle#centerY
* @type {number}
* @since 3.0.0
*/
centerY: {
get: function ()
{
return this.y + (this.height / 2);
},
set: function (value)
{
this.y = value - (this.height / 2);
}
}
});
module.exports = Rectangle;