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 Source/Core/Material/Material.ts:21

Properties

alphaClip

alphaClip: number = 0.01

Clipping threshold for alpha values, every pixel with alpha < alphaClip will be discarded.

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 Source/Core/Material/Material.ts:39
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 Source/Core/Material/Material.ts:45

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 Source/Core/Serialization/Mutable.ts:142

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 Source/Core/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 Source/Core/Material/Material.ts:58

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 Source/Core/Material/Material.ts:94

dispatchEvent

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

getMetaAttributeTypes

getMetaAttributeTypes(): MetaAttributeTypes
Retrieves the specified attribute types from the metadata of this instance's class.

Returns MetaAttributeTypes
Inherited from Mutable.getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:231

getMetadata

getMetadata(): Metadata
Retrieves the metadata of this instance's class.

Returns Metadata
Inherited from Mutable.getMetadata
- Defined in Source/Core/Serialization/Mutable.ts:238

getMutator

getMutator(_extendable?): 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.
Parameters
- _extendable: boolean = false
Returns Mutator
Inherited from Mutable.getMutator
- Defined in Source/Core/Serialization/Mutable.ts:150

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! This will return the decorated meta-type instead of the runtime-type of the object, if available.
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from Mutable.getMutatorAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:208

getMutatorForAnimation

getMutatorForAnimation(_extendable?): 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
Parameters
- _extendable: boolean = false
Returns MutatorForAnimation
Inherited from Mutable.getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:185

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?): 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
Parameters
- _extendable: boolean = false
Returns MutatorForUserInterface
Inherited from Mutable.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:193

getShader

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

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

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 Source/Core/Serialization/Mutable.ts:260

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 Source/Core/Event/Event.ts:98

serialize

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

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

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 Source/Core/Material/Material.ts:68

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 Source/Core/Serialization/Mutable.ts:246

`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 Source/Core/Serialization/Mutable.ts:127

Class Material

Authors

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Material

Properties

alphaClip

idResource

name

Accessors

coat

Returns Coat

Parameters

Returns void

type

Returns string

Methods

addEventListener

Parameters

Returns void

createCoatMatchingShader

Returns Coat

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getMutator

Parameters

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Parameters

Returns MutatorForAnimation

getMutatorForUserInterface

Parameters

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