Color

class common.Color()

An object representing an RGB Color. Values are specified in the 0-255 range.

Index

Constructors

• constructor

Properties

• b
• g
• r

Methods

• black
• blue
• createFromFloat
• createFromFloatArray
• fromHexString
• fromJson
• green
• red
• white
• yellow
• assign
• copy
• equals
• fromFloatArray
• getFloatArray
• set
• setFromFloat
• toFloatArray
• toHexString
• toJson

Constructors

common.Color.constructor()

Color(r: number, g: number, b: number): Color

Creates a new color object. Values are specified in the 0-255 range.

Parameters

r: number

red color component

g: number

green color component

b: number

blue color component

Returns: Color

Properties

common.Color.b

b: number

common.Color.g

g: number

common.Color.r

r: number

Methods

static common.Color.black()

static

black(): Color

Creates a new color object initialized to black.

Returns: Color

new color object

static common.Color.blue()

static

blue(): Color

Creates a new color object initialized to blue.

Returns: Color

new color object

static common.Color.createFromFloat()

static

createFromFloat(r: number, g: number, b: number): Color

Creates a color object from floating point values. Values are specified in the 0.0-1.0 range.

Parameters

r: number

red color component

g: number

green color component

b: number

blue color component

Returns: Color

new color object

static common.Color.createFromFloatArray()

static

createFromFloatArray(values: number[]): Color

Creates a color object from an array of floating point values. Values are specified in the 0.0-1.0 range.

Parameters

values: number[]

Returns: Color

static common.Color.fromHexString()

static

fromHexString(hexString: string): Color

Creates a color object from a hexadecimal string.

Parameters

hexString: string

Hexadecimal string representation of the color.

Returns: Color

new color object

static common.Color.fromJson()

static

fromJson(objData: unknown): Color

Creates a new [[Color]] from an object given by [[toJson]].

Parameters

objData: unknown

An object given by [[toJson]].

Returns: Color

The prepared object.

static common.Color.green()

static

green(): Color

Creates a new color object initialized to green.

Returns: Color

new color object

static common.Color.red()

static

red(): Color

Creates a new color object initialized to red.

Returns: Color

new color object

static common.Color.white()

static

white(): Color

Creates a new color object initialized to white.

Returns: Color

new color object

static common.Color.yellow()

static

yellow(): Color

Creates a new color object initialized to yellow.

Returns: Color

new color object

common.Color.assign()

assign(color: Color): this

Sets this color equal to another color

Parameters

color: Color

the point whose values will be used to set this color

Returns: this

the color object

common.Color.copy()

copy(): Color

Creates a copy of this color

Returns: Color

Copy of this color

common.Color.equals()

equals(color: Color): boolean

Compares this color with another color

Parameters

color: Color

the color to compare with

Returns: boolean

True if the values of this color equal the other. False otherwise.

common.Color.fromFloatArray()

fromFloatArray(arr: number[]): void

Sets this color from an array of normalized floating point values

Parameters

arr: number[]

the array to assign from

Returns: void

common.Color.getFloatArray()

getFloatArray(): [number, number, number]

Gets an array of floating point values representing this color. Values are clamped in the 0.0 - 1.0 range.

Returns: [number, number, number]

array of floating point values for this color.

common.Color.set()

set(r: number, g: number, b: number): void

Sets the color object. Values are specified in the 0-255 range.

Parameters

r: number

red color component

g: number

green color component

b: number

blue color component

Returns: void

common.Color.setFromFloat()

setFromFloat(r: number, g: number, b: number): void

Sets the color object from floating point values. Values are specified in the 0.0-1.0 range.

Parameters

r: number

red color component

g: number

green color component

b: number

blue color component

Returns: void

common.Color.toFloatArray()

toFloatArray(arr: number[]?): number[]

Populates an array with floating point values for this color. Values are clamped in the 0.0 - 1.0 range.

Parameters

arr: number[] = …

array whose first three elements will be populated with the r,g, and b values of this color respectively.

Returns: number[]

common.Color.toHexString()

toHexString(): string

Converts the color to a hexadecimal string.

Returns: string

Hexadecimal string representation of the color.

common.Color.toJson()

toJson(): IColor

Creates an object ready for JSON serialization.

Returns: IColor

The prepared object.