maxrects-packer

maxrects-packer / OversizedElementBin

Class: OversizedElementBin<T> ​

Defined in: oversized-element-bin.ts:5

Extends ​

Type Parameters ​

T ​

T extends IRectangleInput = IRectangleInput

Constructors ​

Constructor ​

new OversizedElementBin<T>(rect): OversizedElementBin<T>

Defined in: oversized-element-bin.ts:20

Build a placeholder bin around an existing rect: the rect is kept as-is, flagged oversized, and its data becomes the bin's data.

Parameters ​

rect ​

T

the rect to hold, which must be an object

Returns ​

OversizedElementBin<T>

Overrides ​

Bin.constructor

Constructor ​

new OversizedElementBin<T>(width, height, data?): OversizedElementBin<T>

Defined in: oversized-element-bin.ts:29

Build a placeholder bin for an element that does not exist as a rect yet.

Parameters ​

width ​

number

width of the element

height ​

number

height of the element

data? ​

any

data attached to the element; optional, because the runtime has always accepted a two-argument construction and the bin then reports data: null while its rect keeps {}. An explicitly supplied value, including null, is kept on both the bin and its rect.

Returns ​

OversizedElementBin<T>

Overrides ​

Bin<T>.constructor

Properties ​

_dirty ​

protected _dirty: number = 0

Defined in: abstract-bin.ts:31

Inherited from ​

Bin._dirty

data ​

data: any

Defined in: oversized-element-bin.ts:8

Overrides ​

Bin.data

freeRects ​

freeRects: IRectangle[]

Defined in: oversized-element-bin.ts:13

Overrides ​

Bin.freeRects

height ​

height: number

Defined in: oversized-element-bin.ts:7

Overrides ​

Bin.height

maxHeight ​

maxHeight: number

Defined in: oversized-element-bin.ts:10

Overrides ​

Bin.maxHeight

maxWidth ​

maxWidth: number

Defined in: oversized-element-bin.ts:9

Overrides ​

Bin.maxWidth

options ​

options: IOption

Defined in: oversized-element-bin.ts:11

Overrides ​

Bin.options

rects ​

rects: T[] = []

Defined in: oversized-element-bin.ts:12

Overrides ​

Bin.rects

tag? ​

optional tag?: string

Defined in: abstract-bin.ts:29

Inherited from ​

Bin.tag

width ​

width: number

Defined in: oversized-element-bin.ts:6

Overrides ​

Bin.width

Accessors ​

dirty ​

Get Signature ​

get dirty(): boolean

Defined in: abstract-bin.ts:32

Returns ​

boolean

Inherited from ​

Bin.dirty

Methods ​

add() ​

add(): undefined

Defined in: oversized-element-bin.ts:59

Returns ​

undefined

Overrides ​

Bin.add

clone() ​

clone(): Bin<T>

Defined in: oversized-element-bin.ts:78

Copy this placeholder's rect, free rectangles, dimensions, maxima, options, tag and bin data. The rect and free rectangles use Rectangle.Clone, and options are copied, so changing them leaves the source alone. Payloads in rect.data and bin data remain shared (a shallow copy), and a rect class that cannot be copied that way reports it from there. The copy still refuses additions, even when it carries free space restored by load().

Returns ​

Bin<T>

a placeholder holding a copy of the same rect and restored state; bin data is kept separately from rect data, including null from a two-argument construction

Overrides ​

Bin.clone

repack() ​

repack(): T[] | undefined

Defined in: oversized-element-bin.ts:65

Returns ​

T[] | undefined

Overrides ​

Bin.repack

reset() ​

reset(_deepReset?): void

Defined in: oversized-element-bin.ts:62

Parameters ​

_deepReset? ​

boolean = false

Returns ​

void

Overrides ​

Bin.reset

setDirty() ​

setDirty(value?): void

Defined in: abstract-bin.ts:38

Set bin dirty status

Parameters ​

value? ​

boolean = true

Returns ​

void

Inherited from ​

Bin.setDirty