Class HierarchyUiPlugin

Hierarchy

AViewerPluginSync
- HierarchyUiPlugin

Index

Constructors

Properties

_dirty _needsReset _viewer? _viewerListeners constructor enabled hierarchyDiv toJSON treeView? uiConfig undoManager? OldPluginType? PluginType

Accessors

Methods

_onViewerEvent _postFrame _reset _storeKey disable dispose enable exportState fromJSON importState isDisabled onAdded onRemove reset setDirty?

Constructors

constructor

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

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected`_needsReset

_needsReset: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

hierarchyDiv

hierarchyDiv: HTMLDivElement = ...

toJSON

toJSON: any = undefined

`Optional`treeView

treeView?: Tree = undefined

uiConfig

uiConfig: UiObjectConfig = ...

`Optional`undoManager

undoManager?: JSUndoManager = undefined

`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:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

Methods

`Protected`_onViewerEvent

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

`Protected`_postFrame

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

`Protected`_reset

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

`Protected`_storeKey

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

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:75

dispose

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

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:80

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

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

onRemove

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

reset

reset(
    e?: Event2<
        "sceneUpdate",
        ISceneEventMap,
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
    >,
): void
Parameters
- Optionale: Event2<
      "sceneUpdate",
      ISceneEventMap,
      IObject3D<
          IObject3DEventMap,
          undefined
          | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
          undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
      >,
  >
Returns void
- Defined in plugins/tweakpane-editor/src/HierarchyUiPlugin.ts:85

`Optional`setDirty

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