Class VirtualCamerasPlugin

Base Class for Sync Viewer Plugins

Hierarchy (View Summary)

AViewerPluginSync<VirtualCamerasPluginEventMap>
- 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 removeCamera setDirty?

Constructors

constructor

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

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: { preRender: () => 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:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

addCamera

addCamera(
    camera: ICamera,
    target?: IRenderTarget,
    addTargetPreview?: boolean,
): VirtualCamera
Parameters
- camera: ICamera
- Optionaltarget: IRenderTarget
- addTargetPreview: boolean = false
Returns VirtualCamera
- Defined in src/plugins/rendering/VirtualCamerasPlugin.ts:120

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:75

dispose

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

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:80

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/rendering/VirtualCamerasPlugin.ts:109

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/rendering/VirtualCamerasPlugin.ts:115

removeCamera

removeCamera(camera: ICamera): boolean
Parameters
- camera: ICamera
Returns boolean
- Defined in src/plugins/rendering/VirtualCamerasPlugin.ts:135

`Optional`setDirty

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