Class VirtualCamerasPlugin

Base Class for Sync Viewer Plugins

Hierarchy (view full)

AViewerPluginSync<"preRenderCamera" | "preBlitCamera" | "postRenderCamera">
- VirtualCamerasPlugin

Index

Constructors

Properties

_dirty _viewer? _viewerListeners cameras constructor enabled toJSON uiConfig? OldPluginType? PluginType

Accessors

Methods

_onViewerEvent _storeKey addCamera disable dispose enable exportState fromJSON importState isDisabled onAdded onRemove setDirty?

Constructors

constructor

new VirtualCamerasPlugin(enabled?): VirtualCamerasPlugin
Parameters
- enabled: boolean = true
Returns VirtualCamerasPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/rendering/VirtualCamerasPlugin.ts:20

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

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

Type declaration

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

cameras

cameras: VirtualCamera[] = []

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

toJSON

toJSON: any = undefined

`Optional` uiConfig

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

`Static` `Optional` `Readonly` OldPluginType

OldPluginType?: string

`Static` `Readonly` PluginType

PluginType: "VirtualCamerasPlugin" = 'VirtualCamerasPlugin'

Accessors

dirty

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

Methods

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

addCamera

addCamera(camera): VirtualCamera
Parameters
- camera: ICamera<ICameraEvent, ICameraEventTypes>
Returns VirtualCamera
- Defined in src/plugins/rendering/VirtualCamerasPlugin.ts:51

disable

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

dispose

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

enable

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onAdded
- Defined in src/viewer/AViewerPlugin.ts:141

onRemove

onRemove(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onRemove
- Defined in src/viewer/AViewerPlugin.ts:145

`Optional` setDirty

setDirty(...args): any
Parameters
- Rest ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:84

Generated using TypeDoc