Class Color

Defines a color as values in the range of 0 to 1 for the four channels red, green, blue and alpha (for opacity)

Hierarchy (view full)

Mutable
- Color

Implements

Constructors

constructor

new Color(_r?, _g?, _b?, _a?): Color
Parameters
- _r: number = 1
- _g: number = 1
- _b: number = 1
- _a: number = 1
Returns Color
Overrides Mutable.constructor
- Defined in Source/Core/Material/Color.ts:18

Properties

a

a: number

b

b: number

g

g: number

r

r: number

Accessors

clone

get clone(): Color
Creates and returns a clone of this color.

Returns Color
- Defined in Source/Core/Material/Color.ts:55

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

Methods

add

add(_color): Color
Adds the given color to this.
Parameters
- _color: Color
Returns Color
- Defined in Source/Core/Material/Color.ts:176

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

copy

copy(_color): Color
Copies the color channels of the given color into this color and returns it.
Parameters
- _color: Color
Returns Color
- Defined in Source/Core/Material/Color.ts:62

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 Serializable.deserialize
- Defined in Source/Core/Material/Color.ts:222

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

get

get(): Float32Array
Returns an array of the color channels of this color.

Returns Float32Array
- Defined in Source/Core/Material/Color.ts:132

getBytes

getBytes(): Uint8ClampedArray
Returns a Uint8ClampedArray of the color channels of this color.

Returns Uint8ClampedArray
- Defined in Source/Core/Material/Color.ts:139

getCSS

getCSS(): string
Returns the css color keyword representing this color.

Returns string
- Defined in Source/Core/Material/Color.ts:146

getHex

getHex(): string
Returns the hex string representation of this color.

Returns string
- Defined in Source/Core/Material/Color.ts:154

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

multiply

multiply(_color): Color
Multiplies this with the given color.
Parameters
- _color: Color
Returns Color
- Defined in Source/Core/Material/Color.ts:187
multiply(_scalar): Color
Multiplies this with the given scalar.
Parameters
- _scalar: number
Returns Color
- Defined in Source/Core/Material/Color.ts:191

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

recycle

recycle(): void
Recycles the object for the next reuse by setting its properties to their default states.

Returns void
Implementation of Recycable.recycle
- Defined in Source/Core/Material/Color.ts:70

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 Serializable.serialize
- Defined in Source/Core/Material/Color.ts:215

set

set(_r, _g, _b, _a): Color
Sets the color channels of this color.
Parameters
- _r: number
- _g: number
- _b: number
- _a: number
Returns Color
- Defined in Source/Core/Material/Color.ts:124

setBytes

setBytes(_r, _g, _b, _a): Color
Sets this color from the given 8-bit values for the color channels.
Parameters
- _r: number
- _g: number
- _b: number
- _a: number
Returns Color
- Defined in Source/Core/Material/Color.ts:87
setBytes(_rgba): Color
Sets this color from the given Uint8ClampedArray.
Parameters
- _rgba: Uint8ClampedArray
Returns Color
- Defined in Source/Core/Material/Color.ts:91

setCSS

setCSS(_keyword, _alpha?): Color
Sets this color from the given css color keyword. Optinally sets the alpha value to the given value.
Parameters
- _keyword: string
- Optional _alpha: number
Returns Color
- Defined in Source/Core/Material/Color.ts:77

setClamped

setClamped(_r, _g, _b, _a): Color
Sets the color channels of this color and clamps them between 0 and 1.
Parameters
- _r: number
- _g: number
- _b: number
- _a: number
Returns Color
- Defined in Source/Core/Material/Color.ts:103
setClamped(_rgba): Color
Sets this color from the given Float32Array while clamping the values between 0 and 1.
Parameters
- _rgba: Float32Array
Returns Color
- Defined in Source/Core/Material/Color.ts:107

setHex

setHex(_hex): Color
Sets this color from the given hex string color.
Parameters
- _hex: string
Returns Color
- Defined in Source/Core/Material/Color.ts:165

toString

toString(): string
Returns a formatted string representation of this color

Returns string
- Defined in Source/Core/Material/Color.ts:210

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` CSS

CSS(_keyword, _alpha?): Color
Returns a new Color object created from the given css color keyword. Passing an _alpha value will override the alpha value specified in the keyword.
Parameters
- _keyword: string
- Optional _alpha: number
Returns Color
- Defined in Source/Core/Material/Color.ts:36

`Static` PRODUCT

PRODUCT(_clrA, _clrB): Color
Computes and retruns the product of two colors.
Parameters
- _clrA: Color
- _clrB: Color
Returns Color
- Defined in Source/Core/Material/Color.ts:43
PRODUCT(_color, _scalar): Color
Computes and retruns the product of a color with a scalar value.
Parameters
- _color: Color
- _scalar: number
Returns Color
- Defined in Source/Core/Material/Color.ts:47

`Static` getBytesFromCSS

getBytesFromCSS(_keyword): Uint8ClampedArray
Returns a Uint8ClampedArray with the 8-bit color channels in the order RGBA.
Parameters
- _keyword: string
Returns Uint8ClampedArray
- Defined in Source/Core/Material/Color.ts:26

`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 Color

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Color

Properties

a

b

g

r

Accessors

clone

Returns Color

type

Returns string

Methods

add

Parameters

Returns Color

addEventListener

Parameters

Returns void

copy

Parameters

Returns Color

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

get

Returns Float32Array

getBytes

Returns Uint8ClampedArray

getCSS

Returns string

getHex

Returns string

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getMutator

Parameters

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Parameters

Returns MutatorForAnimation

getMutatorForUserInterface

Parameters

Returns MutatorForUserInterface

multiply

Parameters

Returns Color

Parameters

Returns Color

mutate

Parameters

Returns Promise<void>

recycle

Returns void

removeEventListener

Parameters

Returns void

serialize

Returns Serialization

set

Parameters

Returns Color

`Static` CSS

`Static` PRODUCT

`Static` getBytesFromCSS

`Static` getMutatorFromPath