Class LineMaterial2<TE>

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

Constructors

constructor

new LineMaterial2<TE extends IMaterialEventMap = IMaterialEventMap>(
    __namedParameters?: LineMaterialParameters & MaterialParameters & {
        customMaterialExtensions?: MaterialExtension[];
    },
): LineMaterial2<TE>
Type Parameters
- TE extends IMaterialEventMap = IMaterialEventMap
Parameters
- __namedParameters: LineMaterialParameters & MaterialParameters & {
  customMaterialExtensions?: MaterialExtension[];
  } = {}
Returns LineMaterial2<TE>
Overrides LineMaterial<TE & IMaterialEventMap>.constructor
- Defined in src/core/material/LineMaterial2.ts:52

Properties

alphaToCoverage

alphaToCoverage: boolean

`Readonly`appliedMeshes

appliedMeshes: Set<
    IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >,
> = ...

Objects in the scene that are using this material. This is set in the Object3DManager when the objects are added/removed from the scene. Do not modify this set directly.

assetType

assetType: "material" = ...

autoUpdateResolution

autoUpdateResolution: boolean = true

color

color: Color

constructor

constructor: typeof LineMaterial2

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

dashed

dashed: boolean

dashOffset

dashOffset: number

dashScale

dashScale: number

dashSize

dashSize: number

extraUniformsToUpload

extraUniformsToUpload: Record<string, IUniform> = {}

gapSize

gapSize: number

`Optional`generator

generator?: IMaterialGenerator

Managed internally, do not change manually

`Readonly`isLineMaterial2

isLineMaterial2: true

linewidth

linewidth: number

materialExtensions

materialExtensions: MaterialExtension[] = []

name

name: string

Material name. Default is an empty string.

Default

''

registerMaterialExtensions

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

resolution

resolution: Vector2

`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

{}

worldUnits

worldUnits: boolean

`Static` `Readonly`InterpolateProperties

InterpolateProperties: string[] = ...

`Static` `Readonly`MaterialProperties

MaterialProperties: {
    allowOverride: boolean;
    alphaHash: boolean;
    alphaTest: number;
    alphaToCoverage: boolean;
    blendAlpha: number;
    blendColor: string;
    blendDst: 205;
    blendDstAlpha: null;
    blendEquation: 100;
    blendEquationAlpha: null;
    blending: 1;
    blendSrc: 204;
    blendSrcAlpha: null;
    clipIntersection: boolean;
    clipping: boolean;
    clippingPlanes: null;
    clipShadows: boolean;
    color: Color;
    colorWrite: boolean;
    dashed: boolean;
    dashOffset: number;
    dashScale: number;
    dashSize: number;
    defines: {};
    depthFunc: 3;
    depthTest: boolean;
    depthWrite: boolean;
    dithering: boolean;
    extensions: {};
    fog: boolean;
    forceSinglePass: boolean;
    fragmentShader: string;
    gapSize: number;
    linewidth: number;
    name: string;
    opacity: number;
    polygonOffset: boolean;
    polygonOffsetFactor: number;
    polygonOffsetUnits: number;
    precision: null;
    premultipliedAlpha: boolean;
    resolution: Vector2;
    shadowSide: null;
    side: 0;
    stencilFail: 7680;
    stencilFunc: 519;
    stencilFuncMask: number;
    stencilRef: number;
    stencilWrite: boolean;
    stencilWriteMask: number;
    stencilZFail: 7680;
    stencilZPass: 7680;
    toneMapped: boolean;
    transparent: boolean;
    uniforms: {};
    userData: {};
    vertexColors: boolean;
    vertexShader: string;
    visible: boolean;
    worldUnits: boolean;
} = ...

`Static`MaterialTemplate

MaterialTemplate: IMaterialTemplate<
    LineMaterial2<IMaterialEventMap>,
    Partial<
        {
            allowOverride: boolean;
            alphaHash: boolean;
            alphaTest: number;
            alphaToCoverage: boolean;
            blendAlpha: number;
            blendColor: string;
            blendDst: 205;
            blendDstAlpha: null;
            blendEquation: 100;
            blendEquationAlpha: null;
            blending: 1;
            blendSrc: 204;
            blendSrcAlpha: null;
            clipIntersection: boolean;
            clipping: boolean;
            clippingPlanes: null;
            clipShadows: boolean;
            color: Color;
            colorWrite: boolean;
            dashed: boolean;
            dashOffset: number;
            dashScale: number;
            dashSize: number;
            defines: {};
            depthFunc: 3;
            depthTest: boolean;
            depthWrite: boolean;
            dithering: boolean;
            extensions: {};
            fog: boolean;
            forceSinglePass: boolean;
            fragmentShader: string;
            gapSize: number;
            linewidth: number;
            name: string;
            opacity: number;
            polygonOffset: boolean;
            polygonOffsetFactor: number;
            polygonOffsetUnits: number;
            precision: null;
            premultipliedAlpha: boolean;
            resolution: Vector2;
            shadowSide: null;
            side: 0;
            stencilFail: 7680;
            stencilFunc: 519;
            stencilFuncMask: number;
            stencilRef: number;
            stencilWrite: boolean;
            stencilWriteMask: number;
            stencilZFail: 7680;
            stencilZPass: 7680;
            toneMapped: boolean;
            transparent: boolean;
            uniforms: {};
            userData: {};
            vertexColors: boolean;
            vertexShader: string;
            visible: boolean;
            worldUnits: boolean;
        },
    >,
> = ...

`Static` `Readonly`TYPE

TYPE: "LineMaterial2" = 'LineMaterial2'

`Static` `Readonly`TypeSlug

TypeSlug: "lmat" = 'lmat'

Methods

clone

clone(track?: boolean): this
Return a new material with the same parameters as this material.
Parameters
- track: boolean = false
Returns this
Implementation of IMaterial.clone
Overrides LineMaterial.clone
- Defined in src/core/material/LineMaterial2.ts:48

copy

copy(source: any): this
Copy the parameters from the passed material into this material.
Parameters
- source: any
Returns this
Implementation of IMaterial.copy
Overrides LineMaterial.copy
- Defined in src/core/material/LineMaterial2.ts:172

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
Implementation of IMaterial.customProgramCacheKey
Overrides LineMaterial.customProgramCacheKey
- Defined in src/core/material/LineMaterial2.ts:68

dispose

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

Returns this
Implementation of IMaterial.dispose
Overrides LineMaterial.dispose
- Defined in src/core/material/LineMaterial2.ts:47

fromJSON

fromJSON(
    data: any,
    meta?: SerializationMetaType,
    _internal?: boolean,
): null | LineMaterial2<TE>
Deserializes the material from JSON. Note: some properties that are not serialized in Material.toJSON when they are default values (like side, alphaTest, blending, maps), they wont be reverted back if not present in JSON If _internal = true, Textures should be loaded and in meta.textures before calling this method.
Parameters
- data: any
- Optionalmeta: SerializationMetaType
- _internal: boolean = false
Returns null | LineMaterial2<TE>
Implementation of IMaterial.fromJSON
- Defined in src/core/material/LineMaterial2.ts:197

onAfterRender

onAfterRender(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
): void
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- object: Object3D
Returns void
Implementation of IMaterial.onAfterRender
Overrides LineMaterial.onAfterRender
- Defined in src/core/material/LineMaterial2.ts:96

onBeforeCompile

onBeforeCompile(
shader: WebGLProgramParametersWithUniforms,
renderer: WebGLRenderer,
): void
An optional callback that is executed immediately before the shader program is compiled. This function is called with the associated WebGL program parameters and renderer. Useful for the modification of built-in materials.
Parameters
- shader: WebGLProgramParametersWithUniforms
- renderer: WebGLRenderer
  WebGLRenderer context that is initializing the material
Returns void
Implementation of IMaterial.onBeforeCompile
Overrides LineMaterial.onBeforeCompile
- Defined in src/core/material/LineMaterial2.ts:72

onBeforeRender

onBeforeRender(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
): void
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- object: Object3D
Returns void
Implementation of IMaterial.onBeforeRender
Overrides LineMaterial.onBeforeRender
- Defined in src/core/material/LineMaterial2.ts:90

setValues

setValues(
    parameters:
        | Material<MaterialEventMap>
        | LineMaterialParameters & { type?: string },
    allowInvalidType?: boolean,
    clearCurrentUserData?: undefined | boolean,
    time?: AnimateTime,
): 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<MaterialEventMap> | LineMaterialParameters & { 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.
- Optionaltime: AnimateTime
Returns this
Implementation of IMaterial.setValues
Overrides LineMaterial.setValues
- Defined in src/core/material/LineMaterial2.ts:160

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
Implementation of IMaterial.toJSON
Overrides LineMaterial.toJSON
- Defined in src/core/material/LineMaterial2.ts:181

Class LineMaterial2<TE>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LineMaterial2<TE>

Properties

alphaToCoverage

ReadonlyappliedMeshes

assetType

autoUpdateResolution

color

constructor

dashed

dashOffset

dashScale

dashSize

extraUniformsToUpload

gapSize

Optionalgenerator

ReadonlyisLineMaterial2

linewidth

materialExtensions

name

Default

registerMaterialExtensions

resolution

ReadonlysetDirty

uiConfig

unregisterMaterialExtensions

userData

Default

worldUnits

Static ReadonlyInterpolateProperties

Static ReadonlyMaterialProperties

StaticMaterialTemplate

Static ReadonlyTYPE

Static ReadonlyTypeSlug

Methods

clone

Parameters

Returns this

copy

Parameters

Returns this

customProgramCacheKey

Returns string

dispose

Returns this

fromJSON

Parameters

Returns null | LineMaterial2<TE>

onAfterRender

Parameters

Returns void

onBeforeCompile

Parameters

Returns void

onBeforeRender

Parameters

Returns void

setValues

Parameters

Returns this

toJSON

Parameters

Returns any

Settings

On This Page

`Readonly`appliedMeshes

`Optional`generator

`Readonly`isLineMaterial2

`Readonly`setDirty

`Static` `Readonly`InterpolateProperties

`Static` `Readonly`MaterialProperties

`Static`MaterialTemplate

`Static` `Readonly`TYPE

`Static` `Readonly`TypeSlug