Class Rect

Hierarchy

Box
- Rect

Implements

IRect

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Rect(x: number, y: number, width: number, height: number, allowNegativeDimensions?: boolean): Rect

Overrides Box.constructor
- Defined in classes/Rect.ts:11
Parameters
- x: number
- y: number
- width: number
- height: number
- allowNegativeDimensions: boolean = false
Returns Rect

Accessors

area

get area(): number

Inherited from Box.area
- Defined in classes/Box.ts:70
Returns number

bottom

get bottom(): number

Inherited from Box.bottom
- Defined in classes/Box.ts:68
Returns number

bottomLeft

get bottomLeft(): Point

Inherited from Box.bottomLeft
- Defined in classes/Box.ts:76
Returns Point

bottomRight

get bottomRight(): Point

Inherited from Box.bottomRight
- Defined in classes/Box.ts:78
Returns Point

height

get height(): number

Implementation of IRect.height
Inherited from Box.height
- Defined in classes/Box.ts:60
Returns number

left

get left(): number

Inherited from Box.left
- Defined in classes/Box.ts:62
Returns number

right

get right(): number

Inherited from Box.right
- Defined in classes/Box.ts:66
Returns number

top

get top(): number

Inherited from Box.top
- Defined in classes/Box.ts:64
Returns number

topLeft

get topLeft(): Point

Inherited from Box.topLeft
- Defined in classes/Box.ts:72
Returns Point

topRight

get topRight(): Point

Inherited from Box.topRight
- Defined in classes/Box.ts:74
Returns Point

width

get width(): number

Implementation of IRect.width
Inherited from Box.width
- Defined in classes/Box.ts:58
Returns number

x

get x(): number

Implementation of IRect.x
Inherited from Box.x
- Defined in classes/Box.ts:54
Returns number

y

get y(): number

Implementation of IRect.y
Inherited from Box.y
- Defined in classes/Box.ts:56
Returns number

Methods

calibrate

calibrate(region: Box<any>): Box<any>

Inherited from Box.calibrate
- Defined in classes/Box.ts:197
Parameters
- region: Box<any>
Returns Box<any>

clipAtImageBorders

clipAtImageBorders(imgWidth: number, imgHeight: number): Box<any>

Inherited from Box.clipAtImageBorders
- Defined in classes/Box.ts:136
Parameters
- imgWidth: number
- imgHeight: number
Returns Box<any>

floor

floor(): Box<any>

Inherited from Box.floor
- Defined in classes/Box.ts:88
Returns Box<any>

pad

pad(padX: number, padY: number): Box<any>

Inherited from Box.pad
- Defined in classes/Box.ts:124
Parameters
- padX: number
- padY: number
Returns Box<any>

padAtBorders

padAtBorders(imageHeight: number, imageWidth: number): { dx: number; dy: number; edx: number; edy: number; ex: number; ey: number; h: number; w: number; x: number; y: number }

Inherited from Box.padAtBorders
- Defined in classes/Box.ts:161
Parameters
- imageHeight: number
- imageWidth: number
Returns { dx: number; dy: number; edx: number; edy: number; ex: number; ey: number; h: number; w: number; x: number; y: number }
- dx: number
- dy: number
- edx: number
- edy: number
- ex: number
- ey: number
- h: number
- w: number
- x: number
- y: number

rescale

rescale(s: number | IDimensions): Box<any>

Inherited from Box.rescale
- Defined in classes/Box.ts:113
Parameters
- s: number | IDimensions
Returns Box<any>

round

round(): Box<any>

Inherited from Box.round
- Defined in classes/Box.ts:80
Returns Box<any>

shift

shift(sx: number, sy: number): Box<any>

Inherited from Box.shift
- Defined in classes/Box.ts:151
Parameters
- sx: number
- sy: number
Returns Box<any>

toSquare

toSquare(): Box<any>

Inherited from Box.toSquare
- Defined in classes/Box.ts:96
Returns Box<any>

Static assertIsValidBox

assertIsValidBox(box: any, callee: string, allowNegativeDimensions?: boolean): void

Inherited from Box.assertIsValidBox
- Defined in classes/Box.ts:12
Parameters
- box: any
- callee: string
- allowNegativeDimensions: boolean = false
Returns void

Static isRect

isRect(rect: any): boolean

Inherited from Box.isRect
- Defined in classes/Box.ts:8
Parameters
- rect: any
Returns boolean