Class Object3DWidgetsPlugin

Automatically creates and manages helper widgets for lights, cameras, lines, and skeletons. Custom widget types can be registered via the helpers array. See https://threepipe.org/notes/widgets-and-helpers for the full widget system documentation.

Hierarchy (View Summary)

AViewerPluginSync
- Object3DWidgetsPlugin

Index

Constructors

constructor

new Object3DWidgetsPlugin(
enabled?: boolean,
inSceneRoot?: boolean,
): Object3DWidgetsPlugin
Parameters
- enabled: boolean = true
- inSceneRoot: boolean = false
Returns Object3DWidgetsPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:49

Properties

`Protected`_dirty

_dirty: 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

helpers

helpers: IObject3DHelper<IWidget>[] = ...

inSceneRoot

inSceneRoot: boolean = false

isViewerPluginSync

isViewerPluginSync: true = ...

toJSON

toJSON: any = null

uiConfig

uiConfig: UiObjectConfig = ...

widgets

widgets: IWidget[] = []

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "Object3DWidgetsPlugin" = 'Object3DWidgetsPlugin'

Accessors

dirty

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

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:76

dispose

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

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:81

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:59

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:72

refreshObject

refreshObject(
    object?: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >,
): void
Parameters
- Optionalobject: IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >
Returns void
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:83

setDirty

setDirty(): void
Returns void
Overrides AViewerPluginSync.setDirty
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:41

Class Object3DWidgetsPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Object3DWidgetsPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

helpers

inSceneRoot

isViewerPluginSync

toJSON

uiConfig

widgets

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

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

refreshObject

Parameters

Returns void

setDirty

Returns void

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey