Class NoiseBumpMaterialPlugin

NoiseBump Materials Extension Adds a material extension to PhysicalMaterial to add support for sparkle bump / noise bump by creating procedural bump map from noise to simulate sparkle flakes. It uses voronoise function from blender along with several additions to generate the noise for the generation. It also adds a UI to the material to edit the settings. It uses WEBGI_materials_noise_bump glTF extension to save the settings in glTF files.

Hierarchy (view full)

AViewerPluginSync<"">
- NoiseBumpMaterialPlugin

Index

Constructors

constructor

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

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` NOISE_BUMP_MATERIAL_GLTF_EXTENSION

NOISE_BUMP_MATERIAL_GLTF_EXTENSION: "WEBGI_materials_noise_bump" = 'WEBGI_materials_noise_bump'

`Static` `Readonly` PluginType

PluginType: "NoiseBumpMaterialPlugin" = 'NoiseBumpMaterialPlugin'

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/NoiseBumpMaterialPlugin.ts:244

`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 | NoiseBumpMaterialPlugin | Promise<null | NoiseBumpMaterialPlugin>
Parameters
- data: ISerializedConfig
- Optional meta: SerializationMetaType
Returns null | NoiseBumpMaterialPlugin | Promise<null | NoiseBumpMaterialPlugin>
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` AddNoiseBumpMaterial

AddNoiseBumpMaterial(material, params?): boolean
Parameters
- material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
- Optional params: {
      bumpNoiseParams?: Vector2 | Vector2Tuple;
      bumpScale?: number;
      flakeClamp?: number;
      flakeFallOffParams?: Vector3 | Vector3Tuple;
      flakeParams?: Vector4 | Vector4Tuple;
      flakeRadius?: number;
      flakeScale?: number;
      hasBump?: boolean;
      useColorFlakes?: boolean;
  }
  - Optional bumpNoiseParams?: Vector2 | Vector2Tuple
  - Optional bumpScale?: number
  - Optional flakeClamp?: number
  - Optional flakeFallOffParams?: Vector3 | Vector3Tuple
  - Optional flakeParams?: Vector4 | Vector4Tuple
  - Optional flakeRadius?: number
  - Optional flakeScale?: number
  - Optional hasBump?: boolean
  - Optional useColorFlakes?: boolean
Returns boolean
- Defined in src/plugins/material/NoiseBumpMaterialPlugin.ts:41

Class NoiseBumpMaterialPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns NoiseBumpMaterialPlugin

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 NOISE_BUMP_MATERIAL_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 | NoiseBumpMaterialPlugin | Promise<null | NoiseBumpMaterialPlugin>

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` NOISE_BUMP_MATERIAL_GLTF_EXTENSION

`Static` `Readonly` PluginType

`Private` _loaderCreate

__namedParameters: {
loader: GLTFLoader2;
}

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: SerializationMetaType

`Optional` meta: SerializationMetaType

`Static` AddNoiseBumpMaterial

`Optional` params: {
bumpNoiseParams?: Vector2 | Vector2Tuple;
bumpScale?: number;
flakeClamp?: number;
flakeFallOffParams?: Vector3 | Vector3Tuple;
flakeParams?: Vector4 | Vector4Tuple;
flakeRadius?: number;
flakeScale?: number;
hasBump?: boolean;
useColorFlakes?: boolean;
}

`Optional` bumpNoiseParams?: Vector2 | Vector2Tuple

`Optional` bumpScale?: number

`Optional` flakeClamp?: number

`Optional` flakeFallOffParams?: Vector3 | Vector3Tuple

`Optional` flakeParams?: Vector4 | Vector4Tuple

`Optional` flakeRadius?: number

`Optional` flakeScale?: number

`Optional` hasBump?: boolean

`Optional` useColorFlakes?: boolean