Documentation
    Preparing search index...

    Class DieStandardMaterial

    Hierarchy

    • MeshStandardMaterial
      • DieStandardMaterial
    Index

    Constructors

    constructor

    Properties

    alphaMap alphaTest alphaToCoverage aoMap aoMapIntensity blendDst blendDstAlpha blendEquation blendEquationAlpha blending blendSrc blendSrcAlpha bumpMap bumpScale clipIntersection clippingPlanes clipShadows color colorWrite defines depthFunc depthTest depthWrite displacementBias displacementMap displacementScale dithering emissive emissiveIntensity emissiveMap envMap envMapIntensity flatShading fog id isMaterial isMeshStandardMaterial lightMap lightMapIntensity map metalness metalnessMap name needsUpdate normalMap normalMapType normalScale opacity polygonOffset polygonOffsetFactor polygonOffsetUnits precision premultipliedAlpha roughness roughnessMap shadowSide side stencilFail stencilFunc stencilFuncMask stencilRef stencilWrite stencilWriteMask stencilZFail stencilZPass toneMapped transparent type userData uuid version vertexColors visible wireframe wireframeLinecap wireframeLinejoin wireframeLinewidth

    Methods

    addEventListener clone copy customProgramCacheKey dispatchEvent dispose hasEventListener onBeforeCompile removeEventListener setValues toJSON

    Constructors

    • Parameters

      • normalMap: Texture
      • faceMap: Texture
      • ledIntensity: number
      • color: Color = ...
      • numberColor: Color = ...
      • numberColorAlpha: number = ...
      • normalScale: Vector2 = ...

      Returns DieStandardMaterial

    Properties

    alphaMap: Texture | null
    null
    alphaTest: number

    Sets the alpha value to be used when running an alpha test. Default is 0.

    0
    alphaToCoverage: boolean

    Enables alpha to coverage. Can only be used with MSAA-enabled rendering contexts.

    false
    aoMap: Texture | null
    null
    aoMapIntensity: number
    1
    blendDst: BlendingDstFactor

    Blending destination. It's one of the blending mode constants defined in Three.js. Default is OneMinusSrcAlphaFactor.

    THREE.OneMinusSrcAlphaFactor
    blendDstAlpha: number | null

    The tranparency of the .blendDst. Default is null.

    null
    blendEquation: BlendingEquation

    Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is AddEquation.

    THREE.AddEquation
    blendEquationAlpha: number | null

    The tranparency of the .blendEquation. Default is null.

    null
    blending: Blending

    Which blending to use when displaying objects with this material. Default is NormalBlending.

    THREE.NormalBlending
    blendSrc: BlendingSrcFactor | BlendingDstFactor

    Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.

    THREE.SrcAlphaFactor
    blendSrcAlpha: number | null

    The tranparency of the .blendSrc. Default is null.

    null
    bumpMap: Texture | null
    null
    bumpScale: number
    1
    clipIntersection: boolean

    Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.

    false
    clippingPlanes: any

    User-defined clipping planes specified as THREE.Plane objects in world space. These planes apply to the objects this material is attached to. Points in space whose signed distance to the plane is negative are clipped (not rendered). See the WebGL / clipping /intersection example. Default is null.

    null
    clipShadows: boolean

    Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.

    false
    color: Color
    new THREE.Color( 0xffffff )
    colorWrite: boolean

    Whether to render the material's color. This can be used in conjunction with a mesh's .renderOrder property to create invisible objects that occlude other objects. Default is true.

    true
    defines: { [key: string]: any }
    { 'STANDARD': '' }
    depthFunc: DepthModes

    Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.

    THREE.LessEqualDepth
    depthTest: boolean

    Whether to have depth test enabled when rendering this material. Default is true.

    true
    depthWrite: boolean

    Whether rendering this material has any effect on the depth buffer. Default is true. When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.

    true
    displacementBias: number
    0
    displacementMap: Texture | null
    null
    displacementScale: number
    1
    dithering: boolean

    Whether to apply dithering to the color to remove the appearance of banding. Default is false.

    false
    emissive: Color
    new THREE.Color( 0x000000 )
    emissiveIntensity: number
    1
    emissiveMap: Texture | null
    null
    envMap: Texture | null
    null
    envMapIntensity: number
    1
    flatShading: boolean

    Define whether the material is rendered with flat shading. Default is false.

    false
    fog: boolean

    Whether the material is affected by fog. Default is true.

    fog
    id: number

    Unique number of this material instance.

    isMaterial: true

    Used to check whether this or derived classes are materials. Default is true. You should not change this, as it used internally for optimisation.

    isMeshStandardMaterial: boolean
    lightMap: Texture | null
    null
    lightMapIntensity: number
    1
    map: Texture | null
    null
    metalness: number
    0
    metalnessMap: Texture | null
    null
    name: string

    Material name. Default is an empty string.

    ''
    needsUpdate: boolean

    Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

    false
    normalMap: Texture | null
    null
    normalMapType: NormalMapTypes
    THREE.TangentSpaceNormalMap
    normalScale: Vector2
    new THREE.Vector2( 1, 1 )
    opacity: number

    Opacity. Default is 1.

    1
    polygonOffset: boolean

    Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.

    false
    polygonOffsetFactor: number

    Sets the polygon offset factor. Default is 0.

    0
    polygonOffsetUnits: number

    Sets the polygon offset units. Default is 0.

    0
    precision: "highp" | "mediump" | "lowp" | null

    Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.

    null
    premultipliedAlpha: boolean

    Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.

    false
    roughness: number
    1
    roughnessMap: Texture | null
    null
    shadowSide: Side | null

    Defines which of the face sides will cast shadows. Default is null. If null, the value is opposite that of side, above.

    null
    side: Side

    Defines which of the face sides will be rendered - front, back or both. Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

    THREE.FrontSide
    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    THREE.KeepStencilOp
    stencilFunc: StencilFunc

    The stencil comparison function to use. Default is AlwaysStencilFunc. See stencil operation constants for all possible values.

    THREE.AlwaysStencilFunc
    stencilFuncMask: number

    The bit mask to use when comparing against the stencil buffer. Default is 0xFF.

    0xff
    stencilRef: number

    The value to use when performing stencil comparisons or stencil operations. Default is 0.

    0
    stencilWrite: boolean

    Whether rendering this material has any effect on the stencil buffer. Default is false.

    false
    stencilWriteMask: number

    The bit mask to use when writing to the stencil buffer. Default is 0xFF.

    0xff
    stencilZFail: StencilOp

    Which stencil operation to perform when the comparison function returns true but the depth test fails. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    THREE.KeepStencilOp
    stencilZPass: StencilOp

    Which stencil operation to perform when the comparison function returns true and the depth test passes. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    THREE.KeepStencilOp
    toneMapped: boolean

    Defines whether this material is tone mapped according to the renderer's toneMapping setting. Default is true.

    true
    transparent: boolean

    Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects. When set to true, the extent to which the material is transparent is controlled by setting it's .opacity property. Default is false.

    false
    type: string
    'MeshStandardMaterial'
    userData: any

    An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

    {}
    uuid: string

    UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.

    version: number

    This starts at 0 and counts how many times .needsUpdate is set to true.

    0
    vertexColors: boolean

    Defines whether vertex coloring is used. Default is false.

    false
    visible: boolean

    Defines whether this material is visible. Default is true.

    true
    wireframe: boolean
    false
    wireframeLinecap: string
    'round'
    wireframeLinejoin: string
    'round'
    wireframeLinewidth: number
    1

    Methods

    • Adds a listener to an event type.

      Type Parameters

      • T extends string

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<Event, T, DieStandardMaterial>

        The function that gets called when the event is fired.

      Returns void

    • Return a new material with the same parameters as this material.

      Returns this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    • Fire an event type.

      Parameters

      • event: Event

      Returns void

    • This disposes the material. Textures of a material don't get disposed. These needs to be disposed by Texture.

      Returns void

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends string

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<Event, T, DieStandardMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials.

      Parameters

      • shader: Shader

        Source code of the shader

      • renderer: WebGLRenderer

        WebGLRenderer Context that is initializing the material

      Returns void

    • Removes a listener from an event type.

      Type Parameters

      • T extends string

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<Event, T, DieStandardMaterial>

        The listener function that gets removed.

      Returns void

    • Sets the properties based on the values.

      Parameters

      • parameters: MeshStandardMaterialParameters

      Returns void

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: any

        Object containing metadata such as textures or images for the material.

      Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    alphaMapalphaTestalphaToCoverageaoMapaoMapIntensityblendDstblendDstAlphablendEquationblendEquationAlphablendingblendSrcblendSrcAlphabumpMapbumpScaleclipIntersectionclippingPlanesclipShadowscolorcolorWritedefinesdepthFuncdepthTestdepthWritedisplacementBiasdisplacementMapdisplacementScaleditheringemissiveemissiveIntensityemissiveMapenvMapenvMapIntensityflatShadingfogidisMaterialisMeshStandardMateriallightMaplightMapIntensitymapmetalnessmetalnessMapnameneedsUpdatenormalMapnormalMapTypenormalScaleopacitypolygonOffsetpolygonOffsetFactorpolygonOffsetUnitsprecisionpremultipliedAlpharoughnessroughnessMapshadowSidesidestencilFailstencilFuncstencilFuncMaskstencilRefstencilWritestencilWriteMaskstencilZFailstencilZPasstoneMappedtransparenttypeuserDatauuidversionvertexColorsvisiblewireframewireframeLinecapwireframeLinejoinwireframeLinewidth
    Methods