Skip to main content

Class: FrameFadePlugin

Plugins.FrameFadePlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "FrameFade"

Defined in

webgi/src/plugins/FrameFadePlugin.ts:11


passId

passId: "frameFade"

Overrides

GenericFilterPlugin.passId

Defined in

webgi/src/plugins/FrameFadePlugin.ts:12


dependencies

dependencies: typeof ProgressivePlugin[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/FrameFadePlugin.ts:23


fadeOnActiveCameraChange

fadeOnActiveCameraChange: boolean = true

Defined in

webgi/src/plugins/FrameFadePlugin.ts:25


fadeOnMaterialUpdate

fadeOnMaterialUpdate: boolean = true

Defined in

webgi/src/plugins/FrameFadePlugin.ts:26


fadeOnSceneUpdate

fadeOnSceneUpdate: boolean = true

Defined in

webgi/src/plugins/FrameFadePlugin.ts:27


pointerEnabled

pointerEnabled: boolean = true

Defined in

webgi/src/plugins/FrameFadePlugin.ts:29


_dirty

Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27


_beforeFilters

Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

Defined in

webgi/src/plugins/FrameFadePlugin.ts:19


_afterFilters

Protected _afterFilters: string[]

Overrides

GenericFilterPlugin._afterFilters

Defined in

webgi/src/plugins/FrameFadePlugin.ts:20


_requiredFilters

Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Defined in

webgi/src/plugins/FrameFadePlugin.ts:21


_pass

Protected Optional _pass: IFilter<AddBlendPass, "frameFade">

Inherited from

GenericFilterPlugin._pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:8

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

GenericFilterPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


exportState

exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

GenericFilterPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Implementation of

IViewerPlugin.storeState

Inherited from

GenericFilterPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

loadState(prefix?, storage?): Promise<void>

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Inherited from

GenericFilterPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


startTransition

startTransition(duration): Promise<void>

Parameters

NameType
durationnumber

Returns

Promise<void>

Defined in

webgi/src/plugins/FrameFadePlugin.ts:31


stopTransition

stopTransition(): void

Returns

void

Defined in

webgi/src/plugins/FrameFadePlugin.ts:48


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

GenericFilterPlugin.onAdded

Defined in

webgi/src/plugins/FrameFadePlugin.ts:92


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

GenericFilterPlugin.onRemove

Defined in

webgi/src/plugins/FrameFadePlugin.ts:101


passCtor

passCtor(v): AddBlendPass

Parameters

NameType
vViewerApp

Returns

AddBlendPass

Overrides

GenericFilterPlugin.passCtor

Defined in

webgi/src/plugins/FrameFadePlugin.ts:110


setDirty

setDirty(): void

Returns

void

Defined in

webgi/src/plugins/FrameFadePlugin.ts:152


disable

disable(name): void

Parameters

NameType
namestring

Returns

void

Defined in

webgi/src/plugins/FrameFadePlugin.ts:185


enable

enable(name): void

Parameters

NameType
namestring

Returns

void

Defined in

webgi/src/plugins/FrameFadePlugin.ts:190


isDisabled

isDisabled(): boolean

Returns

boolean

Defined in

webgi/src/plugins/FrameFadePlugin.ts:196


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

GenericFilterPlugin.toJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:72


fromJSON

fromJSON(data, meta?): null | FrameFadePlugin

Parameters

NameType
dataany
meta?any

Returns

null | FrameFadePlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:81


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60


_update

Protected _update(v): boolean

This function is called every frame before composer render, if this pass is being used in the pipeline

Parameters

NameType
vViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Defined in

webgi/src/plugins/FrameFadePlugin.ts:163

Constructors

constructor

new FrameFadePlugin()

Overrides

GenericFilterPlugin.constructor

Defined in

webgi/src/plugins/FrameFadePlugin.ts:54

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Overrides

GenericFilterPlugin.dirty

Defined in

webgi/src/plugins/FrameFadePlugin.ts:157

set dirty(v): void

Parameters

NameType
vboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Overrides

GenericFilterPlugin.dirty

Defined in

webgi/src/plugins/FrameFadePlugin.ts:160


uiConfig

get uiConfig(): undefined | UiObjectConfig<any, string>

Returns

undefined | UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/FrameFadePlugin.ts:179


enabled

get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:23

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:27


pass

get pass(): undefined | IFilter<T, TPassId>

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:68