Class MaterialGLTF

constructor

• new MaterialGLTF(_name, _shader?, _coat?): MaterialGLTF

• Parameters

  • _name: string
  • Optional _shader: typeof Shader
  • Optional _coat: Coat

  Returns MaterialGLTF

idResource

name

status

Readonly type

url

coat

• get coat(): Coat

• Returns the currently referenced Coat instance

  Returns Coat
• set coat(_coat): void

• Makes this material reference the given Coat if it is compatible with the referenced Shader

  Parameters

  • _coat: Coat

  Returns void

hasTransparency

• get hasTransparency(): boolean

• Returns true if the material has any areas (color or texture) with alpha < 1. ⚠️ CAUTION: Computionally expensive for textured materials, see Texture.hasTransparency

  Returns boolean

addEventListener

• addEventListener(_type, _handler, _options?): void

• See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified

  Parameters

  • _type: string
  • _handler: EventListenerUnified
  • Optional _options: boolean | AddEventListenerOptions

  Returns void

createCoatMatchingShader

• createCoatMatchingShader(): Coat

• Creates a new Coat instance that is valid for the Shader referenced by this material

  Returns Coat

deserialize

• deserialize(_serialization): Promise<Serializable>

• Parameters

  • _serialization: Serialization

  Returns Promise<Serializable>

dispatchEvent

• dispatchEvent(_event): boolean

• See EventTarget.dispatchEvent for reference. Works with with EventUnified

  Parameters

  • _event: EventUnified

  Returns boolean

getMutator

• getMutator(): Mutator

• Returns Mutator

getMutatorAttributeTypes

• getMutatorAttributeTypes(_mutator): MutatorAttributeTypes

• Returns an associative array with the same attributes as the given mutator, but with the corresponding types as string-values Does not recurse into objects!

  Parameters

  • _mutator: Mutator

  Returns MutatorAttributeTypes

getMutatorForAnimation

• getMutatorForAnimation(): MutatorForAnimation

• Collect the attributes of the instance and their values applicable for animation. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance

  Returns MutatorForAnimation

getMutatorForUserInterface

• getMutatorForUserInterface(): MutatorForUserInterface

• Collect the attributes of the instance and their values applicable for the user interface. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance

  Returns MutatorForUserInterface

getShader

• getShader(): typeof Shader

• Returns the Shader referenced by this material

  Returns typeof Shader

mutate

• mutate(_mutator, _selection?, _dispatchMutate?): Promise<void>

• Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses

  Parameters

  • _mutator: Mutator
  • _selection: string[] = null
  • _dispatchMutate: boolean = true

  Returns Promise<void>

removeEventListener

• removeEventListener(_type, _handler, _options?): void

• See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified

  Parameters

  • _type: string
  • _handler: EventListenerUnified
  • Optional _options: boolean | AddEventListenerOptions

  Returns void

serialize

• serialize(_super?): Serialization

• Returns a Serialization of this resource. By default only the data needed to load it from the external source is serialized ("url", "name", "idResource"). Set _super to true to serialize all data.

  Parameters

  • _super: boolean = false

  Returns Serialization
• serialize(): Serialization

• Returns a Serialization of this resource. By default only the data needed to load it from the external source is serialized ("url", "name", "idResource"). Set _super to true to serialize all data.

  Returns Serialization

setShader

• setShader(_shaderType): void

• Changes the materials reference to the given Shader, creates and references a new Coat instance
  and mutates the new coat to preserve matching properties.

  Parameters

  • _shaderType: typeof Shader

  Returns void

updateMutator

• updateMutator(_mutator): void

• Updates the values of the given mutator according to the current state of the instance

  Parameters

  • _mutator: Mutator

  Returns void

Static getMutatorFromPath

• getMutatorFromPath(_mutator, _path): Mutator

• Decorator allows to attach Mutable functionality to existing classes.

  Parameters

  • _mutator: Mutator
  • _path: string[]

  Returns Mutator