Class Bounds

Index

Constructors

Methods

clone compare extend extendWithPoint get set update

Constructors

constructor

new Bounds(
    x: number,
    y: number,
    w: number,
    h: number,
    twoPoints?: boolean,
): Bounds
simple data class containing the bounds of an object or region
Parameters
- x: number
  horizontal coordinate of upper left corner
- y: number
  vertical coordinate of upper left corner
- w: number
  width or horizontal offset of lower right corner
- h: number
  height or vertical offset of lower right corner
- OptionaltwoPoints: boolean
  when true, w and h are interpreted as absolute coordinates of lower right corner
Returns Bounds

Methods

clone

clone(): Bounds
clone the object

Returns Bounds

compare

compare(bounds: Bounds): boolean
compares this object to another instance
Parameters
- bounds: Bounds
Returns boolean

extend

extend(bounds: Bounds): void
modifies this structure by extending it with the specified bounds
Parameters
- bounds: Bounds
Returns void

extendWithPoint

extendWithPoint(x: number, y: number): void
modifies this structure by extending it with the specified point
Parameters
- x: number
- y: number
Returns void

get

get(value: "x" | "y" | "right" | "top" | "width" | "height"): number
returns value of requested config option
Parameters
- value: "x" | "y" | "right" | "top" | "width" | "height"
  name of the value
Returns number

set

set(
identifier: "x" | "y" | "right" | "top" | "width" | "height",
value: number,
): boolean
sets value of requested config option
Parameters
- identifier: "x" | "y" | "right" | "top" | "width" | "height"
  name of the value
- value: number
Returns boolean

update

update(x: number, y: number, w: number, h: number, twoPoints?: boolean): boolean
update the bounds rectangle returns true if the bounds changed, false if no update was required
Parameters
- x: number
  horizontal coordinate of upper left corner
- y: number
  vertical coordinate of upper left corner
- w: number
  width or horizontal offset of lower right corner
- h: number
  height or vertical offset of lower right corner
- OptionaltwoPoints: boolean
  when true, w and h are interpreted as absolute coordinates of lower right corner
Returns boolean