Class EditorViewWidgetPlugin

Base Class for Sync Viewer Plugins

Hierarchy (view full)

AViewerPluginSync<"">
- EditorViewWidgetPlugin

Index

Constructors

Properties

_dirty _needsRender _viewer? _viewerListeners constructor enabled placement size uiConfig? widget? PluginType

Accessors

Methods

_mainCameraChange _mainCameraUpdate _onViewerEvent _storeKey disable dispose enable exportState fromJSON importState isDisabled onAdded onRemove setDirty setOrientation toJSON

Constructors

constructor

new EditorViewWidgetPlugin(placement?, size?): 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: ((_) => void);
postRender: ((_) => void);
} = ...

Type declaration

postFrame: ((_) => void)
- - (_): void
  - Parameters
    - _: IViewerEvent
    Returns void
postRender: ((_) => void)
- - (_): void
  - Parameters
    - _: IViewerEvent
    Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = 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` `Readonly` PluginType

PluginType: "EditorViewWidgetPlugin" = 'EditorViewWidgetPlugin'

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

`Protected` _mainCameraChange

_mainCameraChange(): void
Returns void
- Defined in src/plugins/interaction/EditorViewWidgetPlugin.ts:46

`Protected` _mainCameraUpdate

_mainCameraUpdate(): void
Returns void
- Defined in src/plugins/interaction/EditorViewWidgetPlugin.ts:50

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

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

onAdded

onAdded(v): void
Parameters
- v: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/interaction/EditorViewWidgetPlugin.ts:25

onRemove

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

setDirty

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

setOrientation

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

toJSON

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

Generated using TypeDoc