Skip to main content

Class: FrameFadePlugin

Plugins.FrameFadePlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "FrameFade"

Defined in

webgi/src/plugins/FrameFadePlugin.ts:12


passId

passId: "frameFade"

Overrides

GenericFilterPlugin.passId

Defined in

webgi/src/plugins/FrameFadePlugin.ts:13


dependencies

dependencies: typeof ProgressivePlugin[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/FrameFadePlugin.ts:24


fadeOnActiveCameraChange

fadeOnActiveCameraChange: boolean = true

Defined in

webgi/src/plugins/FrameFadePlugin.ts:26


fadeOnMaterialUpdate

fadeOnMaterialUpdate: boolean = true

Defined in

webgi/src/plugins/FrameFadePlugin.ts:27


fadeOnSceneUpdate

fadeOnSceneUpdate: boolean = true

Defined in

webgi/src/plugins/FrameFadePlugin.ts:28


pointerEnabled

pointerEnabled: boolean = true

Defined in

webgi/src/plugins/FrameFadePlugin.ts:30


_dirty

Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29


_beforeFilters

Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

Defined in

webgi/src/plugins/FrameFadePlugin.ts:20


_afterFilters

Protected _afterFilters: string[]

Overrides

GenericFilterPlugin._afterFilters

Defined in

webgi/src/plugins/FrameFadePlugin.ts:21


_requiredFilters

Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Defined in

webgi/src/plugins/FrameFadePlugin.ts:22


_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:38


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Implementation of

IViewerPlugin.addEventListener

Inherited from

GenericFilterPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Implementation of

IViewerPlugin.hasEventListener

Inherited from

GenericFilterPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Implementation of

IViewerPlugin.removeEventListener

Inherited from

GenericFilterPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Implementation of

IViewerPlugin.dispatchEvent

Inherited from

GenericFilterPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


startTransition

startTransition(duration): Promise<void>

Parameters

NameType
durationnumber

Returns

Promise<void>

Defined in

webgi/src/plugins/FrameFadePlugin.ts:32


stopTransition

stopTransition(): void

Returns

void

Defined in

webgi/src/plugins/FrameFadePlugin.ts:49


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


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


passCtor

passCtor(v): AddBlendPass

Parameters

NameType
vViewerApp

Returns

AddBlendPass

Overrides

GenericFilterPlugin.passCtor

Defined in

webgi/src/plugins/FrameFadePlugin.ts:111


setDirty

setDirty(): void

Returns

void

Defined in

webgi/src/plugins/FrameFadePlugin.ts:153


disable

disable(name): void

Parameters

NameType
namestring

Returns

void

Defined in

webgi/src/plugins/FrameFadePlugin.ts:186


enable

enable(name): void

Parameters

NameType
namestring

Returns

void

Defined in

webgi/src/plugins/FrameFadePlugin.ts:191


isDisabled

isDisabled(): boolean

Returns

boolean

Defined in

webgi/src/plugins/FrameFadePlugin.ts:197


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


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


_update

Protected _update(v): boolean

Parameters

NameType
vViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Defined in

webgi/src/plugins/FrameFadePlugin.ts:164

Constructors

constructor

new FrameFadePlugin()

Overrides

GenericFilterPlugin.constructor

Defined in

webgi/src/plugins/FrameFadePlugin.ts:55

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Overrides

GenericFilterPlugin.dirty

Defined in

webgi/src/plugins/FrameFadePlugin.ts:158

set dirty(v): void

Parameters

NameType
vboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Overrides

GenericFilterPlugin.dirty

Defined in

webgi/src/plugins/FrameFadePlugin.ts:161


uiConfig

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

Returns

undefined | UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/FrameFadePlugin.ts:180


enabled

get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:17

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:21


pass

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

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:62