Interface: GenericUiViewProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:24

Component props for GenericUiView.

Extends

• UiViewProps

Properties

children?

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from

UiViewProps.children

---

containerRef

containerRef: NodeReference<HTMLElement>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:18

A reference to the root element of the view's container.

Inherited from

UiViewProps.containerRef

---

createFocusController()?

optional createFocusController: () => UiFocusController

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:29

A function which creates the view's UI focus controller. If not defined, then a default focus controller will be created.

Returns

UiFocusController

---

onAfterRender()?

optional onAfterRender: (thisNode, members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:32

A function which is called after the view is rendered.

Parameters

Parameter	Type
thisNode	VNode
members	GenericUiViewMembers

Returns

void

---

onClose()?

optional onClose: (members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:38

A function which is called when the view is closed.

Parameters

Parameter	Type
members	GenericUiViewMembers

Returns

void

---

onDestroy()?

optional onDestroy: () => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:62

A function which is called when the view is destroyed.

Returns

void

---

onOcclusionChange()?

optional onOcclusionChange: (occlusionType, members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:50

A function which is called when the occlusion type applied to the view changes while the view is open.

Parameters

Parameter	Type
occlusionType	UiViewOcclusionType
members	GenericUiViewMembers

Returns

void

---

onOpen()?

optional onOpen: (sizeMode, dimensions, members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:35

A function which is called when the view is opened.

Parameters

Parameter	Type
sizeMode	UiViewSizeMode
dimensions	ReadonlyFloat64Array
members	GenericUiViewMembers

Returns

void

---

onPause()?

optional onPause: (members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:44

A function which is called when the view is paused.

Parameters

Parameter	Type
members	GenericUiViewMembers

Returns

void

---

onResize()?

optional onResize: (sizeMode, dimensions, members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:47

A function which is called when the view is resized while it is open.

Parameters

Parameter	Type
sizeMode	UiViewSizeMode
dimensions	ReadonlyFloat64Array
members	GenericUiViewMembers

Returns

void

---

onResume()?

optional onResume: (members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:41

A function which is called when the view is resumed.

Parameters

Parameter	Type
members	GenericUiViewMembers

Returns

void

---

onUiInteractionEvent()?

optional onUiInteractionEvent: (event, members) => boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:59

A function which handles interaction events routed to the view. If not defined, then the view will delegate interaction event handling to its UI focus controller.

Parameters

Parameter	Type
event	UiInteractionEvent
members	GenericUiViewMembers

Returns

boolean

---

onUpdate()?

optional onUpdate: (time, members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiView.tsx:53

A function which is called every update cycle.

Parameters

Parameter	Type
time	number
members	GenericUiViewMembers

Returns

void

---

ref?

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from

UiViewProps.ref

---

uiService

uiService: UiService

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:15

The UI service instance.

Inherited from

UiViewProps.uiService