Class Rectangle

Hierarchy

Rectangle
- Rectangle

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Rectangle(options?: IRectangle): Rectangle
new Rectangle(x?: number, y?: number, width?: number, height?: number): Rectangle

Overrides Rectangle.constructor
- Defined in source/src/maths/Rectangle.ts:13
Parameters
- Optional options: IRectangle
Returns Rectangle
Overrides PIXI.Rectangle.constructor
- Defined in source/src/maths/Rectangle.ts:14
Parameters
- Optional x: number
- Optional y: number
- Optional width: number
- Optional height: number
Returns Rectangle

Properties

height

height: number

Readonly type

type: RECT

width

width: number

x

x: number

y

y: number

Accessors

bottom

get bottom(): number

- Defined in source/node_modules/@pixi/math/index.d.ts:775
returns the bottom edge of the rectangle

member

{number}

Returns number

halfX

get halfX(): number

- Defined in source/src/maths/Rectangle.ts:38
Returns the center of this Rectangle on the X axis.

Returns number
- Half of the width.

halfY

get halfY(): number

- Defined in source/src/maths/Rectangle.ts:46
Returns the center of this Rectangle on the Y axis.

Returns number
- Half of the height.

left

get left(): number

- Defined in source/node_modules/@pixi/math/index.d.ts:757
returns the left edge of the rectangle

member

{number}

Returns number

right

get right(): number

- Defined in source/node_modules/@pixi/math/index.d.ts:763
returns the right edge of the rectangle

member

{number}

Returns number

top

get top(): number

- Defined in source/node_modules/@pixi/math/index.d.ts:769
returns the top edge of the rectangle

member

{number}

Returns number

Static EMPTY

get EMPTY(): Rectangle

- Defined in source/node_modules/@pixi/math/index.d.ts:784
A constant empty rectangle.

static

constant

member

{PIXI.Rectangle}

Returns Rectangle

An empty rectangle

Static WINDOW

get WINDOW(): Rectangle

- Defined in source/src/maths/Rectangle.ts:30
Returns a rectangle from the Window.

Returns Rectangle

Methods

ceil

ceil(resolution?: number, eps?: number): Rectangle

Inherited from Rectangle.ceil
- Defined in source/node_modules/@pixi/math/index.d.ts:836
Enlarges rectangle that way its corners lie on grid

Parameters
- Optional resolution: number
- Optional eps: number
Returns Rectangle

Returns itself.

clone

clone(): Rectangle

Inherited from Rectangle.clone
- Defined in source/node_modules/@pixi/math/index.d.ts:790
Creates a clone of this Rectangle

Returns Rectangle

a copy of the rectangle

collidesWith

collidesWith(other: Required<IRectangle>): boolean

- Defined in source/src/maths/Rectangle.ts:114
Test if this Rectangle collides with another Rectangle.

Parameters
- other: Required<IRectangle>
  
  The other rectangle.
Returns boolean
- If the rectangles collides.

collisionWith

collisionWith(other: Rectangle): null | Hit

- Defined in source/src/maths/Rectangle.ts:105
Test if this Rectangle has a collision with another Rectangle.

remarks

Expensive function, use {@link Rectangle#collidesWith} to just see if they collide or not.

Parameters
- other: Rectangle
  
  The other rectangle.
Returns null | Hit

The Hit result or null if not intersecting.

contains

contains(x: number, y: number): boolean

Inherited from Rectangle.contains
- Defined in source/node_modules/@pixi/math/index.d.ts:812
Checks whether the x and y coordinates given are contained within this Rectangle

Parameters
- x: number
  
  The X coordinate of the point to test
- y: number
  
  The Y coordinate of the point to test
Returns boolean

Whether the x/y coordinates are within this Rectangle

copyFrom

copyFrom(rectangle: Rectangle): Rectangle

Inherited from Rectangle.copyFrom
- Defined in source/node_modules/@pixi/math/index.d.ts:797
Copies another rectangle to this one.

Parameters
- rectangle: Rectangle
  
  The rectangle to copy from.
Returns Rectangle

Returns itself.

copyTo

copyTo(rectangle: Rectangle): Rectangle

Inherited from Rectangle.copyTo
- Defined in source/node_modules/@pixi/math/index.d.ts:804
Copies this rectangle to another one.

Parameters
- rectangle: Rectangle
  
  The rectangle to copy to.
Returns Rectangle

Returns given parameter.

enlarge

enlarge(rectangle: Rectangle): Rectangle

Inherited from Rectangle.enlarge
- Defined in source/node_modules/@pixi/math/index.d.ts:843
Enlarges this rectangle to include the passed rectangle.

Parameters
- rectangle: Rectangle
  
  The rectangle to include.
Returns Rectangle

Returns itself.

fit

fit(rectangle: Rectangle): Rectangle

Inherited from Rectangle.fit
- Defined in source/node_modules/@pixi/math/index.d.ts:828
Fits this rectangle around the passed one.

Parameters
- rectangle: Rectangle
  
  The rectangle to fit.
Returns Rectangle

Returns itself.

intersectSegment

intersectSegment(position: Vector2, delta: Vector2, paddingX?: number, paddingY?: number): null | Hit

- Defined in source/src/maths/Rectangle.ts:126
Test if a segment intersect with this Rectangle.

Parameters
- position: Vector2
  
  Start of the segment.
- delta: Vector2
  
  End of the segment.
- paddingX: number = 0
  
  Padding X to add to this Rectangle.
- paddingY: number = 0
  
  Padding Y to add to this Rectangle.
Returns null | Hit
- The Hit result or null if not intersecting.

pad

pad(paddingX?: number, paddingY?: number): Rectangle

Inherited from Rectangle.pad
- Defined in source/node_modules/@pixi/math/index.d.ts:821
Pads the rectangle making it grow in all directions. If paddingY is omitted, both paddingX and paddingY will be set to paddingX.

Parameters
- Optional paddingX: number
- Optional paddingY: number
Returns Rectangle

Returns itself.

toString

toString(): string

Inherited from Rectangle.toString
- Defined in source/node_modules/@pixi/math/index.d.ts:844
Returns string

Static appRectangle

appRectangle(app: Application): Rectangle

- Defined in source/src/maths/Rectangle.ts:55
Returns a rectangle from your Application.

Parameters
- app: Application
  
  The Application
Returns Rectangle
- The resulting rectangle.

Static fromCoords

fromCoords(x1: number, y1: number, x2: number, y2: number): Rectangle

- Defined in source/src/maths/Rectangle.ts:84
Create a rectangle from a set of 4 points.

Parameters
- x1: number
- y1: number
- x2: number
- y2: number
Returns Rectangle
- The resulting rectangle.

Static fromPoints

fromPoints(point1: IPointData, point2: IPointData): Rectangle

- Defined in source/src/maths/Rectangle.ts:94
Create a rectangle from two sets of points.

Parameters
- point1: IPointData
  
  First set of points, x1 & y1.
- point2: IPointData
  
  Second set of points, x2 & y2.
Returns Rectangle
- The resulting Rectangle.

Static fromSprite

fromSprite(object: Container | Sprite | Required<IRectangle>): Rectangle

- Defined in source/src/maths/Rectangle.ts:64
Create a rectangle from a Sprite or a Container.

Parameters
- object: Container | Sprite | Required<IRectangle>
  
  The object to create a Rectangle from.
Returns Rectangle
- The resulting Rectangle.

Generated using TypeDoc