Class ClearcoatTintPlugin

Clearcoat Tint Plugin Adds a material extension to PhysicalMaterial which adds tint and thickness to the built-in clearcoat properties. It also adds a UI to the material to edit the settings. It uses WEBGI_materials_clearcoat_tint glTF extension to save the settings in glTF files.

Hierarchy (View Summary)

AViewerPluginSync
- ClearcoatTintPlugin

Index

Constructors

constructor

new ClearcoatTintPlugin(): ClearcoatTintPlugin
Returns ClearcoatTintPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/material/ClearcoatTintPlugin.ts:164

Properties

`Protected`_dirty

_dirty: boolean = false

enabled

enabled: boolean = true

`Readonly`materialExtension

materialExtension: MaterialExtension = ...

`Optional`uiConfig

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

`Static` `Readonly`CLEARCOAT_TINT_GLTF_EXTENSION

CLEARCOAT_TINT_GLTF_EXTENSION: "WEBGI_materials_clearcoat_tint" = 'WEBGI_materials_clearcoat_tint'

Deprecated

use clearCoatTintGLTFExtension

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "ClearcoatTintPlugin" = 'ClearcoatTintPlugin'

Accessors

dirty

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

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

dispose

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

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(v: ThreeViewer): void
Parameters
- v: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/material/ClearcoatTintPlugin.ts:169

onRemove

onRemove(v: ThreeViewer): void
Parameters
- v: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/material/ClearcoatTintPlugin.ts:175

setDirty

setDirty(): void
Returns void
Overrides AViewerPluginSync.setDirty
- Defined in src/plugins/material/ClearcoatTintPlugin.ts:159

toJSON

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

`Static`AddClearcoatTint

AddClearcoatTint(
    material: PhysicalMaterial,
    params?: {
        enableTint?: boolean;
        ior?: number;
        thickness?: number;
        tintColor?: string | number | Color;
    },
): | undefined
| null
| {
    enableTint?: boolean;
    ior?: number;
    thickness?: number;
    tintColor?: string
    | number
    | Color;
}
Parameters
- material: PhysicalMaterial
- Optionalparams: {
      enableTint?: boolean;
      ior?: number;
      thickness?: number;
      tintColor?: string | number | Color;
  }
Returns
    | undefined
    | null
    | {
        enableTint?: boolean;
        ior?: number;
        thickness?: number;
        tintColor?: string
        | number
        | Color;
    }
- Defined in src/plugins/material/ClearcoatTintPlugin.ts:35

Class ClearcoatTintPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ClearcoatTintPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

ReadonlymaterialExtension

OptionaluiConfig

Static ReadonlyCLEARCOAT_TINT_GLTF_EXTENSION

Deprecated

Static Optional 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 null | ClearcoatTintPlugin | Promise<null | ClearcoatTintPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

toJSON

Parameters

Returns ISerializedConfig

StaticAddClearcoatTint

Parameters

Returns | undefined | null | { enableTint?: boolean; ior?: number; thickness?: number; tintColor?: string | number | Color; }

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`materialExtension

`Optional`uiConfig

`Static` `Readonly`CLEARCOAT_TINT_GLTF_EXTENSION

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Static`AddClearcoatTint

Returns
| undefined
| null
| {
enableTint?: boolean;
ior?: number;
thickness?: number;
tintColor?: string
| number
| Color;
}