Class SSContactShadowsPlugin

SS Contact Shadows Plugin Adds a material extension to PhysicalMaterial screen space ray traced contact shadows. It also adds a UI to the material to edit the settings. todo - remove It uses WEBGI_materials_clearcoat_tint glTF extension to save the settings in glTF files.

Hierarchy

AViewerPluginSync
- SSContactShadowsPlugin

Constructors

constructor

new SSContactShadowsPlugin(enabled?: boolean): SSContactShadowsPlugin
Parameters
- enabled: boolean = true
Returns SSContactShadowsPlugin
Overrides AViewerPluginSync.constructor
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSContactShadowsPlugin.ts:269

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof GBufferPlugin[] = ...

enabled

enabled: boolean = true

intensity

intensity: number = 1

isViewerPluginSync

isViewerPluginSync: true = ...

`Readonly`materialExtension

materialExtension: MaterialExtension = ...

onlySSCSDebug

onlySSCSDebug: boolean = false

radius

radius: number = 0.015

stepCount

stepCount: number = 2

tolerance

tolerance: number = 1.5

`Optional`uiConfig

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

`Static` `Readonly`OldPluginType

OldPluginType: "SSContactShadowsPlugin" = 'SSContactShadowsPlugin'

`Static` `Readonly`PluginType

PluginType: "SSContactShadows" = 'SSContactShadows'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

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

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

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

fromJSON

fromJSON(
data: ISerializedConfig,
meta?: SerializationMetaType,
): SSContactShadowsPlugin | Promise<SSContactShadowsPlugin | null> | null
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns SSContactShadowsPlugin | Promise<SSContactShadowsPlugin | null> | null
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:47

importState

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

isDisabled

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

onAdded

onAdded(v: ThreeViewer): void
Parameters
- v: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSContactShadowsPlugin.ts:280

onRemove

onRemove(v: ThreeViewer): void
Parameters
- v: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSContactShadowsPlugin.ts:292

setDirty

setDirty(): void
Returns void
Overrides AViewerPluginSync.setDirty
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSContactShadowsPlugin.ts:259

setGBufferUnpackExtension

setGBufferUnpackExtension(extension: MaterialExtension | undefined): void
Parameters
- extension: MaterialExtension | undefined
Returns void
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSContactShadowsPlugin.ts:316

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:39

Class SSContactShadowsPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SSContactShadowsPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

intensity

isViewerPluginSync

ReadonlymaterialExtension

onlySSCSDebug

radius

stepCount

tolerance

OptionaluiConfig

Static ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns SSContactShadowsPlugin | Promise<SSContactShadowsPlugin | null> | null

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

setGBufferUnpackExtension

Parameters

Returns void

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`materialExtension

`Optional`uiConfig

`Static` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey