Class Material

Baseclass for materials. Combines a Shader with a compatible Coat

Authors

Jirka Dell'Oro-Friedl, HFU, 2019

Hierarchy (view full)

Mutable
- Material

Implements

SerializableResource

Constructors

constructor

new Material(_name, _shader?, _coat?): Material
Parameters
- _name: string
- Optional _shader: typeof Shader
- Optional _coat: Coat
Returns Material
Overrides Mutable.constructor
- Defined in Core/Source/Material/Material.ts:13

Properties

idResource

idResource: string = undefined

name

name: string

The name to call the Material by.

Accessors

coat

get coat(): Coat
Returns the currently referenced Coat instance

Returns Coat
- Defined in Core/Source/Material/Material.ts:29
set coat(_coat): void
Makes this material reference the given Coat if it is compatible with the referenced Shader
Parameters
- _coat: Coat
Returns void
- Defined in Core/Source/Material/Material.ts:35

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
- Defined in Core/Source/Material/Material.ts:49

type

get type(): string
Retrieves the type of this mutable subclass as the name of the runtime class

Returns string
The type of the mutable
Implementation of SerializableResource.type
Inherited from Mutable.type
- Defined in Core/Source/Serialization/Mutable.ts:73

Methods

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
Inherited from Mutable.addEventListener
- Defined in Core/Source/Event/Event.ts:91

createCoatMatchingShader

createCoatMatchingShader(): Coat
Creates a new Coat instance that is valid for the Shader referenced by this material

Returns Coat
- Defined in Core/Source/Material/Material.ts:57

deserialize

deserialize(_serialization): Promise<Serializable>
Recreates this instance of Serializable with the information from the given Serialization.
Parameters
- _serialization: Serialization
Returns Promise<Serializable>
Implementation of SerializableResource.deserialize
- Defined in Core/Source/Material/Material.ts:92

dispatchEvent

dispatchEvent(_event): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from Mutable.dispatchEvent
- Defined in Core/Source/Event/Event.ts:105

getMutator

getMutator(): Mutator
Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.

Returns Mutator
Overrides Mutable.getMutator
- Defined in Core/Source/Material/Material.ts:101

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
Inherited from Mutable.getMutatorAttributeTypes
- Defined in Core/Source/Serialization/Mutable.ts:137

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
Inherited from Mutable.getMutatorForAnimation
- Defined in Core/Source/Serialization/Mutable.ts:116

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
Inherited from Mutable.getMutatorForUserInterface
- Defined in Core/Source/Serialization/Mutable.ts:123

getShader

getShader(): typeof Shader
Returns the Shader referenced by this material

Returns typeof Shader
- Defined in Core/Source/Material/Material.ts:77

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>
Inherited from Mutable.mutate
- Defined in Core/Source/Serialization/Mutable.ts:171

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
Inherited from Mutable.removeEventListener
- Defined in Core/Source/Event/Event.ts:98

serialize

serialize(): Serialization
Returns a Serialization of this object.

Returns Serialization
Implementation of SerializableResource.serialize
- Defined in Core/Source/Material/Material.ts:83

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
- Defined in Core/Source/Material/Material.ts:67

updateMutator

updateMutator(_mutator): void
Updates the values of the given mutator according to the current state of the instance
Parameters
- _mutator: Mutator
Returns void
Inherited from Mutable.updateMutator
- Defined in Core/Source/Serialization/Mutable.ts:157

`Static` getMutatorFromPath

getMutatorFromPath(_mutator, _path): Mutator
Decorator allows to attach Mutable functionality to existing classes.
Parameters
- _mutator: Mutator
- _path: string[]
Returns Mutator
Inherited from Mutable.getMutatorFromPath
- Defined in Core/Source/Serialization/Mutable.ts:58

Class Material

Authors

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Material

Properties

idResource

name

Accessors

coat

Returns Coat

Parameters

Returns void

hasTransparency

Returns boolean

type

Returns string

Methods

addEventListener

Parameters

Returns void

createCoatMatchingShader

Returns Coat

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

getMutator

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Returns MutatorForAnimation

getMutatorForUserInterface

Returns MutatorForUserInterface

getShader

Returns typeof Shader

mutate

Parameters

Returns Promise<void>

removeEventListener

Parameters

Returns void

serialize

Returns Serialization

setShader

Parameters

Returns void

updateMutator

Parameters

Returns void

Static getMutatorFromPath

Parameters

Returns Mutator

Settings

Member Visibility

Theme

On This Page

`Static` getMutatorFromPath