Class LineMaterial2

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

Hierarchy

Implements

Constructors

constructor

Properties

alphaToCoverage appliedMeshes assetType color constructor dashed dashOffset dashScale dashSize extraUniformsToUpload gapSize generator? isLineMaterial2 linewidth materialExtensions name onAfterRender registerMaterialExtensions resolution setDirty uiConfig unregisterMaterialExtensions worldUnits MaterialProperties MaterialTemplate TYPE TypeSlug

Methods

clone copy customProgramCacheKey dispatchEvent dispose fromJSON onBeforeCompile setValues toJSON

Constructors

constructor

Properties

alphaToCoverage

alphaToCoverage: boolean

ReadonlyappliedMeshes

appliedMeshes: Set<IObject3D> = ...

Managed internally, do not change manually

assetType

assetType: "material" = ...

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

Optionalgenerator

generator?: IMaterialGenerator

Managed internally, do not change manually

ReadonlyisLineMaterial2

isLineMaterial2: true

linewidth

linewidth: number

materialExtensions

materialExtensions: MaterialExtension[] = []

name

name: string

Material name. Default is an empty string.

Default

''

onAfterRender

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

registerMaterialExtensions

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

resolution

resolution: Vector2

ReadonlysetDirty

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

uiConfig

uiConfig: UiObjectConfig = ...

unregisterMaterialExtensions

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

worldUnits

worldUnits: boolean

Static ReadonlyMaterialProperties

MaterialProperties: {
    alphaTest: number;
    alphaToCoverage: boolean;
    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;
} = ...

StaticMaterialTemplate

MaterialTemplate: IMaterialTemplate<
    LineMaterial2,
    Partial<
        {
            alphaTest: number;
            alphaToCoverage: boolean;
            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 ReadonlyTYPE

TYPE: "LineMaterial2" = 'LineMaterial2'

Static ReadonlyTypeSlug

TypeSlug: "lmat" = 'lmat'

Methods

clone

  • clone(): this

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

    Returns this

copy

  • copy(source: any): this

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

    Parameters

    • source: any

    Returns this

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

dispatchEvent

dispose

fromJSON

  • fromJSON(
        data: any,
        meta?: SerializationMetaType,
        _internal?: boolean,
    ): null | LineMaterial2

  • 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

    Returns null | LineMaterial2

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

setValues

  • setValues(
        parameters: Material | LineMaterialParameters & { 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 | 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.

    Returns this

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

    Returns any

    Serialize

    tags. Set it to true only if you know what you are doing. This is used in Serialization->serializer->material

Settings

Member Visibility

On This Page

Constructors
Properties
Methods