Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ExtrusionFeature

Base interface for all objects that should have animated extrusion effect.

remarks

The implementation of the actual ExtrusionFeature is done with the help of the mixin class ExtrusionFeatureMixin and a set of supporting functions in the namespace of the same name.

Hierarchy

Implemented by

Index

Properties

Optional defines

defines: any

Used internally for material shader defines.

Optional extrusionRatio

extrusionRatio: undefined | number

Ratio of the extruded objects, where 1.0 is the default value. Minimum suggested value is 0.01

Optional needsUpdate

needsUpdate: undefined | false | true

Informs THREE.js to re-compile material shader (due to change in code or defines).

Optional onBeforeCompile

  • This function should be called on implementors of ExtrusionFeature in the onBeforeCompile callback of that material. It adds the required code to the shaders and declares the new uniforms that control extrusion.

    Called before shader program compilation to generate vertex & fragment shader output code.

    Parameters

    • extrusionMaterial: ExtrusionFeature

      Material to add uniforms to.

    • shader: Shader

      [[THREE.WebGLShader]] containing the vertex and fragment shaders to add the special includes to.

    Returns void

Optional shaderDefines

shaderDefines: any

Used internally for material shader defines.

Optional shaderUniforms

shaderUniforms: UniformsType

Used internally for shader uniforms, holds references to material internal shader.uniforms.

Holds a reference to material's internal shader uniforms map. New custom feature based uniforms are injected using this reference, but also internal THREE.js shader uniforms will be available via this map after [[Material#onBeforeCompile]] callback is run with feature enabled.

see

needsUpdate

Optional transparent

transparent: undefined | false | true

Available in all materials in ThreeJS.

Optional uniformsNeedUpdate

uniformsNeedUpdate: undefined | false | true

Hidden ThreeJS value that is made public here. Required to add new uniforms to subclasses of [[THREE.MeshBasicMaterial]]/[[THREE.MeshStandardMaterial]], basically all materials that are not THREE.ShaderMaterial.

deprecated

Changes to this property are ignored.

Functions

isEnabled

patchGlobalShaderChunks

  • patchGlobalShaderChunks(): void

updateExtrusionFeature

Generated using TypeDoc