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

constructor

• new PipelinePassPlugin<T, TPassId, TEvent, TViewer>(): PipelinePassPlugin<T, TPassId, TEvent, TViewer>

• Type Parameters

  • T extends IPipelinePass<string, T>

  • TPassId extends string

  • TEvent extends string

  • TViewer extends ThreeViewer<TViewer> = ThreeViewer

  Returns PipelinePassPlugin<T, TPassId, TEvent, TViewer>

Abstract passId

enabled

• get enabled(): boolean

• Returns boolean

• set enabled(value): void

• Parameters

  • value: boolean

  Returns void

pass

• get pass(): undefined | T

• Returns undefined | T

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

onAdded

• onAdded(viewer): void

• Parameters

  • viewer: TViewer

  Returns void

onRemove

• onRemove(viewer): void

• Parameters

  • viewer: TViewer

  Returns void

setDirty

• setDirty(): void

• Returns void

toJSON

• toJSON(meta?): ISerializedConfig & {
      pass?: any;
  }

• Parameters

  • Optional meta: SerializationMetaType

  Returns ISerializedConfig & {
      pass?: any;
  }