Class CoatRemissive

A Coat providing a color and parameters for the phong shading model.

Hierarchy (view full)

CoatColored
- CoatRemissive

Index

Constructors

constructor

new CoatRemissive(_color?, _diffuse?, _specular?, _intensity?, _metallic?): CoatRemissive
Parameters
- _color: Color = ...
- _diffuse: number = 1
- _specular: number = 0.5
- _intensity: number = 0.7
- _metallic: number = 0.0
Returns CoatRemissive
Overrides CoatColored.constructor
- Defined in Source/Core/Material/CoatRemissive.ts:13

Properties

color

color: Color

diffuse

diffuse: number

intensity

intensity: number

specular

specular: number

Accessors

metallic

get metallic(): number
Returns number
- Defined in Source/Core/Material/CoatRemissive.ts:21
set metallic(_value): void
Parameters
- _value: number
Returns void
- Defined in Source/Core/Material/CoatRemissive.ts:24

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

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

deserialize

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

dispatchEvent

dispatchEvent(_event): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from CoatColored.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 CoatColored.getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:265

getMetadata

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

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

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 CoatColored.getMutator
- Defined in Source/Core/Material/CoatRemissive.ts:47

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 CoatColored.getMutatorAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:242

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 CoatColored.getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:219

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 CoatColored.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:227

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 CoatColored.mutate
- Defined in Source/Core/Serialization/Mutable.ts:294

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

serialize

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

Returns Serialization
Overrides CoatColored.serialize
- Defined in Source/Core/Material/CoatRemissive.ts:29

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 CoatColored.updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:280

`Static` getMutatorFromPath

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

Class CoatRemissive

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CoatRemissive

Properties

color

diffuse

intensity

specular

Accessors

metallic

Returns number

Parameters

Returns void

type

Returns string

Methods

addEventListener

Parameters

Returns void

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getMutator

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Parameters

Returns MutatorForAnimation

getMutatorForUserInterface

Parameters

Returns MutatorForUserInterface

mutate

Parameters

Returns Promise<void>

removeEventListener

Parameters

Returns void

serialize

Returns Serialization

updateMutator

Parameters

Returns void

Static getMutatorFromPath

Parameters

Returns Mutator

Settings

Member Visibility

Theme

On This Page

`Static` getMutatorFromPath