Class AnchoredRect

constructor

• new AnchoredRect(): AnchoredRect

  Create rectangle with all zero values.

  Returns AnchoredRect

• new AnchoredRect(
      left: number,
      right: number,
      top: number,
      bottom: number,
  ): AnchoredRect

  Create rectangle with left, right, top, bottom. Properties anchorX and anchorY will be centered in the middle.

  Parameters

  • left: number

    Left coordinate.

  • right: number

    Right coordinate.

  • top: number

    Top coordinate.

  • bottom: number

    Bottom coordinate.

  Returns AnchoredRect

• new AnchoredRect(
      left: number,
      anchorX: number,
      right: number,
      top: number,
      anchorY: number,
      bottom: number,
  ): AnchoredRect

  Create rectangle with full arguments.

  Parameters

  • left: number

    Left coordinate.

  • anchorX: number

    Center x-coordinate.

  • right: number

    Right coordinate.

  • top: number

    Top coordinate.

  • anchorY: number

    Center y-coordinate.

  • bottom: number

    Bottom coordinate.

  Returns AnchoredRect

anchorX

anchorY

bottom

left

right

top

bottomh

• get bottomh(): number

  Bottom section height getter.

  Returns number

centerX

• get centerX(): number

  Get center x-coordinate.

  Returns number

centerY

• get centerY(): number

  Get center ycoordinate.

  Returns number

height

• get height(): number

  Height getter.

  Returns number

leftw

• get leftw(): number

  Left section width getter.

  Returns number

rightw

• get rightw(): number

  Right section width getter.

  Returns number

toph

• get toph(): number

  Top section height getter.

  Returns number

width

• get width(): number

  Width getter.

  Returns number

clipCopy

• clipCopy(clipRect: AnchoredRect): AnchoredRect

  Clip this Rect by given Rect. Immutable, return modified copy.

  Parameters

  • clipRect: AnchoredRect

    AnchoredRecto to clip this instance with.

  Returns AnchoredRect

  • Clipped AnchoredRect copy.

clipInPlace

• clipInPlace(clipRect: AnchoredRect): AnchoredRect

  Clip this Rect by given Rect. Mmodifies this Rect.

  Parameters

  • clipRect: AnchoredRect

    AnchoredRect to clip this instance with.

  Returns AnchoredRect

  • This AnchoredRect instance.

clone

• clone(): AnchoredRect

  Created duplicate of this Rect.

  Returns AnchoredRect

  • Duplicate.

contains

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

  Does this Rect contain given (x, y)-point?

  Parameters

  • x: number

    X-coordinate.

  • y: number

    Y-coordinate.

  Returns boolean

  • True/false.

equals

• equals(other: AnchoredRect): boolean

  Check if this rect equals with another rect.

  Parameters

  • other: AnchoredRect

    The other rect.

  Returns boolean

  • True/false.

equalsEdges

• equalsEdges(other: AnchoredRect): boolean

  Check if edges of this Rect equals with given Rect, ignoring anchorX and anchorY.

  Parameters

  • other: AnchoredRect

    The other AnchoredRect.

  Returns boolean

  • True/false.

expandCopy

• expandCopy(rect: AnchoredRect): AnchoredRect

  Expand this Rect by given Rect. Immutable, returns modified copy.

  Parameters

  • rect: AnchoredRect

    AnchoredRect to expand this instance with.

  Returns AnchoredRect

  • Expanded copy of this AnchoredRect.

expandInPlace

• expandInPlace(rect: AnchoredRect): AnchoredRect

  Expand this Rect by given Rect. Modifies this Rect.

  Parameters

  • rect: AnchoredRect

    AnchoredRect to expand this instance with.

  Returns AnchoredRect

  • This AnchoredRect instance.

getRect

• getRect(): AnchoredRect

  Get this AnchoredRect instance.

  Returns AnchoredRect

  • This AnchoredRect instance.

offsetCopy

• offsetCopy(dx: number, dy: number): AnchoredRect

  Move this rect by (dx, dy). Immutable, returns modified copy.

  Parameters

  • dx: number

    Offset amount in x-direction.

  • dy: number

    Offset amount in y-direction.

  Returns AnchoredRect

  • AnchoredRect copy with applied offset.

offsetInPlace

• offsetInPlace(dx: number, dy: number): AnchoredRect

  Move this rect by (dx, dy). Modifies this Rect.

  Parameters

  • dx: number

    Offset amount in x-direction.

  • dy: number

    Offset amount in y-direction.

  Returns AnchoredRect

  • This AnchoredRect instance.

scaleCopy

• scaleCopy(scaleX: number, scaleY?: number): AnchoredRect

  Scale Rect. Anchor pos is (anchorX, anchorY). Immutable, returns modified copy.

  Parameters

  • scaleX: number

    Scale x-amount.

  • scaleY: number = scaleX

    Scale y-amount. If undefined then scale x-amount is used.

  Returns AnchoredRect

  Scaled copy of this AnchoredRect.

scaleInPlace

• scaleInPlace(scaleX: number, scaleY?: number): AnchoredRect

  Scale Rect. Anchor pos is (anchorX, anchorY). Modifies this Rect.

  Parameters

  • scaleX: number

    Scale x-amount.

  • scaleY: number = scaleX

    Scale y-amount. If undefined then scale x-amount is used.

  Returns AnchoredRect

  This AnchoredRect instance.

set

• set(): AnchoredRect

  Set rectangle with all zero values.

  Returns AnchoredRect

• set(left: number, right: number, top: number, bottom: number): AnchoredRect

  Set rectangle with left, right, top, bottom. Properties anchorX and anchorY will be centered in the middle.

  Parameters

  • left: number

    Left coordinate.

  • right: number

    Right coordinate.

  • top: number

    Top coordinate.

  • bottom: number

    Bottom coordinate.

  Returns AnchoredRect

• set(
      left: number,
      anchorX: number,
      right: number,
      top: number,
      anchorY: number,
      bottom: number,
  ): AnchoredRect

  Set rectangle with full arguments.

  Parameters

  • left: number

    Left coordinate.

  • anchorX: number

    Center x-coordinate.

  • right: number

    Right coordinate.

  • top: number

    Top coordinate.

  • anchorY: number

    Center y-coordinate.

  • bottom: number

    Bottom coordinate.

  Returns AnchoredRect

toRect

• toRect(): Rect

  Returns Rect

toString

• toString(): string

  Returns string

Staticcreate

• create(left: number, top: number, width: number, height: number): AnchoredRect

  Create rect from basic left, top, width and height arguments.

  Parameters

  • left: number

    Left coordinate.

  • top: number

    Top coordinate.

  • width: number

    Width.

  • height: number

    Height.

  Returns AnchoredRect

  • AnchoredRect.

StaticcreateCentered

• createCentered(
      centerX: number,
      centerY: number,
      width: number,
      height: number,
  ): AnchoredRect

  Create rect from anchorX, anchorY, width, height arguments.

  Parameters

  • centerX: number

    Center x-coordinate.

  • centerY: number

    Center y-coordinate.

  • width: number

    Width.

  • height: number

    Height.

  Returns AnchoredRect

  • AnchoredRect.

StaticcreateSections

• createSections(
      leftw: number,
      rightw: number,
      toph: number,
      bottomh: number,
  ): AnchoredRect

  Create rect from sections.

  Parameters

  • leftw: number

    Left section width.

  • rightw: number

    Right section width.

  • toph: number

    Top section height.

  • bottomh: number

    Bottomsection height.

  Returns AnchoredRect

  • AnchoredRect.

Staticequals

• equals(
      a: AnchoredRect | null | undefined,
      b: AnchoredRect | null | undefined,
  ): boolean

  Check if given rects are equal.

  Parameters

  • a: AnchoredRect | null | undefined

    AnchoredRect a.

  • b: AnchoredRect | null | undefined

    AnchoredRect b.

  Returns boolean

  • True/false.

StaticequalsEdges

• equalsEdges(
      a: AnchoredRect | null | undefined,
      b: AnchoredRect | null | undefined,
  ): boolean

  Check if edges of given rects are equal, ignoring anchorX and anchorY.

  Parameters

  • a: AnchoredRect | null | undefined

    AnchoredRect a.

  • b: AnchoredRect | null | undefined

    AnchoredRect b.

  Returns boolean

  • True/false.

Staticoverlap

• overlap(a: AnchoredRect, b: AnchoredRect): boolean

  Do a and b rects overlap?

  Parameters

  • a: AnchoredRect

    AnchoredRect a.

  • b: AnchoredRect

    AnchoredRect b.

  Returns boolean

  • True/false.

StaticoverlapX

• overlapX(a: AnchoredRect, b: AnchoredRect): boolean

  Do horizontal measures of a and b rects overlap?

  Parameters

  • a: AnchoredRect

    AnchoredRect a.

  • b: AnchoredRect

    AnchoredRect b.

  Returns boolean

  • True/false.