Class LineMaterial2

Hierarchy

Implements

Constructors

constructor

Properties

alphaToCoverage appliedMeshes assetType color constructor dashOffset dashScale dashSize dashed 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

Readonly appliedMeshes

appliedMeshes: Set<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>> = ...

Managed internally, do not change manually

assetType

assetType: "material" = ...

color

color: Color

constructor

constructor: typeof LineMaterial2

dashOffset

dashOffset: number

dashScale

dashScale: number

dashSize

dashSize: number

dashed

dashed: boolean

extraUniformsToUpload

extraUniformsToUpload: Record<string, IUniform<any>> = {}

gapSize

gapSize: number

Optional generator

generator?: IMaterialGenerator

Managed internally, do not change manually

Readonly isLineMaterial2

isLineMaterial2: true = true

linewidth

linewidth: number

materialExtensions

materialExtensions: MaterialExtension[] = []

name

name: string

onAfterRender

onAfterRender: ((renderer, scene, camera, geometry, object) => void) = ...

Type declaration

registerMaterialExtensions

registerMaterialExtensions: ((this, customMaterialExtensions) => void) = iMaterialCommons.registerMaterialExtensions

Type declaration

resolution

resolution: Vector2

Readonly setDirty

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

Type declaration

uiConfig

uiConfig: UiObjectConfig<any, string, any> = ...

unregisterMaterialExtensions

unregisterMaterialExtensions: ((this, customMaterialExtensions) => void) = iMaterialCommons.unregisterMaterialExtensions

Type declaration

worldUnits

worldUnits: boolean

Static Readonly MaterialProperties

MaterialProperties: {
    alphaTest: number;
    alphaToCoverage: boolean;
    blendDst: 205;
    blendDstAlpha: null;
    blendEquation: 100;
    blendEquationAlpha: null;
    blendSrc: 204;
    blendSrcAlpha: null;
    blending: 1;
    clipIntersection: boolean;
    clipShadows: boolean;
    clipping: boolean;
    clippingPlanes: null;
    color: Color;
    colorWrite: boolean;
    dashOffset: number;
    dashScale: number;
    dashSize: number;
    dashed: boolean;
    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;
} = ...

Type declaration

  • alphaTest: number
  • alphaToCoverage: boolean
  • blendDst: 205
  • blendDstAlpha: null
  • blendEquation: 100
  • blendEquationAlpha: null
  • blendSrc: 204
  • blendSrcAlpha: null
  • blending: 1
  • clipIntersection: boolean
  • clipShadows: boolean
  • clipping: boolean
  • clippingPlanes: null
  • color: Color
  • colorWrite: boolean
  • dashOffset: number
  • dashScale: number
  • dashSize: number
  • dashed: boolean
  • 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, Partial<{
              alphaTest: number;
              alphaToCoverage: boolean;
              blendDst: 205;
              blendDstAlpha: null;
              blendEquation: 100;
              blendEquationAlpha: null;
              blendSrc: 204;
              blendSrcAlpha: null;
              blending: 1;
              clipIntersection: boolean;
              clipShadows: boolean;
              clipping: boolean;
              clippingPlanes: null;
              color: Color;
              colorWrite: boolean;
              dashOffset: number;
              dashScale: number;
              dashSize: number;
              dashed: boolean;
              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

          copy

          customProgramCacheKey

          • customProgramCacheKey(): string

          • Returns string

          dispatchEvent

          dispose

          • dispose(): this

          • Disposes the material from the GPU. Set force to false if not sure the material is used by any object in the scene. // todo add check for visible in scene also? or is that overkill

            Returns this

          fromJSON

          • fromJSON(data, meta?, _internal?): 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

          setValues

          • setValues(parameters, allowInvalidType?, clearCurrentUserData?): 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<Event, string> | 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?, _internal?): any

          • Serializes this material to JSON.

            Parameters

            • Optional meta: 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

          Theme

          On This Page

          Generated using TypeDoc