Class TweakpaneEditorPlugin

Hierarchy

AViewerPluginSync<string>
- TweakpaneEditorPlugin

Index

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

`Private` _selectedMode

_selectedMode: number = 0

`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

dependencies

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

enabled

enabled: boolean = true

modeDivs

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

modeKeys

modeKeys: string[] = []

modePlugins

modePlugins: Class<IViewerPlugin<ThreeViewer, boolean>>[][] = []

`Optional` uiConfig

uiConfig?: UiObjectConfig<any, string, any> = 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): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

Methods

`Protected` _onViewerEvent

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

`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
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:29

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 | TweakpaneEditorPlugin | Promise<null | TweakpaneEditorPlugin>
Parameters
- data: ISerializedConfig
- Optional meta: SerializationMetaType
Returns null | TweakpaneEditorPlugin | Promise<null | TweakpaneEditorPlugin>
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

loadPlugins

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

onAdded

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

onRemove

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

`Optional` setDirty

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

setSelectedMode

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

toJSON

toJSON(meta?): ISerializedConfig
Parameters
- Optional meta: 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

Private _selectedMode

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

dependencies

enabled

modeDivs

modeKeys

modePlugins

Optional uiConfig

Optional uiPlugin

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

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 | TweakpaneEditorPlugin | Promise<null | TweakpaneEditorPlugin>

importState

Parameters

state: any

Returns Promise<void>

isDisabled

Returns boolean

loadPlugins

Parameters

plugins: Record<string, Class<IViewerPlugin<any, boolean>>[]> = {}

Returns void

onAdded

Parameters

viewer: ThreeViewer

Returns void

onRemove

Parameters

viewer: ThreeViewer

Returns void

Optional setDirty

`Protected` _dirty

`Private` _selectedMode

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` uiConfig

`Optional` uiPlugin

`Static` `Optional` `Readonly` OldPluginType

`Static` `Readonly` PluginType

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: SerializationMetaType

`Optional` setDirty

`Rest` ...args: any[]

`Optional` meta: SerializationMetaType