Communicator.Color

 Color

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

Constructors

constructor

  • new 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

b

b: number

g

g: number

r

r: number

Methods

assign

  • Sets this color equal to another color

    Parameters

    • color: Color

      the point whose values will be used to set this color

    Returns Color

    the color object

copy

  • Creates a copy of this color

    Returns Color

    Copy of this 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.

forJson    [deprecated]

  • forJson(): Object
  • deprecated

    Use toJson instead.

    Returns Object

fromFloatArray

  • fromFloatArray(arr: number[]): void
  • Sets this color from an array of normalized floating point values

    Parameters

    • arr: number[]

    Returns void

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.

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

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

toFloatArray

  • toFloatArray(arr: number[]): void
  • 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 void

toJson

  • toJson(): Object
  • Creates an object ready for JSON serialization.

    Returns Object

    The prepared object.

Static black

  • Creates a new color object initialized to black.

    Returns Color

    new color object

Static blue

  • Creates a new color object initialized to blue.

    Returns Color

    new color object

Static createFromFloat

  • 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 createFromFloatArray

  • 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 fromJson

  • fromJson(objData: any): Color
  • Creates a new Color from an object given by toJson.

    Parameters

    • objData: any

      An object given by toJson.

    Returns Color

    The prepared object.

Static green

  • Creates a new color object initialized to green.

    Returns Color

    new color object

Static red

  • Creates a new color object initialized to red.

    Returns Color

    new color object

Static white

  • Creates a new color object initialized to white.

    Returns Color

    new color object

Static yellow

  • Creates a new color object initialized to yellow.

    Returns Color

    new color object