Namespace: Ui
Namespace: Ui
Functions and objects to append viewer UI.
Interfaces
Type Aliases
ChangedMetaTreeCallback
Ƭ ChangedMetaTreeCallback: (event: { elNums: number[] }) => void
Callback function for Visibility and State Changed MetaTree event.
Type declaration
▸ (event): void
Parameters
| Name | Type |
|---|---|
event | Object |
event.elNums | number[] |
Returns
void
NodeContextMenuCallback
Ƭ NodeContextMenuCallback: (event: { node: NodeBase ; originalEvent: MouseEvent }) => void
Callback function for node context menu event.
Type declaration
▸ (event): void
Parameters
| Name | Type |
|---|---|
event | Object |
event.node | NodeBase |
event.originalEvent | MouseEvent |
Returns
void
SelectedMetaTreeCallback
Ƭ SelectedMetaTreeCallback: (event: { elNums: number[] }) => void
Callback function for Selected MetaTree event.
Type declaration
▸ (event): void
Parameters
| Name | Type |
|---|---|
event | Object |
event.elNums | number[] |
Returns
void
Functions
appendMetaTree
▸ appendMetaTree(container, metaManager, renderManager?, filterCallback?, events?): MetaTreeContext
Appends MetaTree UI component inside DOM container.
Parameters
| Name | Type | Description |
|---|---|---|
container | string | HTMLElement | Container element or element id. |
metaManager | MetaManager | MetaManager instance. |
renderManager? | RenderManagerBase | Optional RenderManagerBase instance. If presented then meta tree component will interact with RenderManager and SceneManager. |
filterCallback? | (node: NodeBase) => boolean | - |
events? | Object | Object for setting event callbacks for meta tree UI component. |
events.nodeContextMenu? | NodeContextMenuCallback | - |
events.selected? | SelectedMetaTreeCallback | - |
events.visibility? | ChangedMetaTreeCallback | - |
Returns
- MetaTreeContext instance.
appendPropsTree
▸ appendPropsTree(container, metaManager): PropsTreeContext
Appends PropsTree UI component inside DOM container.
Parameters
| Name | Type | Description |
|---|---|---|
container | string | HTMLElement | Container element or element id. |
metaManager | MetaManager | MetaManager instance. |
Returns
- PropsTreeContext instance.
setI18next
▸ setI18next(i18n?): void
Init multilingual locales system and set i18n object.
Parameters
| Name | Type | Description |
|---|---|---|
i18n? | i18n | Exist i18next object. If no object is presented, the function will create its own object. |
Returns
void