Class UnlitMaterial

Hierarchy (view full)

MeshBasicMaterial<IMaterialEvent, UnlitMaterialEventTypes>
- UnlitMaterial
  - MeshBasicMaterial2

Implements

IMaterial<IMaterialEvent, UnlitMaterialEventTypes>

Constructors

constructor

new UnlitMaterial(__namedParameters?): UnlitMaterial
Parameters
- __namedParameters: MeshBasicMaterialParameters & MaterialParameters & {
  customMaterialExtensions?: MaterialExtension[];
  } = {}
Returns UnlitMaterial
Overrides MeshBasicMaterial<IMaterialEvent, UnlitMaterialEventTypes>.constructor
- Defined in src/core/material/UnlitMaterial.ts:51

Properties

`Readonly` appliedMeshes

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

Managed internally, do not change manually

assetType

assetType: "material" = ...

constructor

constructor: typeof UnlitMaterial

envMap

envMap: null | ITexture = null

extraUniformsToUpload

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

`Optional` generator

generator?: IMaterialGenerator

Managed internally, do not change manually

`Readonly` isUnlitMaterial

isUnlitMaterial: true = true

materialExtensions

materialExtensions: MaterialExtension[] = []

onAfterRender

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

Type declaration

- (renderer, scene, camera, geometry, object): void
- Parameters
  - renderer: WebGLRenderer
  - scene: Scene<Event, string>
  - camera: Camera<Event, string>
  - geometry: BufferGeometry<NormalBufferAttributes, Event, string>
  - object: Object3D<Event, string>
  Returns void

onBeforeRender

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

Type declaration

- (renderer, scene, camera, geometry, object): void
- Parameters
  - renderer: WebGLRenderer
  - scene: Scene<Event, string>
  - camera: Camera<Event, string>
  - geometry: BufferGeometry<NormalBufferAttributes, Event, string>
  - object: Object3D<Event, string>
  Returns void

registerMaterialExtensions

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

Type declaration

- (this, customMaterialExtensions): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - customMaterialExtensions: MaterialExtension[]
  Returns void

`Readonly` setDirty

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

Type declaration

- (this, options?): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - Optional options: IMaterialSetDirtyOptions
  Returns void

uiConfig

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

unregisterMaterialExtensions

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

Type declaration

- (this, customMaterialExtensions): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - customMaterialExtensions: MaterialExtension[]
  Returns void

userData

userData: IMaterialUserData

`Static` `Readonly` MaterialProperties

MaterialProperties: {
    alphaMap: null;
    alphaTest: number;
    alphaToCoverage: boolean;
    aoMap: null;
    aoMapIntensity: number;
    blendDst: 205;
    blendDstAlpha: null;
    blendEquation: 100;
    blendEquationAlpha: null;
    blendSrc: 204;
    blendSrcAlpha: null;
    blending: 1;
    clipIntersection: boolean;
    clipShadows: boolean;
    clippingPlanes: null;
    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;
} = ...

Type declaration

alphaMap: null
alphaTest: number
alphaToCoverage: boolean
aoMap: null
aoMapIntensity: number
blendDst: 205
blendDstAlpha: null
blendEquation: 100
blendEquationAlpha: null
blendSrc: 204
blendSrcAlpha: null
blending: 1
clipIntersection: boolean
clipShadows: boolean
clippingPlanes: null
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;
    blendSrc: 204;
    blendSrcAlpha: null;
    blending: 1;
    clipIntersection: boolean;
    clipShadows: boolean;
    clippingPlanes: null;
    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
Returns this
Implementation of IMaterial.clone
Overrides MeshBasicMaterial.clone
- Defined in src/core/material/UnlitMaterial.ts:44

copy

copy(source): this
Parameters
- source: any
Returns this
Implementation of IMaterial.copy
Overrides MeshBasicMaterial.copy
- Defined in src/core/material/UnlitMaterial.ts:129

customProgramCacheKey

customProgramCacheKey(): string
Returns string
Implementation of IMaterial.customProgramCacheKey
Overrides MeshBasicMaterial.customProgramCacheKey
- Defined in src/core/material/UnlitMaterial.ts:68

dispatchEvent

dispatchEvent(event): void
Parameters
- event: IMaterialEvent
Returns void
Implementation of IMaterial.dispatchEvent
Overrides MeshBasicMaterial.dispatchEvent
- Defined in src/core/material/UnlitMaterial.ts:45

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
Implementation of IMaterial.dispose
Overrides MeshBasicMaterial.dispose
- Defined in src/core/material/UnlitMaterial.ts:43

fromJSON

fromJSON(data, meta?, _internal?): null | UnlitMaterial
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
- Optional meta: SerializationMetaType
- _internal: boolean = false
Returns null | UnlitMaterial
Implementation of IMaterial.fromJSON
- Defined in src/core/material/UnlitMaterial.ts:154

onBeforeCompile

onBeforeCompile(shader, renderer): void
Parameters
- shader: Shader
- renderer: WebGLRenderer
Returns void
Implementation of IMaterial.onBeforeCompile
Overrides MeshBasicMaterial.onBeforeCompile
- Defined in src/core/material/UnlitMaterial.ts:72

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> | 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
Implementation of IMaterial.setValues
Overrides MeshBasicMaterial.setValues
- Defined in src/core/material/UnlitMaterial.ts:116

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
Implementation of IMaterial.toJSON
Overrides MeshBasicMaterial.toJSON
- Defined in src/core/material/UnlitMaterial.ts:138

Class UnlitMaterial

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: MeshBasicMaterialParameters & MaterialParameters & { customMaterialExtensions?: MaterialExtension[]; } = {}

Returns UnlitMaterial

Properties

Readonly appliedMeshes

assetType

constructor

envMap

extraUniformsToUpload

Optional generator

Readonly isUnlitMaterial

materialExtensions

onAfterRender

Type declaration

Parameters

renderer: WebGLRenderer

scene: Scene<Event, string>

camera: Camera<Event, string>

geometry: BufferGeometry<NormalBufferAttributes, Event, string>

object: Object3D<Event, string>

Returns void

onBeforeRender

Type declaration

Parameters

renderer: WebGLRenderer

scene: Scene<Event, string>

camera: Camera<Event, string>

geometry: BufferGeometry<NormalBufferAttributes, Event, string>

object: Object3D<Event, string>

Returns void

registerMaterialExtensions

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

customMaterialExtensions: MaterialExtension[]

Returns void

Readonly setDirty

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Optional options: IMaterialSetDirtyOptions

Returns void

uiConfig

unregisterMaterialExtensions

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

customMaterialExtensions: MaterialExtension[]

Returns void

userData

Static Readonly MaterialProperties

Type declaration

alphaMap: null

alphaTest: number

alphaToCoverage: boolean

aoMap: null

aoMapIntensity: number

blendDst: 205

blendDstAlpha: null

blendEquation: 100

blendEquationAlpha: null

blendSrc: 204

blendSrcAlpha: null

blending: 1

clipIntersection: boolean

clipShadows: boolean

clippingPlanes: null

color: Color

colorWrite: boolean

combine: 0

depthFunc: 3

__namedParameters: MeshBasicMaterialParameters & MaterialParameters & {
customMaterialExtensions?: MaterialExtension[];
} = {}

`Readonly` appliedMeshes

`Optional` generator

`Readonly` isUnlitMaterial

`Readonly` setDirty

`Optional` options: IMaterialSetDirtyOptions

`Static` `Readonly` MaterialProperties

`Static` MaterialTemplate

`Static` `Readonly` TYPE

`Static` `Readonly` TypeSlug

`Optional` meta: SerializationMetaType