Color.js

  1. /*
  2.  * Copyright 2020 WICKLETS LLC
  3.  *
  4.  * This file is part of Wick Engine.
  5.  *
  6.  * Wick Engine is free software: you can redistribute it and/or modify
  7.  * it under the terms of the GNU General Public License as published by
  8.  * the Free Software Foundation, either version 3 of the License, or
  9.  * (at your option) any later version.
  10.  *
  11.  * Wick Engine is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with Wick Engine.  If not, see <https://www.gnu.org/licenses/>.
  18.  */
  20. /* Small utility class for colors. */
  21. Wick.Color = class {
  22.     /**
  23.      * Creates a Transformation.
  24.      * @param {string} color - (Optional) Hex or Rgba color to create a Wick.Color from.
  25.      */
  26.     constructor (color) {
  27.         if(color) {
  28.             this._color = new paper.Color(color);
  29.         } else {
  30.             this._color = new paper.Color();
  31.         }
  32.     }
  34.     /**
  35.      * The red value of the color. Ranges from 0.0 to 1.0.
  36.      * @type {Number}
  37.      */
  38.     get r () {
  39.         return this._color.red;
  40.     }
  42.     set r (r) {
  43.         this._color.red = r;
  44.     }
  46.     /**
  47.      * The green value of the color. Ranges from 0.0 to 1.0.
  48.      * @type {Number}
  49.      */
  50.     get g () {
  51.         return this._color.green;
  52.     }
  54.     set g (g) {
  55.         this._color.green = g;
  56.     }
  58.     /**
  59.      * The blue value of the color. Ranges from 0.0 to 1.0.
  60.      * @type {Number}
  61.      */
  62.     get b () {
  63.         return this._color.blue;
  64.     }
  66.     set b (b) {
  67.         this._color.blue = b;
  68.     }
  70.     /**
  71.      * The alpha value of the color. Ranges from 0.0 to 1.0.
  72.      * @type {Number}
  73.      */
  74.     get a () {
  75.         return this._color.alpha;
  76.     }
  78.     set a (a) {
  79.         this._color.alpha = a;
  80.     }
  82.     /**
  83.      * The color as a hex string. Example: "#AABBCC"
  84.      * @type {String}
  85.      */
  86.     get hex () {
  87.         return this._color.toCSS(true);
  88.     }
  90.     /**
  91.      * The color as an rgba string. Example: "rgba(r,g,b,a)"
  92.      */
  93.     get rgba () {
  94.         return this._color.toCSS();
  95.     }
  97.     /**
  98.      * Adds together the r, g, and b values of both colors and produces a new color.
  99.      * @param {Wick.Color} color - the color to add to this color
  100.      * @returns {Wick.Color} the resulting color
  101.      */
  102.     add (color) {
  103.         var newColor = new Wick.Color();
  104.         newColor.r = this.r + color.r;
  105.         newColor.g = this.g + color.g;
  106.         newColor.b = this.b + color.b;
  107.         return newColor;
  108.     }
  110.     /**
  111.      * Multiplies the r, g, and b values of both colors to produce a new color.
  112.      * @param {Wick.Color} color - the color to multiply with this color
  113.      * @returns {Wick.Color} the resulting color
  114.      */
  115.     multiply (n) {
  116.         var newColor = new Wick.Color();
  117.         newColor.r = this.r * n;
  118.         newColor.g = this.g * n;
  119.         newColor.b = this.b * n;
  120.         return newColor;
  121.     }
  123.     /**
  124.      * Averages the r, g, and b values of two colors.
  125.      * @param {Wick.Color} colorA - a color to average with another color (order does not matter)
  126.      * @param {Wick.Color} colorB - a color to average with another color (order does not matter)
  127.      * @returns {Wick.Color} The resulting averaged color.
  128.      */
  129.     static average (colorA, colorB) {
  130.         return colorA.multiply(0.5).add(colorB.multiply(0.5));
  131.     }
  132. }