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)

Constructors

Properties

_dirty: boolean = false
_pointerEnabled: boolean = true
_target?: IRenderTarget
_viewer?: ThreeViewer
_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

constructor: typeof AViewerPluginSync & typeof AViewerPlugin
dependencies: typeof ProgressivePlugin[] = ...
enabled: boolean = true
fadeOnActiveCameraChange: boolean = true
fadeOnMaterialUpdate: boolean = true
fadeOnSceneUpdate: boolean = true
passId: "frameFade" = 'frameFade'
saveFrameTimeThreshold: number = 500
uiConfig?: UiObjectConfig<any, string, any> = undefined
OldPluginType?: string
PluginType: "FrameFadePlugin" = 'FrameFadePlugin'

Accessors

Methods

  • Start a frame fade transition. Note that the current frame data will only be used if the last running transition is ended or near the end. To do it anyway, call stopTransition first

    Parameters

    • duration: number

    Returns Promise<void>

Generated using TypeDoc