Class RenderTargetPreviewPlugin<TEvent>

Base Class for Sync Viewer Plugins

Type Parameters

TEvent extends string

Hierarchy (view full)

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

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

mainDiv

mainDiv: HTMLDivElement = ...

`Optional` stylesheet

stylesheet?: HTMLStyleElement

targetBlocks

targetBlocks: RenderTargetBlock[] = []

toJSON

toJSON: any = null

`Optional` uiConfig

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

`Static` `Optional` `Readonly` OldPluginType

OldPluginType?: string

`Static` `Readonly` PluginType

PluginType: "RenderTargetPreviewPlugin" = 'RenderTargetPreviewPlugin'

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

`Private` _postRender

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

`Protected` _storeKey

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

addTarget

addTarget(target, name, transparent?, originalColorSpace?, visible?, material?): this
Parameters
- target: ValOrFunc<undefined | null | IRenderTarget | {
  texture?: ValOrArr<ITexture>;
  }>
  render target or a function that returns a render target
- name: string
  name of the target
- transparent: boolean = false
  if true, the target will be rendered with transparency
- originalColorSpace: boolean = false
  if true, the target will be rendered in its original color space
- visible: boolean = true
  initial visibility
- Optional material: ShaderMaterial<Event, string> | ValOrFunc<string, [string]>
  snippet for ExtendedCopyPass or a custom ExtendedShaderMaterial or three.js ShaderMaterial. Example to read just the red channel (s)=>s + ' = vec4(' + s + '.r);'
Returns this
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:96

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
Overrides AViewerPluginSync.dispose
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:183

downloadTarget

downloadTarget(target1): this
Parameters
- target1: ValOrFunc<undefined | null | IRenderTarget | {
  texture?: ValOrArr<ITexture>;
  }>
Returns this
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:138

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

removeTarget

removeTarget(target): this
Parameters
- target: ValOrFunc<undefined | null | IRenderTarget | {
  texture?: ValOrArr<ITexture>;
  }>
Returns this
- Defined in src/plugins/ui/RenderTargetPreviewPlugin.ts:128

setDirty

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

Class RenderTargetPreviewPlugin<TEvent>

Type Parameters

TEvent extends string

Hierarchy (view full)

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

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

enabled

mainDiv

Optional stylesheet

targetBlocks

toJSON

Optional uiConfig

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Private _postRender

Returns void

Protected _storeKey

Parameters

Optional prefix: string

Returns string

addTarget

Parameters

target: ValOrFunc<undefined | null | IRenderTarget | { texture?: ValOrArr<ITexture>; }>

name: string

transparent: boolean = false

originalColorSpace: boolean = false

visible: boolean = true

Optional material: ShaderMaterial<Event, string> | ValOrFunc<string, [string]>

Returns this

disable

Parameters

key: any

Returns void

dispose

Returns void

downloadTarget

Parameters

target1: ValOrFunc<undefined | null | IRenderTarget | { texture?: ValOrArr<ITexture>; }>

Returns this

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

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

`Protected` _dirty

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` stylesheet

`Optional` uiConfig

`Static` `Optional` `Readonly` OldPluginType

`Static` `Readonly` PluginType

`Protected` _onViewerEvent

`Private` _postRender

`Protected` _storeKey

`Optional` prefix: string

target: ValOrFunc<undefined | null | IRenderTarget | {
texture?: ValOrArr<ITexture>;
}>

`Optional` material: ShaderMaterial<Event, string> | ValOrFunc<string, [string]>

target1: ValOrFunc<undefined | null | IRenderTarget | {
texture?: ValOrArr<ITexture>;
}>

`Optional` meta: SerializationMetaType

target: ValOrFunc<undefined | null | IRenderTarget | {
texture?: ValOrArr<ITexture>;
}>