Class HierarchyUiPlugin

Hierarchy

AViewerPluginSync<"">
- HierarchyUiPlugin

Index

Constructors

constructor

new HierarchyUiPlugin(enabled?): HierarchyUiPlugin
Parameters
- enabled: boolean = true
Returns HierarchyUiPlugin
Overrides AViewerPluginSync<''>.constructor
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:20

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` _needsReset

_needsReset: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"dispose" | "*" | "update" | "preRender" | "postRender" | "preFrame" | "postFrame" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

hierarchyDiv

hierarchyDiv: HTMLDivElement = ...

toJSON

toJSON: any = undefined

treeView

treeView: any = undefined

uiConfig

uiConfig: UiObjectConfig<any, string, any> = ...

`Static` `Optional` `Readonly` OldPluginType

OldPluginType?: string

`Static` `Readonly` PluginType

PluginType: "HierarchyUiPlugin" = 'HierarchyUiPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:107
set dirty(value): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

Methods

`Private` _buildData

_buildData(data, obj): any[]
Parameters
- data: any[]
- obj: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Returns any[]
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:114

`Private` _findVisible

_findVisible(data, obj): any[]
Parameters
- data: any[]
- obj: Object3D<Event, string>
Returns any[]
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:122

`Protected` _onViewerEvent

_onViewerEvent(e): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:63

`Protected` _postFrame

_postFrame(): void
Returns void
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:100

`Protected` _reset

_reset(): Promise<void>
Returns Promise<void>
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:46

`Private` _setVisible

_setVisible(values): void
Parameters
- values: string[]
Returns void
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:128

`Protected` _storeKey

_storeKey(prefix?): string
Parameters
- Optional prefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:49

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

dispose(): void
Returns void
Overrides AViewerPluginSync.dispose
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:104

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:54

fromJSON

fromJSON(data, meta?): null | HierarchyUiPlugin | Promise<null | HierarchyUiPlugin>
Parameters
- data: ISerializedConfig
- Optional meta: SerializationMetaType
Returns null | HierarchyUiPlugin | Promise<null | HierarchyUiPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:41

importState

importState(state): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:57

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:80

onAdded

onAdded(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:85

onRemove

onRemove(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:92

reset

reset(e?): void
Parameters
- Optional e: any
Returns void
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:41

`Optional` setDirty

setDirty(...args): any
Parameters
- Rest ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:84

Class HierarchyUiPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

enabled: boolean = true

Returns HierarchyUiPlugin

Properties

Protected _dirty

Protected _needsReset

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

enabled

hierarchyDiv

toJSON

treeView

uiConfig

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Private _buildData

Parameters

data: any[]

obj: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Returns any[]

Private _findVisible

Parameters

data: any[]

obj: Object3D<Event, string>

Returns any[]

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _postFrame

Returns void

Protected _reset

Returns Promise<void>

Private _setVisible

Parameters

values: string[]

Returns void

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

Parameters

key: any

Returns void

dispose

Returns void

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

Returns null | HierarchyUiPlugin | Promise<null | HierarchyUiPlugin>

importState

`Protected` _dirty

`Protected` _needsReset

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Static` `Optional` `Readonly` OldPluginType

`Static` `Readonly` PluginType

`Private` _buildData

`Private` _findVisible

`Protected` _onViewerEvent

`Protected` _postFrame

`Protected` _reset

`Private` _setVisible

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: SerializationMetaType

`Optional` e: any

`Optional` setDirty

`Rest` ...args: any[]