Class Region

constructor

• new Region(origin: Point, size: Size): Region

  Parameters

  • origin: Point
  • size: Size

  Returns Region

Readonlyorigin

Readonlysize

StaticfromStartEnd

• fromStartEnd(start: Point, end: Point): Region

  Creates a region from corners. If a start coordinate isn't greater than its corresponding end coordinate, the position on that axis will be the start coordinate, and the size will be zero.

  Parameters

  • start: Point
  • end: Point

  Returns Region

subregion

• subregion(sub: Region, clipped?: boolean): Region

  Cuts out a part of this with a region in local coordinates.

  Parameters

  • sub: Region
  • clipped: boolean = true

  Returns Region

hsplit

• hsplit(startFac: number, endFac: number): Region

  Extracts a vertical column from this region by specifying the start and end of it along the width, ranging from 0 to 1.

  Parameters

  • startFac: number
  • endFac: number

  Returns Region

vsplit

• vsplit(startFac: number, endFac: number): Region

  Extracts a horizontal column from this region by specifying the start and end of it along the height, ranging from 0 to 1.

  Parameters

  • startFac: number
  • endFac: number

  Returns Region

clippedBy

• clippedBy(clip: Region): Region

  Creates a new region that doesn't extend outside the given one.

  Parameters

  • clip: Region

  Returns Region

applyToAll

• applyToAll(fn: (arg0: number) => number): Region

  Creates a new region by applying a function to all parameters of this.

  Parameters

  • fn: (arg0: number) => number

  Returns Region

applyToPosition

• applyToPosition(fn: (arg0: number) => number): Region

  Creates a new region by applying a function to the position of this.

  Parameters

  • fn: (arg0: number) => number

  Returns Region

applyToSize

• applyToSize(fn: (arg0: number) => number): Region

  Creates a new region by applying a function to the size of this.

  Parameters

  • fn: (arg0: number) => number

  Returns Region

offset

• offset(offset: Vector): Region

  Creates a new region with the same size as this, but with the origin offset by some vector.

  Parameters

  • offset: Vector

  Returns Region