Class TweakpaneEditorPlugin

Hierarchy

AViewerPluginSync<string>
- TweakpaneEditorPlugin

Index

Constructors

Constructors

constructor

new TweakpaneEditorPlugin(): TweakpaneEditorPlugin
Returns TweakpaneEditorPlugin
Overrides AViewerPluginSync<string>.constructor
- Defined in plugins/tweakpane-editor/src/TweakpaneEditorPlugin.ts:24

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

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

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: (typeof FullScreenPlugin | typeof TweakpaneUiPlugin)[] = ...

enabled

enabled: boolean = true

modeDivs

modeDivs: (undefined | HTMLDivElement)[] = []

modeKeys

modeKeys: string[] = []

modePlugins

modePlugins: Class<IViewerPlugin>[][] = []

`Optional`uiConfig

uiConfig?: UiObjectConfig = undefined

`Optional`uiPlugin

uiPlugin?: TweakpaneUiPlugin

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: string = 'TweakpaneEditorPlugin'

Accessors

dirty

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

disable

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

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:29

enable

enable(key: any): 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: ISerializedConfig,
meta?: SerializationMetaType,
): null | TweakpaneEditorPlugin | Promise<null | TweakpaneEditorPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | TweakpaneEditorPlugin | Promise<null | TweakpaneEditorPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:41

importState

importState(state: any): 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

loadPlugins

loadPlugins(plugins?: Record<string, Class<IViewerPlugin<any>>[]>): void
Parameters
- plugins: Record<string, Class<IViewerPlugin<any>>[]> = {}
Returns void
- Defined in plugins/tweakpane-editor/src/TweakpaneEditorPlugin.ts:50

onAdded

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

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onRemove
- Defined in src/viewer/AViewerPlugin.ts:145

`Optional`setDirty

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

setSelectedMode

setSelectedMode(mode: number): void
Parameters
- mode: number
Returns void
- Defined in plugins/tweakpane-editor/src/TweakpaneEditorPlugin.ts:84

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:33

Class TweakpaneEditorPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TweakpaneEditorPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

modeDivs

modeKeys

modePlugins

OptionaluiConfig

OptionaluiPlugin

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | TweakpaneEditorPlugin | Promise<null | TweakpaneEditorPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

loadPlugins

Parameters

Returns void

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

setSelectedMode

Parameters

Returns void

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Optional`uiPlugin

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty