Class MeshBasicMaterial2

And extension of three.js MeshBasicMaterial that can be assigned to objects, and support threepipe features, uiconfig, and serialization.

Hierarchy (View Summary)

UnlitMaterial
- MeshBasicMaterial2

Constructors

constructor

new MeshBasicMaterial2(
parameters?: MeshBasicMaterialParameters,
): MeshBasicMaterial2
Parameters
- Optionalparameters: MeshBasicMaterialParameters
Returns MeshBasicMaterial2
Overrides UnlitMaterial.constructor
- Defined in src/core/material/UnlitMaterial.ts:239

Properties

`Readonly`appliedMeshes

appliedMeshes: Set<IObject3D> = ...

Managed internally, do not change manually

assetType

assetType: "material" = ...

constructor

constructor: typeof UnlitMaterial

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

envMap

envMap: null | ITexture = null

Default

null

extraUniformsToUpload

extraUniformsToUpload: Record<string, IUniform> = {}

`Optional`generator

generator?: IMaterialGenerator

Managed internally, do not change manually

`Readonly`isUnlitMaterial

isUnlitMaterial: true

materialExtensions

materialExtensions: MaterialExtension[] = []

onAfterRender

onAfterRender: (
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
) => void = ...

onBeforeRender

onBeforeRender: (
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
) => void = ...

registerMaterialExtensions

registerMaterialExtensions: (
this: IMaterial,
customMaterialExtensions: MaterialExtension[],
) => void = iMaterialCommons.registerMaterialExtensions

`Readonly`setDirty

setDirty: (this: IMaterial, options?: IMaterialSetDirtyOptions) => void = iMaterialCommons.setDirty

uiConfig

uiConfig: UiObjectConfig = ...

unregisterMaterialExtensions

unregisterMaterialExtensions: (
this: IMaterial,
customMaterialExtensions: MaterialExtension[],
) => void = iMaterialCommons.unregisterMaterialExtensions

userData

userData: IMaterialUserData

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.

Default

{}

`Static` `Readonly`MaterialProperties

MaterialProperties: {
    alphaMap: null;
    alphaTest: number;
    alphaToCoverage: boolean;
    aoMap: null;
    aoMapIntensity: number;
    blendDst: 205;
    blendDstAlpha: null;
    blendEquation: 100;
    blendEquationAlpha: null;
    blending: 1;
    blendSrc: 204;
    blendSrcAlpha: null;
    clipIntersection: boolean;
    clippingPlanes: null;
    clipShadows: boolean;
    color: Color;
    colorWrite: boolean;
    combine: 0;
    depthFunc: 3;
    depthTest: boolean;
    depthWrite: boolean;
    dithering: boolean;
    envMap: null;
    envMapIntensity: number;
    flatShading: boolean;
    fog: boolean;
    forceSinglePass: boolean;
    lightMap: null;
    lightMapIntensity: number;
    map: null;
    name: string;
    opacity: number;
    polygonOffset: boolean;
    polygonOffsetFactor: number;
    polygonOffsetUnits: number;
    precision: null;
    premultipliedAlpha: boolean;
    reflectivity: number;
    refractionRatio: number;
    shadowSide: null;
    side: 0;
    skinning: boolean;
    specularMap: null;
    stencilFail: 7680;
    stencilFunc: 519;
    stencilFuncMask: number;
    stencilRef: number;
    stencilWrite: boolean;
    stencilWriteMask: number;
    stencilZFail: 7680;
    stencilZPass: 7680;
    toneMapped: boolean;
    transparent: boolean;
    userData: {};
    vertexColors: boolean;
    visible: boolean;
    wireframe: boolean;
    wireframeLinecap: string;
    wireframeLinejoin: string;
    wireframeLinewidth: number;
} = ...

`Static`MaterialTemplate

MaterialTemplate: IMaterialTemplate<
    UnlitMaterial,
    Partial<
        {
            alphaMap: null;
            alphaTest: number;
            alphaToCoverage: boolean;
            aoMap: null;
            aoMapIntensity: number;
            blendDst: 205;
            blendDstAlpha: null;
            blendEquation: 100;
            blendEquationAlpha: null;
            blending: 1;
            blendSrc: 204;
            blendSrcAlpha: null;
            clipIntersection: boolean;
            clippingPlanes: null;
            clipShadows: boolean;
            color: Color;
            colorWrite: boolean;
            combine: 0;
            depthFunc: 3;
            depthTest: boolean;
            depthWrite: boolean;
            dithering: boolean;
            envMap: null;
            envMapIntensity: number;
            flatShading: boolean;
            fog: boolean;
            forceSinglePass: boolean;
            lightMap: null;
            lightMapIntensity: number;
            map: null;
            name: string;
            opacity: number;
            polygonOffset: boolean;
            polygonOffsetFactor: number;
            polygonOffsetUnits: number;
            precision: null;
            premultipliedAlpha: boolean;
            reflectivity: number;
            refractionRatio: number;
            shadowSide: null;
            side: 0;
            skinning: boolean;
            specularMap: null;
            stencilFail: 7680;
            stencilFunc: 519;
            stencilFuncMask: number;
            stencilRef: number;
            stencilWrite: boolean;
            stencilWriteMask: number;
            stencilZFail: 7680;
            stencilZPass: 7680;
            toneMapped: boolean;
            transparent: boolean;
            userData: {};
            vertexColors: boolean;
            visible: boolean;
            wireframe: boolean;
            wireframeLinecap: string;
            wireframeLinejoin: string;
            wireframeLinewidth: number;
        },
    >,
> = ...

`Static` `Readonly`TYPE

TYPE: "UnlitMaterial" = 'UnlitMaterial'

`Static` `Readonly`TypeSlug

TypeSlug: "bmat" = 'bmat'

Methods

clone

clone(): this
Return a new material with the same parameters as this material.

Returns this
Inherited from UnlitMaterial.clone
- Defined in src/core/material/UnlitMaterial.ts:49

copy

copy(source: any): this
Copy the parameters from the passed material into this material.
Parameters
- source: any
Returns this
Inherited from UnlitMaterial.copy
- Defined in src/core/material/UnlitMaterial.ts:134

customProgramCacheKey

customProgramCacheKey(): string
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
Inherited from UnlitMaterial.customProgramCacheKey
- Defined in src/core/material/UnlitMaterial.ts:73

dispatchEvent

dispatchEvent(event: IMaterialEvent): void
Fire an event type.
Parameters
- event: IMaterialEvent
  The event that gets fired.
Returns void
Inherited from UnlitMaterial.dispatchEvent
- Defined in src/core/material/UnlitMaterial.ts:50

dispose

dispose(): this
This disposes the material. Textures of a material don't get disposed. These needs to be disposed by Texture.

Returns this
Inherited from UnlitMaterial.dispose
- Defined in src/core/material/UnlitMaterial.ts:48

fromJSON

fromJSON(
    data: any,
    meta?: SerializationMetaType,
    _internal?: boolean,
): null | MeshBasicMaterial2
Deserializes the material from JSON. Textures should be loaded and in meta.textures before calling this method. todo - needs to be tested
Parameters
- data: any
- Optionalmeta: SerializationMetaType
- _internal: boolean = false
Returns null | MeshBasicMaterial2
Inherited from UnlitMaterial.fromJSON
- Defined in src/core/material/UnlitMaterial.ts:159

onBeforeCompile

onBeforeCompile(shader: Shader, renderer: WebGLRenderer): void
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
Inherited from UnlitMaterial.onBeforeCompile
- Defined in src/core/material/UnlitMaterial.ts:77

setValues

setValues(
    parameters: Material | MeshBasicMaterialParameters & { type?: string },
    allowInvalidType?: boolean,
    clearCurrentUserData?: undefined | boolean,
): this
Sets the values of this material based on the values of the passed material or an object with material properties The input is expected to be a valid material or a deserialized material parameters object(including the deserialized userdata)
Parameters
- parameters: Material | MeshBasicMaterialParameters & { type?: string }
  material or material parameters object
- allowInvalidType: boolean = true
  if true, the type of the oldMaterial is not checked. Objects without type are always allowed.
- clearCurrentUserData: undefined | boolean = undefined
  if undefined, then depends on material.isMaterial. if true, the current userdata is cleared before setting the new values, because it can have data which wont be overwritten if not present in the new material.
Returns this
Inherited from UnlitMaterial.setValues
- Defined in src/core/material/UnlitMaterial.ts:121

toJSON

toJSON(meta?: SerializationMetaType, _internal?: boolean): any
Serializes this material to JSON.
Parameters
- Optionalmeta: SerializationMetaType
  metadata for serialization
- _internal: boolean = false
  Calls only super.toJSON, does internal three.js serialization and @serialize tags. Set it to true only if you know what you are doing. This is used in Serialization->serializer->material
Returns any
Inherited from UnlitMaterial.toJSON
- Defined in src/core/material/UnlitMaterial.ts:143

Class MeshBasicMaterial2

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MeshBasicMaterial2

Properties

ReadonlyappliedMeshes

assetType

constructor

envMap

Default

extraUniformsToUpload

Optionalgenerator

ReadonlyisUnlitMaterial

materialExtensions

onAfterRender

onBeforeRender

registerMaterialExtensions

ReadonlysetDirty

uiConfig

unregisterMaterialExtensions

userData

Default

Static ReadonlyMaterialProperties

StaticMaterialTemplate

Static ReadonlyTYPE

Static ReadonlyTypeSlug

Methods

clone

Returns this

copy

Parameters

Returns this

customProgramCacheKey

Returns string

dispatchEvent

Parameters

Returns void

dispose

Returns this

fromJSON

Parameters

Returns null | MeshBasicMaterial2

onBeforeCompile

Parameters

Returns void

setValues

Parameters

Returns this

toJSON

Parameters

Returns any

Settings

On This Page

`Readonly`appliedMeshes

`Optional`generator

`Readonly`isUnlitMaterial

`Readonly`setDirty

`Static` `Readonly`MaterialProperties

`Static`MaterialTemplate

`Static` `Readonly`TYPE

`Static` `Readonly`TypeSlug