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 full)

AViewerPluginSync<"">
- ClearcoatTintPlugin

Index

Constructors

constructor

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

Properties

`Protected` _dirty

_dirty: boolean = false

`Private` _uniforms

_uniforms: any = ...

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

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'

`Static` `Readonly` PluginType

PluginType: "ClearcoatTintPlugin" = 'ClearcoatTintPlugin'

Accessors

dirty

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

Methods

`Private` _loaderCreate

_loaderCreate(__namedParameters): void
Parameters
- __namedParameters: {
  loader: GLTFLoader2;
  }
  - loader: GLTFLoader2
Returns void
- Defined in src/plugins/material/ClearcoatTintPlugin.ts:164

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:69

dispose

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

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:74

exportState

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

fromJSON

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

importState

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

isDisabled

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

`Static` AddClearcoatTint

AddClearcoatTint(material, params?): undefined | null | {
    enableTint?: boolean;
    ior?: number;
    thickness?: number;
    tintColor?: string | number | Color;
}
Parameters
- material: PhysicalMaterial
- Optional params: {
      enableTint?: boolean;
      ior?: number;
      thickness?: number;
      tintColor?: string | number | Color;
  }
  - Optional enableTint?: boolean
  - Optional ior?: number
  - Optional thickness?: number
  - Optional 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 full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ClearcoatTintPlugin

Properties

Protected _dirty

Private _uniforms

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

enabled

Readonly materialExtension

Optional uiConfig

Static Readonly CLEARCOAT_TINT_GLTF_EXTENSION

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Private _loaderCreate

Parameters

__namedParameters: { loader: GLTFLoader2; }

loader: GLTFLoader2

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

Parameters

key: any

Returns void

dispose

Returns void

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

Returns null | ClearcoatTintPlugin | Promise<null | ClearcoatTintPlugin>

importState

Parameters

state: any

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

v: ThreeViewer

Returns void

onRemove

Parameters

v: ThreeViewer

Returns void

setDirty

Returns void

toJSON

Parameters

`Protected` _dirty

`Private` _uniforms

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Readonly` materialExtension

`Optional` uiConfig

`Static` `Readonly` CLEARCOAT_TINT_GLTF_EXTENSION

`Static` `Readonly` PluginType

`Private` _loaderCreate

__namedParameters: {
loader: GLTFLoader2;
}

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: SerializationMetaType

`Optional` meta: SerializationMetaType

`Static` AddClearcoatTint

`Optional` params: {
enableTint?: boolean;
ior?: number;
thickness?: number;
tintColor?: string | number | Color;
}

`Optional` enableTint?: boolean

`Optional` ior?: number

`Optional` thickness?: number

`Optional` tintColor?: string | number | Color

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