Class: Color::GrayScale
- Inherits:
-
Object
- Object
- Color::GrayScale
- Defined in:
- lib/color/grayscale.rb,
lib/color.rb
Overview
A colour object representing shades of grey. Used primarily in PDF document creation.
Constant Summary collapse
- PDF_FORMAT_STR =
The format of a DeviceGrey colour for PDF. In color-tools 2.0 this will be removed from this package and added back as a modification by the PDF::Writer package.
"%.3f %s"
Class Method Summary collapse
-
.from_fraction(g = 0) ⇒ Object
Creates a greyscale colour object from fractional values 0..1.
-
.from_percent(g = 0) ⇒ Object
Creates a greyscale colour object from percentages 0..100.
Instance Method Summary collapse
-
#+(other) ⇒ Object
Adds another colour to the current colour.
-
#-(other) ⇒ Object
Subtracts another colour to the current colour.
-
#==(other) ⇒ Object
Compares the other colour to this one.
-
#brightness ⇒ Object
Returns the brightness value for this greyscale value; this is the greyscale value itself.
-
#css_hsl ⇒ Object
Present the colour as an HSL HTML/CSS colour string (e.g., “hsl(180, 25%, 35%)”).
-
#css_hsla ⇒ Object
Present the colour as an HSLA (with alpha) HTML/CSS colour string (e.g., “hsla(180, 25%, 35%, 1)”).
-
#css_rgb ⇒ Object
Present the colour as an RGB HTML/CSS colour string (e.g., “rgb(0%, 50%, 100%)”).
-
#css_rgba ⇒ Object
Present the colour as an RGBA (with alpha) HTML/CSS colour string (e.g., “rgb(0%, 50%, 100%, 1)”).
-
#darken_by(percent) ⇒ Object
Darken the greyscale colour by the stated percent.
-
#g ⇒ Object
Returns the grayscale value as a fractional value of white in the range 0.0 ..
-
#g=(gg) ⇒ Object
Returns the grayscale value as a fractional value of white in the range 0.0 ..
-
#gray ⇒ Object
(also: #grey)
Returns the grayscale value as a percentage of white (100% gray is white).
-
#gray=(gg) ⇒ Object
(also: #grey=)
Sets the grayscale value as a percentage of white.
-
#html ⇒ Object
Present the colour as an HTML/CSS colour string.
-
#initialize(g = 0) ⇒ GrayScale
constructor
Creates a greyscale colour object from percentages 0..100.
- #inspect ⇒ Object
-
#lighten_by(percent) ⇒ Object
Lightens the greyscale colour by the stated percent.
-
#pdf_fill ⇒ Object
Present the colour as a DeviceGrey fill colour string for PDF.
-
#pdf_stroke ⇒ Object
Present the colour as a DeviceGrey stroke colour string for PDF.
-
#to_cmyk ⇒ Object
Convert the greyscale colour to CMYK.
-
#to_grayscale ⇒ Object
(also: #to_greyscale)
Reflexive conversion.
-
#to_hsl ⇒ Object
Returns the HSL colour encoding of the greyscale value.
-
#to_rgb(ignored = true) ⇒ Object
Convert the greyscale colour to RGB.
-
#to_yiq ⇒ Object
Returns the YIQ (NTSC) colour encoding of the greyscale value.
Constructor Details
Class Method Details
Instance Method Details
#+(other) ⇒ Object
Adds another colour to the current colour. The other colour will be converted to grayscale before addition. This conversion depends upon a #to_grayscale method on the other colour.
The addition is done using the grayscale accessor methods to ensure a valid colour in the result.
172 173 174 175 176 177 |
# File 'lib/color/grayscale.rb', line 172 def +(other) other = other.to_grayscale ng = self.dup ng.g += other.g ng end |
#-(other) ⇒ Object
Subtracts another colour to the current colour. The other colour will be converted to grayscale before subtraction. This conversion depends upon a #to_grayscale method on the other colour.
The subtraction is done using the grayscale accessor methods to ensure a valid colour in the result.
185 186 187 188 189 190 |
# File 'lib/color/grayscale.rb', line 185 def -(other) other = other.to_grayscale ng = self.dup ng.g -= other.g ng end |
#==(other) ⇒ Object
Compares the other colour to this one. The other colour will be converted to GreyScale before comparison, so the comparison between a GreyScale colour and a non-GreyScale colour will be approximate and based on the other colour’s #to_greyscale conversion. If there is no #to_greyscale conversion, this will raise an exception. This will report that two GreyScale values are equivalent if they are within COLOR_TOLERANCE of each other.
39 40 41 42 43 |
# File 'lib/color/grayscale.rb', line 39 def ==(other) other = other.to_grayscale other.kind_of?(Color::GrayScale) and ((@g - other.g).abs <= Color::COLOR_TOLERANCE) end |
#brightness ⇒ Object
Returns the brightness value for this greyscale value; this is the greyscale value itself.
140 141 142 |
# File 'lib/color/grayscale.rb', line 140 def brightness @g end |
#css_hsl ⇒ Object
Present the colour as an HSL HTML/CSS colour string (e.g., “hsl(180, 25%, 35%)”). Note that this will perform a #to_hsl operation.
82 83 84 |
# File 'lib/color/grayscale.rb', line 82 def css_hsl to_hsl.css_hsl end |
#css_hsla ⇒ Object
Present the colour as an HSLA (with alpha) HTML/CSS colour string (e.g., “hsla(180, 25%, 35%, 1)”). Note that this will perform a #to_hsl operation.
89 90 91 |
# File 'lib/color/grayscale.rb', line 89 def css_hsla to_hsl.css_hsla end |
#css_rgb ⇒ Object
Present the colour as an RGB HTML/CSS colour string (e.g., “rgb(0%, 50%, 100%)”).
70 71 72 |
# File 'lib/color/grayscale.rb', line 70 def css_rgb "rgb(%3.2f%%, %3.2f%%, %3.2f%%)" % [ gray, gray, gray ] end |
#css_rgba ⇒ Object
Present the colour as an RGBA (with alpha) HTML/CSS colour string (e.g., “rgb(0%, 50%, 100%, 1)”).
76 77 78 |
# File 'lib/color/grayscale.rb', line 76 def css_rgba "rgba(%3.2f%%, %3.2f%%, %3.2f%%, %1.2f)" % [ gray, gray, gray, 1 ] end |
#darken_by(percent) ⇒ Object
Darken the greyscale colour by the stated percent.
117 118 119 120 |
# File 'lib/color/grayscale.rb', line 117 def darken_by(percent) g = [@g - (@g * (percent / 100.0)), 0.0].max Color::GrayScale.from_fraction(g) end |
#g ⇒ Object
Returns the grayscale value as a fractional value of white in the range 0.0 .. 1.0.
152 153 154 |
# File 'lib/color/grayscale.rb', line 152 def g @g end |
#g=(gg) ⇒ Object
Returns the grayscale value as a fractional value of white in the range 0.0 .. 1.0.
162 163 164 |
# File 'lib/color/grayscale.rb', line 162 def g=(gg) @g = Color.normalize(gg) end |
#gray ⇒ Object Also known as: grey
Returns the grayscale value as a percentage of white (100% gray is white).
146 147 148 |
# File 'lib/color/grayscale.rb', line 146 def gray @g * 100.0 end |
#gray=(gg) ⇒ Object Also known as: grey=
Sets the grayscale value as a percentage of white.
156 157 158 |
# File 'lib/color/grayscale.rb', line 156 def gray=(gg) @g = Color.normalize(gg / 100.0) end |
#html ⇒ Object
Present the colour as an HTML/CSS colour string.
63 64 65 66 |
# File 'lib/color/grayscale.rb', line 63 def html gs = "%02x" % to_255 "##{gs * 3}" end |
#inspect ⇒ Object
192 193 194 |
# File 'lib/color/grayscale.rb', line 192 def inspect "Gray [%.2f%%]" % [ gray ] end |
#lighten_by(percent) ⇒ Object
Lightens the greyscale colour by the stated percent.
111 112 113 114 |
# File 'lib/color/grayscale.rb', line 111 def lighten_by(percent) g = [@g + (@g * (percent / 100.0)), 1.0].min Color::GrayScale.from_fraction(g) end |
#pdf_fill ⇒ Object
Present the colour as a DeviceGrey fill colour string for PDF. This will be removed from the default package in color-tools 2.0.
47 48 49 |
# File 'lib/color/grayscale.rb', line 47 def pdf_fill PDF_FORMAT_STR % [ @g, "g" ] end |
#pdf_stroke ⇒ Object
Present the colour as a DeviceGrey stroke colour string for PDF. This will be removed from the default package in color-tools 2.0.
53 54 55 |
# File 'lib/color/grayscale.rb', line 53 def pdf_stroke PDF_FORMAT_STR % [ @g, "G" ] end |
#to_cmyk ⇒ Object
Convert the greyscale colour to CMYK.
94 95 96 97 |
# File 'lib/color/grayscale.rb', line 94 def to_cmyk k = 1.0 - @g.to_f Color::CMYK.from_fraction(0, 0, 0, k) end |
#to_grayscale ⇒ Object Also known as: to_greyscale
Reflexive conversion.
105 106 107 |
# File 'lib/color/grayscale.rb', line 105 def to_grayscale self end |
#to_hsl ⇒ Object
Returns the HSL colour encoding of the greyscale value.
134 135 136 |
# File 'lib/color/grayscale.rb', line 134 def to_hsl Color::HSL.from_fraction(0, 0, @g) end |
#to_rgb(ignored = true) ⇒ Object
Convert the greyscale colour to RGB.
100 101 102 |
# File 'lib/color/grayscale.rb', line 100 def to_rgb(ignored = true) Color::RGB.from_fraction(g, g, g) end |
#to_yiq ⇒ Object
Returns the YIQ (NTSC) colour encoding of the greyscale value. This is an approximation, as the values for I and Q are calculated by treating the greyscale value as an RGB value. The Y (intensity or brightness) value is the same as the greyscale value.
126 127 128 129 130 131 |
# File 'lib/color/grayscale.rb', line 126 def to_yiq y = @g i = (@g * 0.596) + (@g * -0.275) + (@g * -0.321) q = (@g * 0.212) + (@g * -0.523) + (@g * 0.311) Color::YIQ.from_fraction(y, i, q) end |