Class ImageRectangle

Tile image rectangle with integer dimensions

Hierarchy

ImageRectangle

Index

Constructors

Methods

equals getBottom getLeft getRight getTop isValid isValidAllowEmpty round

Constructors

constructor

new ImageRectangle(left: number, top: number, right: number, bottom: number): ImageRectangle
Constructor
Parameters
- left: number
  
  left pixel
- top: number
  
  top pixel
- right: number
  
  right pixel
- bottom: number
  
  bottom pixel
Returns ImageRectangle
- Defined in lib/tiles/imageRectangle.ts:32

Methods

equals

equals(obj: ImageRectangle): boolean
Inherit Doc
Parameters
- obj: ImageRectangle
Returns boolean
- Defined in lib/tiles/imageRectangle.ts:103

getBottom

getBottom(): number
Get the bottom

Returns
bottom

Returns number
- Defined in lib/tiles/imageRectangle.ts:67

getLeft

getLeft(): number
Get the left

Returns
left

Returns number
- Defined in lib/tiles/imageRectangle.ts:43

getRight

getRight(): number
Get the right

Returns
right

Returns number
- Defined in lib/tiles/imageRectangle.ts:51

getTop

getTop(): number
Get the top

Returns
top

Returns number
- Defined in lib/tiles/imageRectangle.ts:59

isValid

isValid(): boolean
Check if the rectangle is valid

Returns
true if valid

Returns boolean
- Defined in lib/tiles/imageRectangle.ts:75

isValidAllowEmpty

isValidAllowEmpty(): boolean
Check if the rectangle is valid allowing empty ranges

Returns
valid

Returns boolean
- Defined in lib/tiles/imageRectangle.ts:83

round

round(): ImageRectangle
Round the floating point rectangle to an integer rectangle

Returns
image rectangle

Returns ImageRectangle
- Defined in lib/tiles/imageRectangle.ts:91

Generated using TypeDoc