Class Object3DWidgetsPlugin

Adds light and camera helpers/gizmos in the viewer. A helper is automatically created when any supported light or camera is added to the scene.

Hierarchy (view full)

AViewerPluginSync<"">
- Object3DWidgetsPlugin

Index

Constructors

constructor

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

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

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

Type declaration

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

`Private` _widgetRoot

_widgetRoot: Object3D<Event, string> = ...

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

helpers

helpers: IObject3DHelper<Object3D<Event, string> & IWidget>[] = ...

toJSON

toJSON: any = null

uiConfig

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

widgets

widgets: (IWidget & Object3D<Event, string>)[] = []

`Static` `Readonly` PluginType

PluginType: "Object3DWidgetsPlugin" = 'Object3DWidgetsPlugin'

Accessors

dirty

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

Methods

`Private` _addSceneObject

_addSceneObject(e): void
Parameters
- e: any
Returns void
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:57

`Private` _createWidgets

_createWidgets(o?): void
Parameters
- Optional o: Object3D<Event, string>
Returns void
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:79

`Protected` _onViewerEvent

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

`Private` _registerWidget

_registerWidget(w): void
Parameters
- w: IWidget & Object3D<Event, string>
Returns void
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:69

`Protected` _storeKey

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

`Private` _unregisterWidget

_unregisterWidget(w): void
Parameters
- w: IWidget & Object3D<Event, string>
Returns void
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:73

`Private` _widgetDisposed

_widgetDisposed(e): void
Parameters
- e: IEvent<any>
Returns void
- Defined in src/plugins/extras/Object3DWidgetsPlugin.ts:67

disable

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

dispose

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

enable

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

Class Object3DWidgetsPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

enabled: boolean = true

Returns Object3DWidgetsPlugin

Properties

Protected _dirty

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

Private _widgetRoot

constructor

enabled

helpers

toJSON

uiConfig

widgets

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Private _addSceneObject

Parameters

e: any

Returns void

Private _createWidgets

Parameters

Optional o: Object3D<Event, string>

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Private _registerWidget

Parameters

w: IWidget & Object3D<Event, string>

Returns void

Protected _storeKey

Parameters

Optional prefix: string

Returns string

Private _unregisterWidget

Parameters

w: IWidget & Object3D<Event, string>

Returns void

Private _widgetDisposed

Parameters

e: IEvent<any>

Returns void

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

`Protected` _dirty

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Private` _widgetRoot

`Static` `Readonly` PluginType

`Private` _addSceneObject

`Private` _createWidgets

`Optional` o: Object3D<Event, string>

`Protected` _onViewerEvent

`Private` _registerWidget

`Protected` _storeKey

`Optional` prefix: string

`Private` _unregisterWidget

`Private` _widgetDisposed

`Optional` meta: SerializationMetaType