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 full)

AViewerPluginSync<TEvent, TViewer>
- PipelinePassPlugin

Index

Constructors

constructor

new PipelinePassPlugin<T, TPassId, TEvent, TViewer>(): PipelinePassPlugin<T, TPassId, TEvent, TViewer>
Type Parameters
- T extends IPipelinePass<string>
- 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<"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

`Abstract` passId

passId: TPassId

`Optional` uiConfig

uiConfig?: UiObjectConfig<any, string, any> = 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): 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:60

Methods

`Protected` _beforeRender

_beforeRender(_?, _1?, _2?): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- Optional _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>
- Optional _1: ICamera<ICameraEvent, ICameraEventTypes>
- Optional _2: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>
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
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:63

`Protected` _storeKey

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

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
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:29

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 | PipelinePassPlugin<T, TPassId, TEvent, TViewer> | Promise<null | PipelinePassPlugin<T, TPassId, TEvent, TViewer>>
Parameters
- data: ISerializedConfig & {
  pass?: any;
  }
- Optional meta: 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:68

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

onAdded

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

onRemove

onRemove(viewer): 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:72

toJSON

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

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

Type Parameters

T extends IPipelinePass

TPassId extends IPassID

TEvent extends string

TViewer extends ThreeViewer = ThreeViewer

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends IPipelinePass<string>

TPassId extends string

TEvent extends string

TViewer extends ThreeViewer = ThreeViewer

Returns PipelinePassPlugin<T, TPassId, TEvent, TViewer>

Properties

Protected _dirty

Protected Optional _pass

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

enabled

Abstract passId

Optional uiConfig

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

pass

Returns undefined | T

Methods

Protected _beforeRender

Parameters

Optional _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>

Optional _1: ICamera<ICameraEvent, ICameraEventTypes>

Optional _2: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>

Returns boolean

Protected Abstract _createPass

Returns T

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

Parameters

key: any

Returns void

dispose

Returns void

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig & { pass?: any; }

Optional meta: SerializationMetaType

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

importState

Parameters

state: any

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

`Optional` _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>

`Optional` _1: ICamera<ICameraEvent, ICameraEventTypes>

`Optional` _2: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>

`Protected` `Abstract` _createPass

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

data: ISerializedConfig & {
pass?: any;
}

`Optional` meta: SerializationMetaType

`Optional` meta: SerializationMetaType

Returns ISerializedConfig & {
pass?: any;
}