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

Constructors

Properties

_dirty: boolean = false
_viewer?: ThreeViewer
_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => void,
> = {}
constructor: typeof AViewerPluginSync & typeof AViewerPlugin
enabled: boolean = true
materialExtension: MaterialExtension = ...
uiConfig?: UiObjectConfig = undefined
NOISE_BUMP_MATERIAL_GLTF_EXTENSION: "WEBGI_materials_noise_bump" = 'WEBGI_materials_noise_bump'
OldPluginType?: string
PluginType: "NoiseBumpMaterialPlugin" = 'NoiseBumpMaterialPlugin'

Accessors

Methods

  • Parameters

    • material: IMaterial
    • Optionalparams: {
          bumpNoiseParams?: Vector2 | Vector2Tuple;
          bumpScale?: number;
          flakeClamp?: number;
          flakeFallOffParams?: Vector3 | Vector3Tuple;
          flakeParams?: Vector4 | Vector4Tuple;
          flakeRadius?: number;
          flakeScale?: number;
          hasBump?: boolean;
          useColorFlakes?: boolean;
      }

    Returns boolean