PixiUIBase
Defined in: ui/src/pixi-ui/PixiUIBase.ts:13
Abstract base class for wrapping @pixi/ui components as Yoga-aware UIElements.
Handles: Yoga node + measure function, prevProps storage, bridgeSignal helper, visible prop, applyLayout, and destroy cleanup.
Extended by
Section titled “Extended by”PixiFancyButtonPixiCheckboxPixiProgressBarPixiSliderPixiInputPixiScrollBoxPixiSelectPixiRadioGroup
Type Parameters
Section titled “Type Parameters”T extends DisplayContainer
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PixiUIBase<
T>(view,props):PixiUIBase<T>
Defined in: ui/src/pixi-ui/PixiUIBase.ts:32
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”PixiUIBase<T>
Properties
Section titled “Properties”prevProps
Section titled “prevProps”
protectedprevProps:Record<string,unknown> ={}
Defined in: ui/src/pixi-ui/PixiUIBase.ts:17
protectedreadonlyview:T
Defined in: ui/src/pixi-ui/PixiUIBase.ts:16
yogaNode
Section titled “yogaNode”
readonlyyogaNode:Node
Defined in: ui/src/pixi-ui/PixiUIBase.ts:15
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”displayObject
Section titled “displayObject”Get Signature
Section titled “Get Signature”get displayObject():
DisplayContainer
Defined in: ui/src/pixi-ui/PixiUIBase.ts:19
Returns
Section titled “Returns”DisplayContainer
Implementation of
Section titled “Implementation of”visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:23
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set visible(
v):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:27
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”applyLayout()
Section titled “applyLayout()”applyLayout():
void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:56
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”bridgeSignal()
Section titled “bridgeSignal()”
protectedbridgeSignal<F>(signal,key,newProps):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:62
Bridge a @pixi/ui Signal to a callback prop. Only reconnects if ref changed.
Type Parameters
Section titled “Type Parameters”F extends (…args) => void
Parameters
Section titled “Parameters”signal
Section titled “signal”connect
Section titled “connect”(cb) => void
disconnect
Section titled “disconnect”(cb) => void
string
newProps
Section titled “newProps”Record<string, unknown>
Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:84
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”disconnectAll()
Section titled “disconnectAll()”
abstractprotecteddisconnectAll():void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:91
Override in subclass to disconnect all signals on destroy.
Returns
Section titled “Returns”void
update()
Section titled “update()”
abstractupdate(props):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:82
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”updateBase()
Section titled “updateBase()”
protectedupdateBase(props):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:76
Apply layout props, visible, and store prevProps. Call at end of subclass update().
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”void