Class PipelinePassPlugin<T, TPassId, TEvent, TViewer>`Abstract`

Pipeline Pass Plugin

Base class for creating a plugin that registers a custom pass to the main render pipeline

Type Parameters

T extends IPipelinePass
TPassId extends IPassID
TEvent extends string
TViewer extends ThreeViewer = ThreeViewer

Hierarchy (View Summary)

AViewerPluginSync<TEvent, TViewer>
- PipelinePassPlugin

Index

Constructors

constructor

new PipelinePassPlugin<
    T extends IPipelinePass,
    TPassId extends string,
    TEvent extends string,
    TViewer extends ThreeViewer = ThreeViewer,
>(): PipelinePassPlugin<T, TPassId, TEvent, TViewer>
Type Parameters
- T extends IPipelinePass
- TPassId extends string
- TEvent extends string
- TViewer extends ThreeViewer = ThreeViewer
Returns PipelinePassPlugin<T, TPassId, TEvent, TViewer>
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/base/PipelinePassPlugin.ts:40

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_pass

_pass?: T

`Protected` `Optional`_viewer

_viewer?: TViewer

`Protected`_viewerListeners

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

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

`Abstract`passId

passId: TPassId

`Optional`uiConfig

uiConfig?: UiObjectConfig = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: string = 'AViewerPlugin'

Accessors

dirty

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

pass

get pass(): undefined | T
Returns undefined | T
- Defined in src/plugins/base/PipelinePassPlugin.ts:62

Methods

`Protected`_beforeRender

_beforeRender(_?: IScene, _1?: ICamera, _2?: IRenderManager): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- Optional_: IScene
- Optional_1: ICamera
- Optional_2: IRenderManager
Returns boolean
- Defined in src/plugins/base/PipelinePassPlugin.ts:34

`Protected` `Abstract`_createPass

_createPass(): T
Returns T
- Defined in src/plugins/base/PipelinePassPlugin.ts:26

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

disable

disable(key: any): 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: any): 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: ISerializedConfig & { pass?: any },
    meta?: SerializationMetaType,
):
    | null
    | PipelinePassPlugin<T, TPassId, TEvent, TViewer>
    | Promise<null | PipelinePassPlugin<T, TPassId, TEvent, TViewer>>
Parameters
- data: ISerializedConfig & { pass?: any }
- Optionalmeta: SerializationMetaType
Returns
    | null
    | PipelinePassPlugin<T, TPassId, TEvent, TViewer>
    | Promise<null | PipelinePassPlugin<T, TPassId, TEvent, TViewer>>
Overrides AViewerPluginSync.fromJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:70

importState

importState(state: any): 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: TViewer): void
Parameters
- viewer: TViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/base/PipelinePassPlugin.ts:44

onRemove

onRemove(viewer: TViewer): void
Parameters
- viewer: TViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/base/PipelinePassPlugin.ts:53

setDirty

setDirty(): void
Returns void
Overrides AViewerPluginSync.setDirty
- Defined in src/plugins/base/PipelinePassPlugin.ts:74

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig & { pass?: any }
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig & { pass?: any }
Overrides AViewerPluginSync.toJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:66

Class PipelinePassPlugin<T, TPassId, TEvent, TViewer>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns PipelinePassPlugin<T, TPassId, TEvent, TViewer>

Properties

Protected_dirty

Protected Optional_pass

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

AbstractpassId

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

pass

Returns undefined | T

Methods

Protected_beforeRender

Parameters

Returns boolean

Protected Abstract_createPass

Returns T

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns | null | PipelinePassPlugin<T, TPassId, TEvent, TViewer> | Promise<null | PipelinePassPlugin<T, TPassId, TEvent, TViewer>>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

toJSON

Parameters

Returns ISerializedConfig & { pass?: any }

Settings

On This Page

Class PipelinePassPlugin<T, TPassId, TEvent, TViewer>`Abstract`

`Protected`_dirty

`Protected` `Optional`_pass

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Abstract`passId

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_beforeRender

`Protected` `Abstract`_createPass

`Protected`_onViewerEvent

`Protected`_storeKey

Returns
| null
| PipelinePassPlugin<T, TPassId, TEvent, TViewer>
| Promise<null | PipelinePassPlugin<T, TPassId, TEvent, TViewer>>