Class EditorViewWidgetPlugin

Base Class for Sync Viewer Plugins

Hierarchy (View Summary)

AViewerPluginSync
- EditorViewWidgetPlugin

Index

Constructors

constructor

new EditorViewWidgetPlugin(
placement?: DomPlacement,
size?: number,
): EditorViewWidgetPlugin
Parameters
- placement: DomPlacement = 'top-left'
- size: number = 128
Returns EditorViewWidgetPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/interaction/EditorViewWidgetPlugin.ts:19

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected`_needsRender

_needsRender: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: {
postFrame: (_: IViewerEvent) => void;
postRender: (_: IViewerEvent) => void;
} = ...

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

`Readonly`placement

placement: DomPlacement = 'top-left'

`Readonly`size

size: number = 128

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Optional`widget

widget?: ViewHelper2

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "EditorViewWidgetPlugin" = 'EditorViewWidgetPlugin'

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`_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 | EditorViewWidgetPlugin | Promise<null | EditorViewWidgetPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | EditorViewWidgetPlugin | Promise<null | EditorViewWidgetPlugin>
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(v: ThreeViewer): void
Parameters
- v: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/interaction/EditorViewWidgetPlugin.ts:28

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/interaction/EditorViewWidgetPlugin.ts:41

setDirty

setDirty(): void
Returns void
Overrides AViewerPluginSync.setDirty
- Defined in src/plugins/interaction/EditorViewWidgetPlugin.ts:14

setOrientation

setOrientation(orientation: GizmoOrientation): void
Parameters
- orientation: GizmoOrientation
Returns void
- Defined in src/plugins/interaction/EditorViewWidgetPlugin.ts:74

toJSON

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

Class EditorViewWidgetPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EditorViewWidgetPlugin

Properties

Protected_dirty

Protected_needsRender

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

isViewerPluginSync

Readonlyplacement

Readonlysize

OptionaluiConfig

Optionalwidget

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_mainCameraChange

Returns void

Protected_mainCameraUpdate

Returns void

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

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

setOrientation

Parameters

Returns void

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_dirty

`Protected`_needsRender

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`placement

`Readonly`size

`Optional`uiConfig

`Optional`widget

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_mainCameraChange

`Protected`_mainCameraUpdate

`Protected`_onViewerEvent

`Protected`_storeKey