Class Rect

A rectangle object.

Hierarchy (View Summary)

Polygon
- Rect
  - RoundRect
  - Renderable

Index

Constructors

constructor

new Rect(x: number, y: number, w: number, h: number): Rect
Creates a new rectangle.
Parameters
- x: number
  The x position of the rectangle.
- y: number
  The y position of the rectangle.
- w: number
  The width of the rectangle.
- h: number
  The height of the rectangle.
Returns Rect
Overrides Polygon.constructor
- Defined in packages/melonjs/src/geometries/rectangle.ts:21

Properties

edges

edges: Vector2d[]

The edges here are the direction of the nth edge of the polygon, relative to the nth point. If you want to draw a given edge from the edge value, you must first translate to the position of the starting point.

indices

indices: number[]

a list of indices for all vertices composing this polygon

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 = "Rectangle"

The shape type (used internally).

Accessors

bottom

get bottom(): number
bottom coordinate of the Rectangle

Returns number
- Defined in packages/melonjs/src/geometries/rectangle.ts:68

centerX

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

Returns number
- Defined in packages/melonjs/src/geometries/rectangle.ts:100
set centerX(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/melonjs/src/geometries/rectangle.ts:107

centerY

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

Returns number
- Defined in packages/melonjs/src/geometries/rectangle.ts:116
set centerY(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/melonjs/src/geometries/rectangle.ts:123

height

get height(): number
height of the Rectangle

Returns number
- Defined in packages/melonjs/src/geometries/rectangle.ts:88
set height(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/melonjs/src/geometries/rectangle.ts:91

left

get left(): number
The left coordinate of the Rectangle.

Returns number
- Defined in packages/melonjs/src/geometries/rectangle.ts:46

right

get right(): number
right coordinate of the Rectangle

Returns number
- Defined in packages/melonjs/src/geometries/rectangle.ts:53

top

get top(): number
top coordinate of the Rectangle

Returns number
- Defined in packages/melonjs/src/geometries/rectangle.ts:61

width

get width(): number
width of the Rectangle

Returns number
- Defined in packages/melonjs/src/geometries/rectangle.ts:76
set width(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/melonjs/src/geometries/rectangle.ts:79

Methods

centerOn

centerOn(x: number, y: number): 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 packages/melonjs/src/geometries/rectangle.ts:135

clone

clone(): Rect
clone this rectangle

Returns Rect
new rectangle
Overrides Polygon.clone
- Defined in packages/melonjs/src/geometries/rectangle.ts:169

contains

contains(x: number, y: number): boolean
Returns true if the polygon contains the given point.
(Note: it is highly recommended to first do a hit test on the corresponding
bounding rect, as the function can be highly consuming with complex shapes)
Parameters
- x: number
  x coordinate or a vector point to check
- y: number
  y coordinate
Returns boolean
True if the polygon contain the point, otherwise false
Example
```
if (polygon.contains(10, 10)) {
  // do something
}
// or
if (polygon.contains(myVector2d)) {
  // do something
}
```
Overrides Polygon.contains
- Defined in packages/melonjs/src/geometries/rectangle.ts:217
contains(vector: Vector2d): boolean
Returns true if the polygon contains the given point.
(Note: it is highly recommended to first do a hit test on the corresponding
bounding rect, as the function can be highly consuming with complex shapes)
Parameters
- vector: Vector2d
Returns boolean
True if the polygon contain the point, otherwise false
Example
```
if (polygon.contains(10, 10)) {
  // do something
}
// or
if (polygon.contains(myVector2d)) {
  // do something
}
```
Overrides Polygon.contains
- Defined in packages/melonjs/src/geometries/rectangle.ts:218

containsRectangle

containsRectangle(rectangle: Rect): boolean
Returns true if the rectangle contains the given rectangle
Parameters
- rectangle: Rect
  rectangle to test
Returns boolean
True if the rectangle contain the given rectangle, otherwise false
Example
```
if (rect.containsRectangle(myRect)) {
  // do something
}
```
- Defined in packages/melonjs/src/geometries/rectangle.ts:249

copy

copy(rect: 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 packages/melonjs/src/geometries/rectangle.ts:178

equals

equals(rect: Rect): boolean
Check if this rectangle is identical to the specified one.
Parameters
- rect: Rect
  Other rectangle.
Returns boolean
true if equals
- Defined in packages/melonjs/src/geometries/rectangle.ts:263

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 packages/melonjs/src/geometries/polygon.ts:425

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 packages/melonjs/src/geometries/polygon.ts:266

isConvex

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

Returns boolean | null
true if the vertices are convex, false if not, null if not computable
Inherited from Polygon.isConvex
- Defined in packages/melonjs/src/geometries/polygon.ts:281

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 packages/melonjs/src/geometries/rectangle.ts:276

overlaps

overlaps(rect: Rect): boolean
check if this rectangle is intersecting with the specified one
Parameters
- rect: Rect
  Other rectangle.
Returns boolean
true if overlaps
- Defined in packages/melonjs/src/geometries/rectangle.ts:208

recalc

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

Returns Rect
Reference to this object for method chaining
Inherited from Polygon.recalc
- Defined in packages/melonjs/src/geometries/polygon.ts:217

resize

resize(w: number, h: number): 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 packages/melonjs/src/geometries/rectangle.ts:147

rotate

rotate(angle: number, v?: XYPoint | Vector2d): Rect
Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
Parameters
- angle: number
  The angle to rotate (in radians)
- Optionalv: XYPoint | Vector2d
  an optional point to rotate around
Returns Rect
Reference to this object for method chaining
Inherited from Polygon.rotate
- Defined in packages/melonjs/src/geometries/polygon.ts:173

scale

scale(x: number, y?: number): 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 packages/melonjs/src/geometries/rectangle.ts:159

scaleV

scaleV(v: Vector2d): Rect
Scales the polygon by the given vector.
Parameters
- v: Vector2d
  A vector containing the scaling factors for the x and y axes.
Returns Rect
Reference to this object for method chaining
Inherited from Polygon.scaleV
- Defined in packages/melonjs/src/geometries/polygon.ts:208

setShape

setShape(x: number, y: number, points: PolygonVertices | LineVertices): Rect
set new value to the Polygon
Parameters
- x: number
  position of the Polygon
- y: number
  position of the Polygon
- points: PolygonVertices | LineVertices
  array of vector or vertice defining the Polygon
Returns Rect
this instance for objecf chaining
Inherited from Polygon.setShape
- Defined in packages/melonjs/src/geometries/polygon.ts:91

setSize

setSize(width: number, height: number): Rect
Set new dimensions for the rectangle.
Parameters
- width: number
  The new width of the rectangle.
- height: number
  The new height of the rectangle.
Returns Rect
- Defined in packages/melonjs/src/geometries/rectangle.ts:35

setVertices

setVertices(vertices: PolygonVertices | LineVertices): Rect
set the vertices defining this Polygon
Parameters
- vertices: PolygonVertices | LineVertices
  array of vector or vertice defining the Polygon
Returns Rect
this instance for objecf chaining
Inherited from Polygon.setVertices
- Defined in packages/melonjs/src/geometries/polygon.ts:102

shift

shift(x: number, y?: number): void
Shifts the Polygon to the given position vector.
Parameters
- x: number
  The x coordinate or a vector point to shift to.
- Optionaly: number
  The y coordinate. This parameter is required if the first parameter is a number.
Returns void
Example
```
polygon.shift(10, 10);
// or
polygon.shift(myVector2d);
```
Inherited from Polygon.shift
- Defined in packages/melonjs/src/geometries/polygon.ts:357
shift(vector: Vector2d): void
Shifts the Polygon to the given position vector.
Parameters
- vector: Vector2d
Returns void
Example
```
polygon.shift(10, 10);
// or
polygon.shift(myVector2d);
```
Inherited from Polygon.shift
- Defined in packages/melonjs/src/geometries/polygon.ts:358

to2d

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

Returns Rect
Reference to this object for method chaining
Inherited from Polygon.to2d
- Defined in packages/melonjs/src/geometries/polygon.ts:163

toIso

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

Returns Rect
Reference to this object for method chaining
Inherited from Polygon.toIso
- Defined in packages/melonjs/src/geometries/polygon.ts:155

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 packages/melonjs/src/geometries/rectangle.ts:289

transform

transform(m: Matrix2d): Rect
apply the given transformation matrix to this Polygon
Parameters
- m: Matrix2d
  the transformation matrix
Returns Rect
Reference to this object for method chaining
Inherited from Polygon.transform
- Defined in packages/melonjs/src/geometries/polygon.ts:140

translate

translate(x: number, y?: number): Polygon
Translates the Polygon by the specified offset.
Parameters
- x: number
  The x offset or a vector point to translate by.
- Optionaly: number
  The y offset. This parameter is required if the first parameter is a number.
Returns Polygon
Reference to this object for method chaining
Example
```
polygon.translate(10, 10);
// or
polygon.translate(myVector2d);
```
Inherited from Polygon.translate
- Defined in packages/melonjs/src/geometries/polygon.ts:327
translate(vector: Vector2d): Polygon
Translates the Polygon by the specified offset.
Parameters
- vector: Vector2d
Returns Polygon
Reference to this object for method chaining
Example
```
polygon.translate(10, 10);
// or
polygon.translate(myVector2d);
```
Inherited from Polygon.translate
- Defined in packages/melonjs/src/geometries/polygon.ts:328

union

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

updateBounds

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

Returns Bounds
this shape bounding box Rectangle object
Inherited from Polygon.updateBounds
- Defined in packages/melonjs/src/geometries/polygon.ts:433

Class Rect

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Rect

Properties

edges

indices

points

pos

type

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

Parameters

Returns boolean

Example

containsRectangle

Parameters

Returns boolean

Example

copy

Parameters

Returns Rect

equals

Parameters

Returns boolean

getBounds

Returns Bounds

getIndices

Returns number[]

isConvex

Returns boolean | null

isFinite

Returns boolean

overlaps

Parameters

Returns boolean

recalc

Returns Rect

resize

Parameters