Class: Unmagic::Color::Chroma

Inherits:
Data
  • Object
show all
Includes:
Comparable
Defined in:
lib/unmagic/color.rb

Overview

OKLCH chroma unit (0-0.5)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value:) ⇒ Chroma

Returns a new instance of Chroma.

Parameters:

  • value (Numeric) —

    Chroma value (0-0.5)



232
233
234
 
# File 'lib/unmagic/color.rb', line 232

def initialize(value:)
  super(value: value.to_f.clamp(0, 0.5))
end

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value

Returns:

  • (Object) —

    the current value of value



228
229
230
 
# File 'lib/unmagic/color.rb', line 228

def value
  @value
end

Instance Method Details

#*(other) ⇒ Chroma

Returns New chroma.

Parameters:

  • other (Numeric) —

    Multiplier

Returns:



250
251
252
 
# File 'lib/unmagic/color.rb', line 250

def *(other)
  self.class.new(value: value * other.to_f)
end

#+(other) ⇒ Chroma

Returns New chroma.

Parameters:

  • other (Numeric) —

    Value to add

Returns:



262
263
264
 
# File 'lib/unmagic/color.rb', line 262

def +(other)
  self.class.new(value: value + other.to_f)
end

#-(other) ⇒ Chroma

Returns New chroma.

Parameters:

  • other (Numeric) —

    Value to subtract

Returns:



268
269
270
 
# File 'lib/unmagic/color.rb', line 268

def -(other)
  self.class.new(value: value - other.to_f)
end

#/(other) ⇒ Chroma

Returns New chroma.

Parameters:

  • other (Numeric) —

    Divisor

Returns:



256
257
258
 
# File 'lib/unmagic/color.rb', line 256

def /(other)
  self.class.new(value: value / other.to_f)
end

#<=>(other) ⇒ Integer?

Returns Comparison result.

Parameters:

  • other (Chroma, Numeric) —

    Value to compare

Returns:

  • (Integer, nil) —

    Comparison result



241
242
243
244
245
246
 
# File 'lib/unmagic/color.rb', line 241

def <=>(other)
  case other
  when Chroma, Numeric
    value <=> other.to_f
  end
end

#abs ⇒ Chroma

Returns Absolute value.

Returns:



273
274
275
 
# File 'lib/unmagic/color.rb', line 273

def abs
  self.class.new(value: value.abs)
end

#to_f ⇒ Float

Returns Chroma value.

Returns:

  • (Float) —

    Chroma value



237
 
# File 'lib/unmagic/color.rb', line 237

def to_f = value