Class Rect

a rectangle Object

Hierarchy (view full)

Polygon
- Rect
  - RoundRect
  - Renderable

Index

Constructors

constructor

new Rect(x, y, w, h): Rect
Parameters
- x: number
  position of the Rectangle
- y: number
  position of the Rectangle
- w: number
  width of the rectangle
- h: number
  height of the rectangle
Returns Rect
Overrides Polygon.constructor
- Defined in src/geometries/rectangle.js:19

Properties

_bounds

_bounds: undefined | object

points

points: Vector2d[]

Array of points defining the Polygon
Note: If you manually change points, you must call recalcafterwards so that the changes get applied correctly.

pos

pos: Vector2d

origin point of the Polygon

type

type: string

the shape type (used internally)

Default

"Polygon"

Accessors

bottom

get bottom(): number
bottom coordinate of the Rectangle

Returns number
- Defined in src/geometries/rectangle.js:95

centerX

get centerX(): number
absolute center of this rectangle on the horizontal axis

Returns number
- Defined in src/geometries/rectangle.js:130
set centerX(value): void
Parameters
- value: number
Returns void
- Defined in src/geometries/rectangle.js:137

centerY

get centerY(): number
absolute center of this rectangle on the vertical axis

Returns number
- Defined in src/geometries/rectangle.js:147
set centerY(value): void
Parameters
- value: number
Returns void
- Defined in src/geometries/rectangle.js:154

height

get height(): number
height of the Rectangle

Returns number
- Defined in src/geometries/rectangle.js:117
set height(value): void
Parameters
- value: number
Returns void
- Defined in src/geometries/rectangle.js:120

left

get left(): number
left coordinate of the Rectangle

Returns number
- Defined in src/geometries/rectangle.js:70

right

get right(): number
right coordinate of the Rectangle

Returns number
- Defined in src/geometries/rectangle.js:78

top

get top(): number
top coordinate of the Rectangle

Returns number
- Defined in src/geometries/rectangle.js:87

width

get width(): number
width of the Rectangle

Returns number
- Defined in src/geometries/rectangle.js:104
set width(value): void
Parameters
- value: number
Returns void
- Defined in src/geometries/rectangle.js:107

Methods

centerOn

centerOn(x, y): Rect
center the rectangle position around the given coordinates
Parameters
- x: number
  the x coordinate around which to center this rectangle
- y: number
  the y coordinate around which to center this rectangle
Returns Rect
this rectangle
- Defined in src/geometries/rectangle.js:166

clone

clone(): Rect
clone this rectangle

Returns Rect
new rectangle
Overrides Polygon.clone
- Defined in src/geometries/rectangle.js:200

contains

contains(...args): boolean
Returns true if the rectangle contains the given point or rectangle
Parameters
- Rest...args: any
Returns boolean
True if the rectangle contain the given point or rectangle, otherwise false
Example
```
if (rect.contains(10, 10)) {
  // do something
}
// or
if (rect.contains(myVector2d)) {
  // do something
}
if (rect.contains(myRect)) {
  // do something
}
```
Overrides Polygon.contains
- Defined in src/geometries/rectangle.js:263

copy

copy(rect): Rect
copy the position and size of the given rectangle into this one
Parameters
- rect: Rect
  Source rectangle
Returns Rect
new rectangle
- Defined in src/geometries/rectangle.js:209

equals

equals(rect): boolean
check if this rectangle is identical to the specified one
Parameters
- rect: Rect
Returns boolean
true if equals
- Defined in src/geometries/rectangle.js:300

getBounds

getBounds(): Bounds
returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.

Returns Bounds
this shape bounding box Rectangle object
Inherited from Polygon.getBounds
- Defined in src/geometries/poly.js:407

getIndices

getIndices(): number[]
returns a list of indices for all triangles defined in this polygon

Returns number[]
an array of vertex indices for all triangles forming this polygon.
Inherited from Polygon.getIndices
- Defined in src/geometries/poly.js:258

isConvex

isConvex(): boolean
Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).

Returns boolean
true if the vertices are convex, false if not, null if not computable
Inherited from Polygon.isConvex
- Defined in src/geometries/poly.js:269

isFinite

isFinite(): boolean
determines whether all coordinates of this rectangle are finite numbers.

Returns boolean
false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
- Defined in src/geometries/rectangle.js:313

overlaps

overlaps(rect): boolean
check if this rectangle is intersecting with the specified one
Parameters
- rect: Rect
Returns boolean
true if overlaps
- Defined in src/geometries/rectangle.js:237

recalc

recalc(): Polygon
Computes the calculated collision polygon. This must be called if the points array, angle, or offset is modified manually.

Returns Polygon
Reference to this object for method chaining
Inherited from Polygon.recalc
- Defined in src/geometries/poly.js:209

resize

resize(w, h): Rect
resize the rectangle
Parameters
- w: number
  new width of the rectangle
- h: number
  new height of the rectangle
Returns Rect
this rectangle
- Defined in src/geometries/rectangle.js:178

rotate

rotate(angle, v?): Polygon
Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
Parameters
- angle: number
  The angle to rotate (in radians)
- Optionalv: Vector2d | ObservableVector2d
  an optional point to rotate around
Returns Polygon
Reference to this object for method chaining
Inherited from Polygon.rotate
- Defined in src/geometries/poly.js:165

scale

scale(x, y?): Rect
scale the rectangle
Parameters
- x: number
  a number representing the abscissa of the scaling vector.
- Optionaly: number = x
  a number representing the ordinate of the scaling vector.
Returns Rect
this rectangle
Overrides Polygon.scale
- Defined in src/geometries/rectangle.js:190

scaleV

scaleV(v): Polygon
Scale this Polygon by the given vector
Parameters
- v: Vector2d
Returns Polygon
Reference to this object for method chaining
Inherited from Polygon.scaleV
- Defined in src/geometries/poly.js:200

setShape

setShape(x, y, w, h?, ...args): Rect
set new value to the rectangle shape
Parameters
- x: number
  position of the Rectangle
- y: number
  position of the Rectangle
- w: number | Vector2d[]
  width of the rectangle, or an array of vector defining the rectangle
- Optionalh: number
  height of the rectangle, if a numeral width parameter is specified
- Rest...args: any
Returns Rect
this rectangle
Overrides Polygon.setShape
- Defined in src/geometries/rectangle.js:49

setVertices

setVertices(vertices): Polygon
set the vertices defining this Polygon
Parameters
- vertices: Vector2d[]
  array of vector or vertice defining the Polygon
Returns Polygon
this instance for objecf chaining
Inherited from Polygon.setVertices
- Defined in src/geometries/poly.js:97

shift

shift(...args): void
Shifts the Polygon to the given position vector.
Parameters
- Rest...args: any
Returns void
Example
```
polygon.shift(10, 10);
// or
polygon.shift(myVector2d);
```
Inherited from Polygon.shift
- Defined in src/geometries/poly.js:345

to2d

to2d(): Polygon
apply a 2d projection to this shapen

Returns Polygon
Reference to this object for method chaining
Inherited from Polygon.to2d
- Defined in src/geometries/poly.js:155

toIso

toIso(): Polygon
apply an isometric projection to this shape

Returns Polygon
Reference to this object for method chaining
Inherited from Polygon.toIso
- Defined in src/geometries/poly.js:147

toPolygon

toPolygon(): Polygon
Returns a polygon whose edges are the same as this box.

Returns Polygon
a new Polygon that represents this rectangle.
- Defined in src/geometries/rectangle.js:326

transform

transform(m): Polygon
apply the given transformation matrix to this Polygon
Parameters
- m: Matrix2d
  the transformation matrix
Returns Polygon
Reference to this object for method chaining
Inherited from Polygon.transform
- Defined in src/geometries/poly.js:132

translate

translate(...args): Polygon
translate the Polygon by the specified offset
Parameters
- Rest...args: any
Returns Polygon
Reference to this object for method chaining
Example
```
polygon.translate(10, 10);
// or
polygon.translate(myVector2d);
```
Inherited from Polygon.translate
- Defined in src/geometries/poly.js:315

union

union(rect): Rect
merge this rectangle with another one
Parameters
- rect: Rect
  other rectangle to union with
Returns Rect
the union(ed) rectangle
- Defined in src/geometries/rectangle.js:218

updateBounds

updateBounds(): Bounds
update the bounding box for this shape.

Returns Bounds
this shape bounding box Rectangle object
Inherited from Polygon.updateBounds
- Defined in src/geometries/poly.js:418

Class Rect

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Rect

Properties

_bounds

points

pos

type

Default

Accessors

bottom

Returns number

centerX

Returns number

Parameters

Returns void

centerY

Returns number

Parameters

Returns void

height

Returns number

Parameters

Returns void

left

Returns number

right

Returns number

top

Returns number

width

Returns number

Parameters

Returns void

Methods

centerOn

Parameters

Returns Rect

clone

Returns Rect

contains

Parameters

Returns boolean

Example

copy

Parameters

Returns Rect

equals

Parameters

Returns boolean

getBounds

Returns Bounds

getIndices

Returns number[]

isConvex

Returns boolean

isFinite

Returns boolean

overlaps

Parameters

Returns boolean

recalc

Returns Polygon

resize

Parameters

Returns Rect

rotate

Parameters

Returns Polygon

scale

Parameters

Returns Rect