Rectangle
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
new Rectangle(
width?: number,
height?: number,
x?: number,
y?: number,
rot?: boolean,
allowRotation?: undefined | boolean,
): RectangleParameters
width: number = 0width of the rectangle (default is 0)
height: number = 0height of the rectangle (default is 0)
x: number = 0x position of the rectangle (default is 0)
y: number = 0y position of the rectangle (default is 0)
rot: boolean = falserotation flag (default is false)
allowRotation: undefined | boolean = undefinedallow rotation flag (default is undefined)
Returns Rectangle
Properties
Protected_
Protected_
Protected_
Protected_
Protected_
Protected_
Protected_
Protected_
oversized
Oversized tag on rectangle which is bigger than packer itself.
Accessors
allow
- get allowRotation(): undefined | boolean
If the rectangle allow rotation
Returns undefined | boolean
- set allowRotation(value: undefined | boolean): void
Set the allowRotation tag of the rectangle.
Parameters
value: undefined | boolean
Returns void
data
- get data(): any
Returns any
- set data(value: any): void
Parameters
value: any
Returns void
dirty
- get dirty(): boolean
Returns boolean
height
- get height(): number
Returns number
- set height(value: number): void
Parameters
value: number
Returns void
rot
- get rot(): boolean
If the rectangle is rotated
Returns boolean
- set rot(value: boolean): void
Set the rotate tag of the rectangle.
note: after
rotis set,width/heightof this rectangle is swaped.Parameters
value: boolean
Returns void
width
- get width(): number
Returns number
- set width(value: number): void
Parameters
value: number
Returns void
x
- get x(): number
Returns number
- set x(value: number): void
Parameters
value: number
Returns void
y
- get y(): number
Returns number
- set y(value: number): void
Parameters
value: number
Returns void
Methods
area
area(): numberGet the area (w * h) of the rectangle
Returns number
The area of the rectangle
collide
collide(rect: IRectangle): booleanTest if the given rectangle collide with this rectangle.
Parameters
rect: IRectanglerectangle to test collision with
Returns boolean
true if rectangles collide
contain
contain(rect: IRectangle): booleanTest if this rectangle contains the given rectangle.
Parameters
rect: IRectanglerectangle to test containment
Returns boolean
true if this rectangle contains the given rectangle
set
setDirty(value?: boolean): voidParameters
value: boolean = true
Returns void
StaticCollide
Collide(first: IRectangle, second: IRectangle): anyTest if two given rectangle collide each other
Parameters
first: IRectanglefirst rectangle
second: IRectanglesecond rectangle
Returns any
true if rectangles collide
StaticContain
Contain(first: IRectangle, second: IRectangle): anyTest if the first rectangle contains the second one
Parameters
first: IRectanglefirst rectangle
second: IRectanglesecond rectangle
Returns any
true if first rectangle contains the second
Creates an instance of Rectangle.