Class RenderTargetPreviewPlugin<TEvent>

Base Class for Sync Viewer Plugins

Type Parameters

TEvent extends string

Hierarchy

AViewerPluginSync<TEvent>
- RenderTargetPreviewPlugin

Index

Constructors

constructor

new RenderTargetPreviewPlugin<TEvent>(enabled?): RenderTargetPreviewPlugin<TEvent>
Type Parameters
- TEvent extends string
Parameters
- enabled: boolean = true
Returns RenderTargetPreviewPlugin<TEvent>
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:20

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

mainDiv

mainDiv: HTMLDivElement = ...

`Optional` stylesheet

stylesheet?: HTMLStyleElement

targetBlocks

targetBlocks: {
    div: HTMLDivElement;
    name: string;
    originalColorSpace: boolean;
    target: ValOrFunc<undefined | IRenderTarget>;
    transparent: boolean;
    visible: boolean;
}[] = []

toJSON

toJSON: any = null

`Optional` uiConfig

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

`Static` `Readonly` PluginType

PluginType: "RenderTargetPreviewPlugin" = 'RenderTargetPreviewPlugin'

Accessors

dirty

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

Methods

`Private` _postRender

_postRender(): void
Returns void
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:50

`Protected` _storeKey

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

addTarget

addTarget(target, name, transparent?, originalColorSpace?, visible?): RenderTargetPreviewPlugin<TEvent>
Parameters
- target: ValOrFunc<undefined | IRenderTarget>
- name: string
- transparent: boolean = false
- originalColorSpace: boolean = false
- visible: boolean = true
Returns RenderTargetPreviewPlugin<TEvent>
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:82

dispose

dispose(): void
Returns void
Overrides AViewerPluginSync.dispose
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:162

downloadTarget

downloadTarget(target1): RenderTargetPreviewPlugin<TEvent>
Parameters
- target1: ValOrFunc<undefined | IRenderTarget>
Returns RenderTargetPreviewPlugin<TEvent>
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:122

exportState

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

fromJSON

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

importState

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

onAdded

onAdded(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:34

onRemove

onRemove(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:42

refreshUi

refreshUi(): void
Returns void
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:148

removeTarget

removeTarget(target): RenderTargetPreviewPlugin<TEvent>
Parameters
- target: ValOrFunc<undefined | IRenderTarget>
Returns RenderTargetPreviewPlugin<TEvent>
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:112

Class RenderTargetPreviewPlugin<TEvent>

Type Parameters

TEvent extends string

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TEvent extends string

Parameters

enabled: boolean = true

Returns RenderTargetPreviewPlugin<TEvent>

Properties

Protected _dirty

Protected Optional _viewer

constructor

enabled

mainDiv

Optional stylesheet

targetBlocks

toJSON

Optional uiConfig

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Private _postRender

Returns void

Protected _storeKey

Parameters

Optional prefix: string

Returns string

addTarget

Parameters

target: ValOrFunc<undefined | IRenderTarget>

name: string

transparent: boolean = false

originalColorSpace: boolean = false

visible: boolean = true

Returns RenderTargetPreviewPlugin<TEvent>

dispose

Returns void

downloadTarget

Parameters

target1: ValOrFunc<undefined | IRenderTarget>

Returns RenderTargetPreviewPlugin<TEvent>

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

Returns null | RenderTargetPreviewPlugin<TEvent> | Promise<null | RenderTargetPreviewPlugin<TEvent>>

importState

Parameters

state: any

Returns Promise<void>

onAdded

Parameters

viewer: ThreeViewer

Returns void

onRemove

Parameters

viewer: ThreeViewer

Returns void

refreshUi

Returns void

removeTarget

Parameters

target: ValOrFunc<undefined | IRenderTarget>

Returns RenderTargetPreviewPlugin<TEvent>

Settings

`Protected` _dirty

`Protected` `Optional` _viewer

`Optional` stylesheet

`Optional` uiConfig

`Static` `Readonly` PluginType

`Private` _postRender

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: SerializationMetaType