Class FrameFadePlugin

FrameFade Plugin

Adds a post-render pass to smoothly fade to a new rendered frame over time. This is useful for example when changing the camera position, material, object properties, etc to avoid a sudden jump.

Hierarchy (view full)

PipelinePassPlugin<FrameFadeBlendPass, "frameFade", FrameFadePluginEventTypes>
- FrameFadePlugin

Constructors

constructor

new FrameFadePlugin(enabled?): FrameFadePlugin
Parameters
- enabled: boolean = true
Returns FrameFadePlugin
Overrides PipelinePassPlugin.constructor
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:37

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _pass

_pass?: FrameFadeBlendPass

`Protected` _pointerEnabled

_pointerEnabled: boolean = true

`Protected` `Optional` _target

_target?: IRenderTarget

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

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

Type declaration

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

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof ProgressivePlugin[] = ...

enabled

enabled: boolean = true

fadeOnActiveCameraChange

fadeOnActiveCameraChange: boolean = true

fadeOnMaterialUpdate

fadeOnMaterialUpdate: boolean = true

fadeOnSceneUpdate

fadeOnSceneUpdate: boolean = true

`Readonly` passId

passId: "frameFade" = 'frameFade'

`Optional` uiConfig

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

`Static` `Readonly` PluginType

PluginType: "FrameFadePlugin" = 'FrameFadePlugin'

Accessors

canFrameFade

get canFrameFade(): undefined | boolean
Returns undefined | boolean
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:139

dirty

get dirty(): boolean
Returns boolean
Overrides PipelinePassPlugin.dirty
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:127
set dirty(_): void
Parameters
- _: boolean
Returns void
Overrides PipelinePassPlugin.dirty
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:131

lastFrame

get lastFrame(): undefined | Texture
Returns undefined | Texture
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:146

pass

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

target

get target(): undefined | IRenderTarget
Returns undefined | IRenderTarget
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:150

Methods

`Protected` _beforeRender

_beforeRender(): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline

Returns boolean
Overrides PipelinePassPlugin._beforeRender
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:154

`Protected` _createPass

_createPass(): FrameFadeBlendPass
Returns FrameFadeBlendPass
Overrides PipelinePassPlugin._createPass
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:135

`Private` _fadeCam

_fadeCam(ev): Promise<false | void>
Parameters
- ev: any
Returns Promise<false | void>
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:92

`Private` _fadeMat

_fadeMat(ev): Promise<false | void>
Parameters
- ev: any
Returns Promise<false | void>
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:94

`Private` _fadeObjectUpdate

_fadeObjectUpdate(ev): Promise<any>
Parameters
- ev: any
Returns Promise<any>
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:98

`Private` _fadeScene

_fadeScene(ev): Promise<false | void>
Parameters
- ev: any
Returns Promise<false | void>
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:96

`Private` _onPointerMove

_onPointerMove(ev): void
Parameters
- ev: PointerEvent
Returns void
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:101

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from PipelinePassPlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:69

dispose

dispose(): void
Returns void
Inherited from PipelinePassPlugin.dispose
- Defined in src/viewer/AViewerPlugin.ts:28

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from PipelinePassPlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:74

exportState

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

fromJSON

fromJSON(data, meta?): null | FrameFadePlugin | Promise<null | FrameFadePlugin>
Parameters
- data: ISerializedConfig & {
  pass?: any;
  }
- Optional meta: SerializationMetaType
Returns null | FrameFadePlugin | Promise<null | FrameFadePlugin>
Inherited from PipelinePassPlugin.fromJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:61

importState

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

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from PipelinePassPlugin.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:79

startTransition

startTransition(duration): Promise<void>
Parameters
- duration: number
Returns Promise<void>
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:49

stopTransition

stopTransition(): void
Returns void
- Defined in src/plugins/pipeline/FrameFadePlugin.ts:66

toJSON

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

Class FrameFadePlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

enabled: boolean = true

Returns FrameFadePlugin

Properties

Protected _dirty

Protected Optional _pass

Protected _pointerEnabled

Protected Optional _target

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

dependencies

enabled

fadeOnActiveCameraChange

fadeOnMaterialUpdate

fadeOnSceneUpdate

Readonly passId

Optional uiConfig

Static Readonly PluginType

Accessors

canFrameFade

Returns undefined | boolean

dirty

Returns boolean

Parameters

_: boolean

Returns void

lastFrame

Returns undefined | Texture

pass

Returns undefined | T

target

Returns undefined | IRenderTarget

Methods

Protected _beforeRender

Returns boolean

Protected _createPass

Returns FrameFadeBlendPass

Private _fadeCam

Parameters

ev: any

Returns Promise<false | void>

Private _fadeMat

Parameters

ev: any

Returns Promise<false | void>

Private _fadeObjectUpdate

Parameters

ev: any

Returns Promise<any>

Private _fadeScene

Parameters

ev: any

Returns Promise<false | void>

Private _onPointerMove

Parameters

ev: PointerEvent

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

`Protected` _dirty

`Protected` `Optional` _pass

`Protected` _pointerEnabled

`Protected` `Optional` _target

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Readonly` passId

`Optional` uiConfig

`Static` `Readonly` PluginType

`Protected` _beforeRender

`Protected` _createPass

`Private` _fadeCam

`Private` _fadeMat

`Private` _fadeObjectUpdate

`Private` _fadeScene

`Private` _onPointerMove

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

data: ISerializedConfig & {
pass?: any;
}

`Optional` meta: SerializationMetaType

`Optional` meta: SerializationMetaType

Returns ISerializedConfig & {
pass?: any;
}