Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MaterialStandardData

Hierarchy

  • AbstractMaterialData
    • MaterialStandardData

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new MaterialStandardData(properties?: Partial<IMaterialStandardDataPropertiesGeneric<IMapData>>, id?: string, version?: string): MaterialStandardData

  • Creates a material data object.

    Parameters

    • Optional properties: Partial<IMaterialStandardDataPropertiesGeneric<IMapData>>
    • Optional id: string

      the id

    • Optional version: string

    Returns MaterialStandardData

Accessors

alphaCutoff

  • get alphaCutoff(): number
  • set alphaCutoff(value: number): void

alphaMap

  • get alphaMap(): undefined | IMapData
  • set alphaMap(value: undefined | IMapData): void

alphaMode

aoMap

aoMapIntensity

  • get aoMapIntensity(): number
  • set aoMapIntensity(value: number): void

attenuationColor

  • get attenuationColor(): Color
  • set attenuationColor(value: Color): void

attenuationDistance

  • get attenuationDistance(): number
  • set attenuationDistance(value: number): void

bumpMap

  • get bumpMap(): undefined | IMapData
  • set bumpMap(value: undefined | IMapData): void

bumpScale

  • get bumpScale(): number
  • set bumpScale(value: number): void

clearcoat

  • get clearcoat(): number
  • set clearcoat(value: number): void

clearcoatMap

  • get clearcoatMap(): undefined | IMapData
  • set clearcoatMap(value: undefined | IMapData): void

clearcoatNormalMap

  • get clearcoatNormalMap(): undefined | IMapData
  • set clearcoatNormalMap(value: undefined | IMapData): void

clearcoatRoughness

  • get clearcoatRoughness(): number
  • set clearcoatRoughness(value: number): void

clearcoatRoughnessMap

  • get clearcoatRoughnessMap(): undefined | IMapData
  • set clearcoatRoughnessMap(value: undefined | IMapData): void

color

  • get color(): Color
  • set color(value: Color): void

convertedObject

  • get convertedObject(): {}
  • set convertedObject(value: {}): void

  • The converted object of the tree node.

    Returns {}

    • [key: string]: unknown

  • The converted object of the tree node.

    Parameters

    • value: {}
      • [key: string]: unknown

    Returns void

depthTest

  • get depthTest(): undefined | boolean
  • set depthTest(value: undefined | boolean): void

depthWrite

  • get depthWrite(): undefined | boolean
  • set depthWrite(value: undefined | boolean): void

displacementBias

  • get displacementBias(): number
  • set displacementBias(value: number): void

displacementMap

  • get displacementMap(): undefined | IMapData
  • set displacementMap(value: undefined | IMapData): void

displacementScale

  • get displacementScale(): number
  • set displacementScale(value: number): void

emissiveMap

  • get emissiveMap(): undefined | IMapData
  • set emissiveMap(value: undefined | IMapData): void

emissiveness

  • get emissiveness(): Color
  • set emissiveness(value: Color): void

envMap

  • get envMap(): undefined | string | string[]
  • set envMap(value: undefined | string | string[]): void

id

  • get id(): string

  • The ID of the tree node data.

    Returns string

ior

  • get ior(): number
  • set ior(value: number): void

map

materialOutput

  • get materialOutput(): boolean
  • set materialOutput(value: boolean): void

metalness

  • get metalness(): number
  • set metalness(value: number): void

metalnessMap

  • get metalnessMap(): undefined | IMapData
  • set metalnessMap(value: undefined | IMapData): void

metalnessRoughnessMap

  • get metalnessRoughnessMap(): undefined | IMapData
  • set metalnessRoughnessMap(value: undefined | IMapData): void

name

  • get name(): undefined | string
  • set name(value: undefined | string): void

normalMap

  • get normalMap(): undefined | IMapData
  • set normalMap(value: undefined | IMapData): void

normalScale

  • get normalScale(): number
  • set normalScale(value: number): void

opacity

  • get opacity(): number
  • set opacity(value: number): void

roughness

  • get roughness(): number
  • set roughness(value: number): void

roughnessMap

  • get roughnessMap(): undefined | IMapData
  • set roughnessMap(value: undefined | IMapData): void

shading

sheen

  • get sheen(): number
  • set sheen(value: number): void

sheenColor

  • get sheenColor(): Color
  • set sheenColor(value: Color): void

sheenColorMap

  • get sheenColorMap(): undefined | IMapData
  • set sheenColorMap(value: undefined | IMapData): void

sheenRoughness

  • get sheenRoughness(): number
  • set sheenRoughness(value: number): void

sheenRoughnessMap

  • get sheenRoughnessMap(): undefined | IMapData
  • set sheenRoughnessMap(value: undefined | IMapData): void

side

specularColor

  • get specularColor(): Color
  • set specularColor(value: Color): void

specularColorMap

  • get specularColorMap(): undefined | IMapData
  • set specularColorMap(value: undefined | IMapData): void

specularIntensity

  • get specularIntensity(): number
  • set specularIntensity(value: number): void

specularIntensityMap

  • get specularIntensityMap(): undefined | IMapData
  • set specularIntensityMap(value: undefined | IMapData): void

thickness

  • get thickness(): number
  • set thickness(value: number): void

thicknessMap

  • get thicknessMap(): undefined | IMapData
  • set thicknessMap(value: undefined | IMapData): void

transmission

  • get transmission(): number
  • set transmission(value: number): void

transmissionMap

  • get transmissionMap(): undefined | IMapData
  • set transmissionMap(value: undefined | IMapData): void

transparent

  • get transparent(): undefined | boolean
  • set transparent(value: undefined | boolean): void

updateCallback

  • get updateCallback(): null | ((newVersion: string, oldVersion: string) => void)
  • set updateCallback(value: null | ((newVersion: string, oldVersion: string) => void)): void

  • The update callback for the tree node data. This callback is called when the node is updated, e.g. when the version changes.

    Returns null | ((newVersion: string, oldVersion: string) => void)

  • The update callback for the tree node data. This callback is called when the node is updated, e.g. when the version changes.

    Parameters

    • value: null | ((newVersion: string, oldVersion: string) => void)

    Returns void

updateCallbackConvertedObject

  • get updateCallbackConvertedObject(): null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)
  • set updateCallbackConvertedObject(value: null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)): void

  • The update callback for the converted object of the tree node.

    Returns null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)

  • The update callback for the converted object of the tree node.

    Parameters

    • value: null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)

    Returns void

version

  • get version(): string

  • The version of the tree node data. If the version changes, the node data will be marked for an update. A version change can be triggered via updateVersion.

    Returns string

Methods

clone

copy

reset

  • reset(): void

updateVersion

  • updateVersion(): void