Class ColorSelectorAbstract

ColorSelectors choose and return colors from some list or criteria.

Hierarchy (view full)

Constructors

Accessors

  • get colorNames(): string[]
  • Returns string[]

    The names of the colors that can be or have been chosen by the color selector.

  • get name(): string
  • Returns string

    The name of the selector (e.g. 'blue rgb color selector').

  • get COLOR_NAMES(): Set<string>
  • Returns Set<string>

    A Set of the names of the colors that can be or have been chosen by the color selector.

Methods

  • Select and return a Color object to be used as a background. The color will either be black (#000000), white (#FFFFFF), or a color from the selector, chosen by the getColor method.
    IMPORTANT: The sum of chanceOfBlack, chanceOfWhite, and chanceOfColor should be equal to 1.0.

    Parameters

    • chanceOfBlack: number

      The percent (0-1) chance that the chosen color will be black (#000000). The sum of all percentages should be equal to 1.0.

    • chanceOfWhite: number

      The percent (0-1) chance that the chosen color will be white (#FFFFFF). The sum of all percentages should be equal to 1.0.

    • chanceOfColor: number

      The percent (0-1) chance that the chosen color will be a color from the selector (getColor). The sum of all percentages should be equal to 1.0.

    Returns Color

  • Select and return a Color object.

    Returns Color

  • Add a Color to the list of possible color choices.

    Parameters

    Returns void

  • Returns Color

    The selected Color.
    If the list of color choices is empty, a default Color object (black) will be returned.