redgreenblue 0.14.0 → 0.17.0

data/lib/redgreenblue/hsl.rb

@@ -1,15 +1,11 @@
 require 'redgreenblue/hsx_shared'
 require 'redgreenblue/math'
 
-class RGB
-
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
+class RGB::Color
 
   class << self
 
-    # Creates a new RGB object from HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
+    # Creates a new RGB::Color from HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
     def hsl(*a)
       new hsl_to_values(*a)
     end
@@ -23,10 +19,6 @@ class RGB
 
   end
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
-
   # Returns color as HSL:
   # hue (0..360), saturation (0..1), lightness (0..1).
   # When saturation is 0, hue is nil.
@@ -51,7 +43,7 @@ class RGB
 
   # Sets red, green, and blue using HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
   def hsl=(*a)
-    self.values = RGB.hsl_to_values(*a)
+    self.values = RGB::Color.hsl_to_values(*a)
   end
 
   # Sets HSL-hue to a number of degrees (0..360) or nil.
@@ -84,7 +76,7 @@ class RGB
     self
   end
 
-  # Creates one or more new RGB objects by rotating this object's HSL-hue a number of degrees.
+  # Creates one or more new RGB::Color objects by rotating this object's HSL-hue a number of degrees.
   def hsl_rotate(a_degrees, *b_degrees)
     if a_degrees.class != Array and b_degrees.none?
       RGB.hsl zip_add(hsl, [a_degrees, 0, 0])
@@ -94,3 +86,17 @@ class RGB
   end
 
 end
+
+
+module RGB
+
+  class << self
+
+    # Creates a new RGB::Color from HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
+    def hsl(*a)
+      Color.hsl(*a)
+    end
+
+  end
+
+end

data/lib/redgreenblue/hsv.rb

@@ -1,15 +1,11 @@
 require 'redgreenblue/hsx_shared'
 require 'redgreenblue/math'
 
-class RGB
-
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
+class RGB::Color
 
   class << self
 
-    # Creates a new RGB object from HSV values: hue (0..360), saturation (0..1), and value (0..1).
+    # Creates a new RGB::Color from HSV values: hue (0..360), saturation (0..1), and value (0..1).
     def hsv(*a)
       new hsv_to_values(*a)
     end
@@ -23,10 +19,6 @@ class RGB
 
   end
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
-
   # Returns color as HSV:
   # hue (0..360), saturation (0..1), value (0..1).
   # When saturation is 0, hue is nil.
@@ -51,7 +43,7 @@ class RGB
 
   # Sets red, green, and blue using HSV values: hue (0..360), saturation (0..1), and value (0..1).
   def hsv=(*a)
-    self.values = RGB.hsv_to_values(*a)
+    self.values = RGB::Color.hsv_to_values(*a)
   end
 
   # Sets HSV-hue to a number of degrees (0..360) or nil.
@@ -84,7 +76,7 @@ class RGB
     self
   end
 
-  # Creates one or more new RGB objects by rotating this object's HSV-hue a number of degrees.
+  # Creates one or more new RGB::Color objects by rotating this object's HSV-hue a number of degrees.
   def hsv_rotate(a_degrees, *b_degrees)
     if a_degrees.class != Array and b_degrees.none?
       RGB.hsv zip_add(hsv, [a_degrees, 0, 0])
@@ -94,3 +86,17 @@ class RGB
   end
 
 end
+
+
+module RGB
+
+  class << self
+
+    # Creates a new RGB::Color from HSV values: hue (0..360), saturation (0..1), and value (0..1).
+    def hsv(*a)
+      Color.hsv(*a)
+    end
+
+  end
+
+end

data/lib/redgreenblue/hsx_shared.rb

@@ -1,8 +1,4 @@
-class RGB
-
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
+class RGB::Color
 
   class << self
 
@@ -48,10 +44,6 @@ class RGB
 
   end
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
-
   private
 
   # Compute HSL, HSV, and chroma.

data/lib/redgreenblue/hwb.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
   # Returns the color's hue (0..360), whiteness (0..1), and blackness (0..1), as defined by the HWB color model.
   #

data/lib/redgreenblue/inspect.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
   private
 
@@ -32,7 +32,7 @@ class RGB
   #
   # You can choose among several inspect styles. See the styles, style, and style= class methods.
   def inspect
-    send "_inspect_#{self.class.style}"
+    send "_inspect_#{RGB.style}"
   end
 
   # Returns a string representation of the object.
@@ -40,34 +40,43 @@ class RGB
     _inspect_default
   end
 
-  # Returns the base inspect style, dependent on the COLORTERM environment variable.
-  def self.base_style
-    if styles.include? ENV['REDGREENBLUE_STYLE']
-      ENV['REDGREENBLUE_STYLE']
-    else
-      if ENV['COLORTERM'] == 'truecolor'
-        'simple'
+end
+
+
+module RGB
+
+  class << self
+
+    # Returns the base inspect style, dependent on the COLORTERM environment variable.
+    def base_style
+      if styles.include? ENV['REDGREENBLUE_STYLE']
+        ENV['REDGREENBLUE_STYLE']
       else
-        'default'
+        if ENV['COLORTERM'] == 'truecolor'
+          'simple'
+        else
+          'default'
+        end
       end
     end
-  end
 
-  # Returns the current inspect style.
-  def self.style
-    @@style ||= base_style
-  end
+    # Returns the current inspect style.
+    def style
+      @@style ||= base_style
+    end
 
-  # Returns a list of all available inspect styles.
-  def self.styles
-    ( self.instance_methods + self.private_instance_methods ).grep( /^_inspect_(.*)/ ) { $1 }.sort
-  end
+    # Returns a list of all available inspect styles.
+    def styles
+      ( Color.instance_methods + Color.private_instance_methods ).grep( /^_inspect_(.*)/ ) { $1 }.sort
+    end
+
+    # Selects an inspect style.
+    #
+    # Only the first few characters of your preferred style are required.
+    def style=(s)
+      @@style = styles.grep( /^#{s.to_s.downcase}/ ).first || style
+    end
 
-  # Selects an inspect style.
-  #
-  # Only the first few characters of your preferred style are required.
-  def self.style=(s)
-    @@style = styles.grep( /^#{s.to_s.downcase}/ ).first || style
   end
 
 end

data/lib/redgreenblue/int.rb

@@ -1,11 +1,11 @@
-class RGB
+class RGB::Color
 
   # Returns the color as a 24-bit integer in the range 0..16777215.
   def to_i
     ( r << 16 ) + ( g << 8 ) + b
   end
 
-  # Creates a new RGB object from a 24-bit integer in the range 0..16777215.
+  # Creates a new RGB::Color from a 24-bit integer in the range 0..16777215.
   def self.at(number)
     n = number.to_i
     if (0..16777215) === n
@@ -20,3 +20,17 @@ class RGB
   end
 
 end
+
+
+module RGB
+
+  class << self
+
+    # Creates a new RGB::Color from a 24-bit integer in the range 0..16777215.
+    def at(number)
+      Color.at(number)
+    end
+
+  end
+
+end

data/lib/redgreenblue/lazy.rb

@@ -1,22 +1,19 @@
-class RGB
+class RGB::Color
 
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
 
   class << self
 
-    # Creates a white RGB object.
+    # Creates a white RGB::Color.
     def white
       new(1,1,1)
     end
 
-    # Creates a black RGB object.
+    # Creates a black RGB::Color.
     def black
       new(0,0,0)
     end
 
-    # Creates a grey RGB object. Defaults to lightness 0.5, a middle grey. Black equals grey(0), white equals grey(1).
+    # Creates a grey RGB::Color. Defaults to lightness 0.5, a middle grey. Black equals grey(0), white equals grey(1).
     #
     # ::gray is an alias for ::grey.
     def grey(lightness=0.5)
@@ -26,32 +23,32 @@ class RGB
     # Alias gray for grey.
     alias gray grey
 
-    # Creates a pure red RGB object.
+    # Creates a pure red RGB::Color.
     def red
       new(1,0,0)
     end
 
-    # Creates a pure green RGB object.
+    # Creates a pure green RGB::Color.
     def green
       new(0,1,0)
     end
 
-    # Creates a pure blue RGB object.
+    # Creates a pure blue RGB::Color.
     def blue
       new(0,0,1)
     end
 
-    # Creates a yellow RGB object.
+    # Creates a yellow RGB::Color.
     def yellow
       new(1,1,0)
     end
 
-    # Creates a cyan RGB object.
+    # Creates a cyan RGB::Color.
     def cyan
       new(0,1,1)
     end
 
-    # Creates a magenta RGB object.
+    # Creates a magenta RGB::Color.
     def magenta
       new(1,0,1)
     end
@@ -71,3 +68,74 @@ class RGB
   end
 
 end
+
+
+module RGB
+
+  class << self
+
+    # Creates a white RGB::Color.
+    def white
+      Color.white
+    end
+
+    # Creates a black RGB::Color.
+    def black
+      Color.black
+    end
+
+    # Creates a grey RGB::Color. Defaults to lightness 0.5, a middle grey. Black equals grey(0), white equals grey(1).
+    #
+    # ::gray is an alias for ::grey.
+    def grey(lightness=0.5)
+      Color.grey(lightness)
+    end
+
+    # Alias gray for grey.
+    alias gray grey
+
+    # Creates a pure red RGB::Color.
+    def red
+      Color.red
+    end
+
+    # Creates a pure green RGB::Color.
+    def green
+      Color.green
+    end
+
+    # Creates a pure blue RGB::Color.
+    def blue
+      Color.blue
+    end
+
+    # Creates a yellow RGB::Color.
+    def yellow
+      Color.yellow
+    end
+
+    # Creates a cyan RGB::Color.
+    def cyan
+      Color.cyan
+    end
+
+    # Creates a magenta RGB::Color.
+    def magenta
+      Color.magenta
+    end
+
+    # Returns the 8 corners of the RGB cube.
+    def corners
+      [ black, red, yellow, green, cyan, blue, magenta, white ]
+    end
+
+    # Returns the centre of the RGB cube.
+    def centre
+      grey
+    end
+
+    alias center centre
+
+  end
+
+end

data/lib/redgreenblue/mac.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
   # Returns the color in the format used by AppleScript (a 48-bit RGB triplet).
   def applescript

data/lib/redgreenblue/match.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
   # Matches this color to a set of colors by calculating their euclidean distance.
   #
@@ -18,4 +18,32 @@ class RGB
     others.map { |c| [ c, de76(c) ] }.sort_by { |a| a[1] }
   end
 
+  # Matches this (reference) color to a set of colors using the CIE 1994 delta E formula.
+  #
+  # Returns the given set of colors with their difference from this color, sorted by difference (nearest color first).
+  #
+  # By default uses parameters for use in graphic arts, and reference conditions.
+  # Parameters (k1, k2, kl, kc, kh) can be individually overriden for different applications and for variations in conditions.
+  def match_de94(others, k1: 0.045, k2: 0.015, kl: 1, kc: 1, kh: 1)
+    others.map { |c| [ c, de94(c, k1: k1, k2: k2, kl: kl, kc: kc, kh: kh) ] }.sort_by { |a| a[1] }
+  end
+
+  # Matches this (reference) color to a set of colors using the CIE 1994 delta E formula.
+  #
+  # For use in graphic arts, under reference conditions.
+  #
+  # Returns the given set of colors with their difference from this color, sorted by difference (nearest color first).
+  def match_de94g(others)
+    others.map { |c| [ c, de94g(c) ] }.sort_by { |a| a[1] }
+  end
+
+  # Matches this (reference) color to a set of colors using the CIE 1994 delta E formula.
+  #
+  # For use with textiles, under reference conditions.
+  #
+  # Returns the given set of colors with their difference from this color, sorted by difference (nearest color first).
+  def match_de94t(others)
+    others.map { |c| [ c, de94t(c) ] }.sort_by { |a| a[1] }
+  end
+
 end

data/lib/redgreenblue/math.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
 private
 

data/lib/redgreenblue/misc.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
   # Inverts the object's color.
   def invert!
@@ -6,7 +6,7 @@ class RGB
     self
   end
 
-  # Creates a new RGB object with the inverted color of this RGB object.
+  # Creates a new RGB::Color with the inverted color of this RGB object.
   def invert
     dup.invert!
   end
@@ -17,23 +17,23 @@ class RGB
     values.min == values.max
   end
 
-  # Returns an array of RGB objects for all possible ways in which the red, green, and blue values of this object can be exchanged.
+  # Returns an array of RGB::Colors for all possible ways in which the red, green, and blue values of this object can be exchanged.
   #
   # Example: RGB.red.permutation returns [ RGB.red, RGB.green, RGB.blue ].
   # See also: shuffle.
   def permutation
-    values.permutation.to_a.uniq.map { |v| RGB.new v }
+    values.permutation.to_a.uniq.map { |v| RGB::Color.new v }
   end
 
-  # Returns an array of three RGB objects, for the red, green, and blue components of this object.
+  # Returns an array of three RGB::Colors, for the red, green, and blue components of this object.
   def components
-    [ RGB.new(red,0,0), RGB.new(0,green,0), RGB.new(0,0,blue) ]
+    [ RGB::Color.new(red,0,0), RGB::Color.new(0,green,0), RGB::Color.new(0,0,blue) ]
   end
 
-  # Creates a new RGB object from three RGB objects representing the red, green, and blue components.
+  # Creates a new RGB::Color from three RGB::Colors representing the red, green, and blue components.
   def self.assemble(*a)
     v = a.flatten
-    RGB.new(v[0].red, v[1].green, v[2].blue)
+    RGB::Color.new(v[0].red, v[1].green, v[2].blue)
   end
 
   # Returns the euclidean distance between this color and another color.
@@ -50,3 +50,17 @@ class RGB
   end
 
 end
+
+
+module RGB
+
+  class << self
+
+  # Creates a new RGB::Color from three RGB::Colors representing the red, green, and blue components.
+  def assemble(*a)
+    Color.assemble(*a)
+  end
+
+  end
+
+end

data/lib/redgreenblue/mix.rb

@@ -1,14 +1,14 @@
-class RGB
+class RGB::Color
 
-  # Changes the object's color by mixing it with a portion of another RGB color.
+  # Changes the object's color by mixing it with a portion of another RGB::Color.
   def mix!(another,portion=0.5)
     self.values = mix_values(another.values, portion)
     self
   end
 
-  # Creates a new RGB object by mixing this object's color with a portion of another RGB color.
+  # Creates a new RGB::Color by mixing this object's color with a portion of another RGB::Color.
   def mix(another,portion=0.5)
-    RGB.new mix_values(another.values, portion)
+    RGB::Color.new mix_values(another.values, portion)
   end
 
   # Changes the object's color by mixing it with a portion of white.
@@ -16,7 +16,7 @@ class RGB
     mix!(RGB.white, portion)
   end
 
-  # Creates one or more new RGB objects by mixing this object's color with a portion of white.
+  # Creates one or more new RGB::Colors by mixing this object's color with a portion of white.
   def whiten(portion=0.5, *portions)
     if (portion.class != Array) and portions.none?
       mix(RGB.white, portion)
@@ -30,7 +30,7 @@ class RGB
     mix!(RGB.black, portion)
   end
 
-  # Creates one or more new RGB objects by mixing this object's color with a portion of black.
+  # Creates one or more new RGB::Colors by mixing this object's color with a portion of black.
   def blacken(portion=0.5, *portions)
     if (portion.class != Array) and portions.none?
       mix(RGB.black, portion)

data/lib/redgreenblue/name.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
   # Returns the name.
   def name

data/lib/redgreenblue/opt/philipshue.rb

@@ -2,15 +2,15 @@
 #
 # Conforms to Bridge API 1.35 for Philips Hue, published 20-Nov-2019.
 
-# Automatically load core RGB class before loading options.
+# Automatically load core RGB module before loading options.
 require 'redgreenblue'
 
-class RGB
+class RGB::Color
 
   # Only available when optional support for Philips Hue lights is loaded.
   #
   # Returns a hash with the arguments required by the Philips Hue API,
-  # to set a light to this RGB object's hue, saturation and brightness.
+  # to set a light to this RGB::Color's hue, saturation and brightness.
   #
   # Formatted as JSON, this hash can be sent to a bridge to set a light's state.
   #
@@ -22,6 +22,8 @@ class RGB
   # @example Use
   #  RGB.magenta.to_philips_hue_api_hsb_arguments
   #  => {"on"=>true, "bri"=>254, "hue"=>54613, "sat"=>254}
+  #  RGB.black.to_philips_hue_api_hsb_arguments
+  #  => {"on"=>false}
   # @return [Hash] API arguments
   def to_philips_hue_api_hsb_arguments(black_off=true)
     my_hsb = hsb

data/lib/redgreenblue/os/mac.rb

@@ -1,20 +1,20 @@
-class RGB
+class RGB::Color
 
-  # On Mac OS, shows the color picker to choose a color for the RGB object.
+  # On Mac OS, shows the color picker to choose a color for this object.
   # Not available on other platforms.
   def pick
-    result = RGB.mac_choose(self)
+    result = RGB::Color.mac_choose(self)
     if result
       self.rrggbb = result
     end
   end
 
-  # On Mac OS, shows the color picker and creates an RGB object with the chosen color.
+  # On Mac OS, shows the color picker and creates an RGB::Color with the chosen color.
   # Not available on other platforms.
   #
   # If no default color is specified, the picker defaults to a middle grey.
-  def self.pick(default_color=RGB.new)
-    result = RGB.mac_choose(default_color)
+  def self.pick(default_color=RGB::Color.new)
+    result = RGB::Color.mac_choose(default_color)
     if result
       RGB.rrggbb result
     else
@@ -62,3 +62,20 @@ class RGB
   end
 
 end
+
+
+module RGB
+
+  class << self
+
+    # On Mac OS, shows the color picker and creates an RGB::Color with the chosen color.
+    # Not available on other platforms.
+    #
+    # If no default color is specified, the picker defaults to a middle grey.
+    def pick(default_color=new)
+      Color.pick(default_color)
+    end
+
+  end
+
+end

data/lib/redgreenblue/ostwald.rb

@@ -1,6 +1,6 @@
-class RGB
+class RGB::Color
 
-  # Returns a new RGB object with this color's Ostwald full-color,
+  # Returns a new RGB::Color with this color's Ostwald full-color,
   # or nil for achromatic colors (white, greys, and black).
   #
   # The resulting color contains no white or black,
@@ -19,7 +19,7 @@ class RGB
     if color_portion == 0
       nil
     else
-      RGB.new( values.map { |v| ( ( v - white_portion ) / color_portion ).round(6) } )
+      RGB::Color.new( values.map { |v| ( ( v - white_portion ) / color_portion ).round(6) } )
     end
   end