Class TransformControlsPlugin

Base Class for Sync Viewer Plugins

Hierarchy (view full)

AViewerPluginSync<"">
- TransformControlsPlugin

Index

Constructors

constructor

new TransformControlsPlugin(enabled?): TransformControlsPlugin
Parameters
- enabled: boolean = true
Returns TransformControlsPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/interaction/TransformControlsPlugin.ts:36

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` _isInteracting

_isInteracting: boolean = false

`Private` _pickingWidgetDisabled

_pickingWidgetDisabled: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

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

Type declaration

postFrame: (() => void)
- - (): void
  - Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof PickingPlugin[] = ...

enabled

enabled: boolean = true

toJSON

toJSON: any = undefined

transformControls

transformControls: undefined | TransformControls2

`Optional` uiConfig

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

`Static` `Readonly` PluginType

PluginType: "TransformControlsPlugin" = 'TransformControlsPlugin'

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` _mainCameraChange

_mainCameraChange(): void
Returns void
- Defined in src/plugins/interaction/TransformControlsPlugin.ts:102

`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

centerAllMeshes

centerAllMeshes(): void
Returns void
- Defined in src/plugins/interaction/TransformControlsPlugin.ts:108

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 | TransformControlsPlugin | Promise<null | TransformControlsPlugin>
Parameters
- data: ISerializedConfig
- Optional meta: SerializationMetaType
Returns null | TransformControlsPlugin | Promise<null | TransformControlsPlugin>
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(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/interaction/TransformControlsPlugin.ts:58

onRemove

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

setDirty

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

Generated using TypeDoc