UICanvas

Enhanced PIXI Container that has: a factory for adding children, a reference to the Application instance, a signal connection manager, and auto update / resize capabilities Container

Extends

Container

Constructors

new UICanvas()

new UICanvas(settings): UICanvas

Parameters

• settings: Partial<UICanvasProps>= undefined

Properties

childrenEditable

childrenEditable: boolean = true

Inherited from

Container.childrenEditable

Source

src/gameobjects/Container.ts:22

editable

editable: boolean = true

Inherited from

Container.editable

Source

src/gameobjects/Container.ts:21

__dill_pixel_top_level_class

static __dill_pixel_top_level_class: boolean = true

Inherited from

Container.__dill_pixel_top_level_class

Source

src/gameobjects/Container.ts:20

Accessors

add

get add(): Add

Returns

Add

Source

src/gameobjects/Container.ts:120

app

get app(): T

Returns

T

Source

src/gameobjects/Container.ts:128

bounds

get bounds(): Bounds

Returns

Bounds

Source

src/ui/UICanvas.ts:90

canvasChildren

get canvasChildren(): DisplayObject[]

Returns

DisplayObject[]

Source

src/ui/UICanvas.ts:86

editMode

get editMode(): boolean

set editMode(value): void

Parameters

• value: boolean

Returns

boolean

Source

src/gameobjects/Container.ts:107

focusPosition

get focusPosition(): Point

set focusPosition(value): void

Parameters

• value: Point

Returns

Point

Source

src/gameobjects/Container.ts:83

focusSize

get focusSize(): Point

set focusSize(value): void

Parameters

• value: Point

Returns

Point

Source

src/gameobjects/Container.ts:91

focusable

get focusable(): boolean

set focusable(value): void

Parameters

• value: boolean

Returns

boolean

Source

src/gameobjects/Container.ts:99

make

get make(): typeof Make

Returns

typeof Make

Source

src/gameobjects/Container.ts:124

padding

set padding(value): void

Parameters

• value: number | Partial<UICanvasPadding> | object

Source

src/ui/UICanvas.ts:100

size

set size(value): void

Parameters

• value: PointLike

Source

src/ui/UICanvas.ts:94

useAsCaptionTarget

get useAsCaptionTarget(): boolean

set useAsCaptionTarget(value): void

Parameters

• value: boolean

Returns

boolean

Source

src/gameobjects/Container.ts:61

voiceover

get voiceover(): string

set voiceover(value): void

Parameters

• value: string

Returns

string

Source

src/gameobjects/Container.ts:69

Methods

addChild()

addChild<U>(…children): U[0]

Type parameters

• U extends DisplayObject[]

Parameters

• …children: DisplayObject[]

Returns

U[0]

Overrides

Container.addChild

Source

src/ui/UICanvas.ts:119

addChildAt()

addChildAt<U>(child, index): U

Adds a child to the container at the specified index Override because we need to ensure it sets the child index properly

Type parameters

• U extends DisplayObject = DisplayObject

Parameters

• child: DisplayObject

• index: number

Returns

U

Overrides

Container.addChildAt

Source

src/ui/UICanvas.ts:174

addElement()

addElement<U>(child, settings?): U

Type parameters

• U extends Container<DisplayObject> = Container<DisplayObject>

Parameters

• child: Container<DisplayObject>

• settings?: Partial<UICanvasChildSettings>

Returns

U

Source

src/ui/UICanvas.ts:233

destroy()

destroy(_options?): void

Parameters

• _options?: boolean | IDestroyOptions

Returns

void

Inherited from

Container.destroy

Source

src/gameobjects/Container.ts:132

disableEditMode()

disableEditMode(): void

Returns

void

Inherited from

Container.disableEditMode

Source

src/gameobjects/Container.ts:173

enableEditMode()

enableEditMode(): void

Returns

void

Inherited from

Container.enableEditMode

Source

src/gameobjects/Container.ts:169

getChildAt()

getChildAt(index): DisplayObject

Gets the child at the specified index Override due to re-parenting

Parameters

• index: number

Returns

DisplayObject

Overrides

Container.getChildAt

Source

src/ui/UICanvas.ts:219

getChildIndex()

getChildIndex(child): number

Gets the index of a child in the container Override because we need to ensure it targets the parent container that we added

Parameters

• child: DisplayObject

Returns

number

Overrides

Container.getChildIndex

Source

src/ui/UICanvas.ts:206

getFocusPosition()

getFocusPosition(): Point

Gets the position in global coordinate space that the focus should be centred around.

Returns

Point

The position that the focus should be centred around.

Inherited from

Container.getFocusPosition

Source

src/gameobjects/Container.ts:157

getFocusSize()

getFocusSize(): IPoint

Gets the size of the area in global coordinate space that the focus should surround.

Returns

IPoint

The size of the area that the focus should surround.

Inherited from

Container.getFocusSize

Source

src/gameobjects/Container.ts:161

isFocusable()

isFocusable(): boolean

Returns

boolean

true if this focusable can be focused Defaults to this.interactive && this.worldVisible

Inherited from

Container.isFocusable

Source

src/gameobjects/Container.ts:165

layout()

layout(): void

Returns

void

Source

src/ui/UICanvas.ts:223

onFocusActivated()

onFocusActivated(): void

Called when this Focusable is focussed and then activated.

Returns

void

Inherited from

Container.onFocusActivated

Source

src/gameobjects/Container.ts:155

onFocusBegin()

onFocusBegin(): void

Called when this Focusable is focussed.

Returns

void

Inherited from

Container.onFocusBegin

Source

src/gameobjects/Container.ts:143

onFocusEnd()

onFocusEnd(): void

Called when this Focusable is no longer focussed.

Returns

void

Inherited from

Container.onFocusEnd

Source

src/gameobjects/Container.ts:149

onResize()

onResize(): void

Returns

void

Overrides

Container.onResize

Source

src/ui/UICanvas.ts:105

reAlign()

reAlign(child, settings): void

Parameters

• child: Container<DisplayObject>

• settings: UICanvasEdge | Partial<UICanvasChildSettings>

Returns

void

Source

src/ui/UICanvas.ts:263

removeChild()

removeChild(…children): DisplayObject

Removes one or more children from the container Override because we need to ensure it returns the proper re-parented children

Parameters

• …children: DisplayObject[]

Returns

DisplayObject

Overrides

Container.removeChild

Source

src/ui/UICanvas.ts:153

removeChildAt()

removeChildAt(index): DisplayObject

Removes a child from the container at the specified index Override because we need to remove from the inner container

Parameters

• index: number

Returns

DisplayObject

Overrides

Container.removeChildAt

Source

src/ui/UICanvas.ts:132

removeChildren()

removeChildren(): DisplayObject[]

Removes all the children from the container Override because we need to ensure it returns the proper re-parented children

Returns

DisplayObject[]

Overrides

Container.removeChildren

Source

src/ui/UICanvas.ts:141

setChildIndex()

setChildIndex(child, index): void

Sets the index of the child in the container Override because we need to ensure it targets the parent container that we added

Parameters

• child: DisplayObject

• index: number

Returns

void

Overrides

Container.setChildIndex

Source

src/ui/UICanvas.ts:190

update()

update(): void

Returns

void

Overrides

Container.update

Source

src/ui/UICanvas.ts:113