Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Color

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Color(r: number, g: number, b: number, a?: number): Color
  • new Color(rgb: number[]): Color

Properties

elements

elements: number[] = []

Static N_DIMENSIONS

N_DIMENSIONS: number = 4

Accessors

RGBuintAfloat

  • get RGBuintAfloat(): { a: number; b: number; g: number; r: number }

Vec4

a

  • get a(): number
  • set a(value: number): void

b

  • get b(): number
  • set b(value: number): void

g

  • get g(): number
  • set g(value: number): void

nDimensions

  • get nDimensions(): number

r

  • get r(): number
  • set r(value: number): void

rgba

  • get rgba(): number[]

serializationLabel

  • get serializationLabel(): any

x

  • get x(): number
  • set x(val: number): void

y

  • get y(): number
  • set y(val: number): void

Methods

Darken

  • Darken(percent: number): Color

Desaturate

  • Desaturate(percent: number): Color

L2

  • L2(): number

Spun

  • Spun(angle: number): Color

_setToDefault

  • _setToDefault(): void

_tinycolor

  • _tinycolor(): Instance

addVector

asThreeJS

  • asThreeJS(): Color

clone

dot

fmax

  • fmax(): number

forEach

  • forEach(fn: (e: number, i: number) => any, context: any): void

  • Parameters

    • fn: (e: number, i: number) => any

      function to be executed on each element

        • (e: number, i: number): any

        • Parameters

          • e: number
          • i: number

          Returns any

    • context: any

      context for execution

    Returns void

getMapped

  • getMapped(fn: (e: number, i: number) => number, context?: any): Color

  • Returns a VectorType with each of its elements replaced by fn(e) where e is the corresponding element of this vector

    Parameters

    • fn: (e: number, i: number) => number

      function to be run on each element. e is the element value, and i is its index. Should return a new element.

        • (e: number, i: number): number

        • Parameters

          • e: number
          • i: number

          Returns number

    • Optional context: any

      the context for the function call. In other words, what is to be used as the 'this' variable when running the call.

    Returns Color

    • Vectgor of the results from running fn on each element of this.elements

getNormalized

getRounded

inspect

  • inspect(): string

isEqualTo

  • isEqualTo(other: VectorType, tolerance?: number): boolean

minus

normalize

  • normalize(): void

plus

setElements

  • setElements(els: number[]): Color

setRGBuintAfloat

  • setRGBuintAfloat(r: number | {}, g?: number, b?: number, a?: number): void

sstring

  • sstring(): string

subtractVector

times

timesElementWise

toHex

  • toHex(): number

toHexString

  • toHexString(): string

toJSON

  • toJSON(): {}

toRGBAString

  • toRGBAString(): string

toString

  • toString(): string

Static FromHSVA

  • FromHSVA(h: number, s: number, v: number, a?: number): Color

Static FromRGBA

  • FromRGBA(r: number, g: number, b: number, a?: number): Color
  • FromRGBA(rbga: number[]): Color

Static FromRGBuintAfloat

  • FromRGBuintAfloat(r: number | {}, g?: number, b?: number, a?: number): Color

Static FromString

  • FromString(colorString: string, alpha?: number): Color

Static FromTHREEVector4

  • FromTHREEVector4(vector4: Vector4): Color

Static FromThreeJS

  • FromThreeJS(threecolor: Color): Color

Static FromTinyColor

  • FromTinyColor(tc: TinyColor): Color

Static Ones

Static Random

Static RandomRGBA

Static ThreeJS

  • ThreeJS(hexstring: string): Color
  • ThreeJS(hex: number): Color

Static Zeros

Static flatten

  • flatten(...vecs: (number | any[] | ExtendsVector)[]): number[]

Generated using TypeDoc