Class Rectangle

Hierarchy

Rectangle
- NormalizedRectangle

Index

Methods

Methods

_getZone

_getZone(p: Point): integer

Calculate the rectangle Zone for a given point located around or in the rectangle. https://en.wikipedia.org/wiki/Cohen%E2%80%93Sutherland_algorithm

Parameters
- p: Point
  
  Point to test for location relative to the rectangle
Returns integer

lineSegmentIntersects

lineSegmentIntersects(a: Point, b: Point, [options]?: { inside: boolean }): boolean

Test whether a line segment AB intersects this rectangle.

Parameters
- a: Point
  
  The first endpoint of segment AB
- b: Point
  
  The second endpoint of segment AB
- [options]: { inside: boolean } = {}
  
  Options affecting the intersect test.
  - inside: boolean
Returns boolean
True if intersects.

intersectPolygon

intersectPolygon(polygon: Polygon, [options]?: { clipType: number; scalingFactor: number }): Polygon

Intersect this PIXI.Rectangle with a PIXI.Polygon. Currently uses the clipper library. In the future we may replace this with more specialized logic which uses the line-line intersection formula.

Parameters
- polygon: Polygon
  
  A PIXI.Polygon
- [options]: { clipType: number; scalingFactor: number } = {}
  
  Options which configure how the intersection is computed
  - clipType: number
  - scalingFactor: number
Returns Polygon
The intersected polygon or null if no solution was present

overlaps

overlaps(other: Rectangle): boolean

Determine whether some other Rectangle overlaps with this one. This check differs from the parent class Rectangle#intersects test because it is true for adjacency (zero area).

Parameters
- other: Rectangle
  
  Some other rectangle against which to compare
Returns boolean
Do the rectangles overlap?

normalize

normalize(): Rectangle

Normalize the width and height of the rectangle in-place, enforcing that those dimensions be positive.

Returns Rectangle