Class: VirtualCamerasPlugin
Plugins.VirtualCamerasPlugin
Hierarchy
AViewerPlugin
<"preRenderCamera"
|"preBlitCamera"
|"postRenderCamera"
>↳
VirtualCamerasPlugin
Properties
PluginType
▪ Static
Readonly
PluginType: "VirtualCamerasPlugin"
Defined in
webgi/src/plugins/VirtualCamerasPlugin.ts:14
enabled
• enabled: boolean
= true
Overrides
Defined in
webgi/src/plugins/VirtualCamerasPlugin.ts:17
toJSON
• toJSON: any
= undefined
Overrides
Defined in
webgi/src/plugins/VirtualCamerasPlugin.ts:19
cameras
• cameras: VirtualCamera
[] = []
Defined in
webgi/src/plugins/VirtualCamerasPlugin.ts:26
_dirty
• Protected
_dirty: boolean
= false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:27
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
viewer
• get
viewer(): undefined
| TViewer
Returns
undefined
| TViewer
Inherited from
AViewerPlugin.viewer
Defined in
webgi/src/core/AViewerPlugin.ts:29
Methods
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:40
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:44
fromJSON
▸ fromJSON(data
, meta?
): null
| VirtualCamerasPlugin
| Promise
<null
| VirtualCamerasPlugin
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| VirtualCamerasPlugin
| Promise
<null
| VirtualCamerasPlugin
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:56
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:68
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:71
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:78
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:88
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Overrides
Defined in
webgi/src/plugins/VirtualCamerasPlugin.ts:28
addCamera
▸ addCamera(camera
): VirtualCamera
Parameters
Name | Type |
---|---|
camera | ICamera <ICameraOptions , any , any > |
Returns
Defined in
webgi/src/plugins/VirtualCamerasPlugin.ts:60
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:64
_preRender
▸ Protected
_preRender(): void
Returns
void
Defined in
webgi/src/plugins/VirtualCamerasPlugin.ts:33
Constructors
constructor
• new VirtualCamerasPlugin(enabled?
)
Parameters
Name | Type | Default value |
---|---|---|
enabled | boolean | true |