Search

Search something to see results

MaxRectsBin

Type Parameters

Hierarchy (View Summary)

Index

Constructors

MaxRectsBin.constructor

Properties

MaxRectsBin._dirtyMaxRectsBin.borderMaxRectsBin.dataMaxRectsBin.freeRectsMaxRectsBin.heightMaxRectsBin.maxHeightMaxRectsBin.maxWidthMaxRectsBin.optionsMaxRectsBin.paddingMaxRectsBin.rectsMaxRectsBin.stageMaxRectsBin.tagMaxRectsBin.verticalExpandMaxRectsBin.width

Accessors

MaxRectsBin.dirty

Methods

MaxRectsBin.addMaxRectsBin.cloneMaxRectsBin.expandFreeRectsMaxRectsBin.findNodeMaxRectsBin.placeMaxRectsBin.pruneFreeListMaxRectsBin.repackMaxRectsBin.resetMaxRectsBin.setDirtyMaxRectsBin.splitNodeMaxRectsBin.updateBinSize

Constructors

new MaxRectsBin<T extends IRectangle = Rectangle>(
    maxWidth?: number,
    maxHeight?: number,
    padding?: number,
    options?: IOption,
): MaxRectsBin<T>

Type Parameters

Parameters

  • maxWidth: number = EDGE_MAX_VALUE
  • maxHeight: number = EDGE_MAX_VALUE
  • padding: number = 0
  • options: IOption = {}

Returns MaxRectsBin<T>

Properties

Protected_dirty

_dirty: number = 0
border: number
data?: any
freeRects: Rectangle[] = []
height: number
maxHeight: number = EDGE_MAX_VALUE
maxWidth: number = EDGE_MAX_VALUE
options: IOption = ...
padding: number = 0
rects: T[] = []
stage: Rectangle
tag?: string
verticalExpand: boolean = false
width: number

Accessors

Methods

add(rect: T): undefined | T

Parameters

  • rect: T

Returns undefined | T

add(width: number, height: number, data: any): undefined | T

Parameters

  • width: number
  • height: number
  • data: any

Returns undefined | T

clone(): MaxRectsBin<T>

Returns MaxRectsBin<T>

expandFreeRects(width: number, height: number): void

Parameters

  • width: number
  • height: number

Returns void

findNode(
    width: number,
    height: number,
    allowRotation?: boolean,
): undefined | Rectangle

Find the best rect out of freeRects This method has different logics to resolve the best rect.

Parameters

  • width: number
  • height: number
  • OptionalallowRotation: boolean

Returns undefined | Rectangle

Rectangle of the best rect for placement

place(rect: IRectangle): undefined | T

Parameters

Returns undefined | T

pruneFreeList(): void

Returns void

repack(): undefined | T[]

Returns undefined | T[]

reset(deepReset?: boolean, resetOption?: boolean): void

Parameters

  • deepReset: boolean = false
  • resetOption: boolean = false

Returns void

setDirty(value?: boolean): void

Set bin dirty status

Parameters

  • value: boolean = true

Returns void

splitNode(freeRect: IRectangle, usedNode: IRectangle): boolean

Parameters

Returns boolean

updateBinSize(node: IRectangle): boolean

Parameters

Returns boolean