class Colours::Colour

#

This file includes a standalone Colour class, as part of the Colours namespace.

#

Public Class Methods

new( optional_input = nil ) click to toggle source
#

initialize

#
# File lib/colours/toplevel_methods/use_colours.rb, line 138
def initialize(
    optional_input = nil
  )
  reset
  set_input(optional_input) if optional_input
end

Public Instance Methods

b?() click to toggle source
#

b?

#
# File lib/colours/toplevel_methods/use_colours.rb, line 221
def b?
  @b
end
build_this_rgb_string(r, g, b) click to toggle source
#

build_this_rgb_string

#
# File lib/colours/toplevel_methods/use_colours.rb, line 259
def build_this_rgb_string(r, g, b)
  Colours.build_this_rgb_string(r,g,b)
end
g?() click to toggle source
#

g?

#
# File lib/colours/toplevel_methods/use_colours.rb, line 214
def g?
  @g
end
output( i = DEFAULT_TEXT+N, r = r?, g = g?, b = b? )
Alias for: output_this_string
output_this( i = DEFAULT_TEXT+N, r = r?, g = g?, b = b? )
Alias for: output_this_string
output_this_string( i = DEFAULT_TEXT+N, r = r?, g = g?, b = b? ) click to toggle source
#

output_this_string

#
# File lib/colours/toplevel_methods/use_colours.rb, line 228
def output_this_string(
    i = DEFAULT_TEXT+N,
    r = r?,
    g = g?,
    b = b?
  )
  result = return_this_string(i,r,g,b)
  e result
end
r?() click to toggle source
#

r?

#
# File lib/colours/toplevel_methods/use_colours.rb, line 207
def r?
  @r
end
random_colour(this_string_to_display = 'test') click to toggle source
#

random_colour

Return a random colour here.

#
# File lib/colours/toplevel_methods/use_colours.rb, line 268
def random_colour(this_string_to_display = 'test')
  return_this_string(
    this_string_to_display, random_value, random_value, random_value
  )
end
Also aliased as: return_random_colour
random_colour?( optional_text = nil ) click to toggle source
#

random_colour?

#
# File lib/colours/toplevel_methods/use_colours.rb, line 169
def random_colour?(
    optional_text = nil
  )
  if optional_text
    write_this_in_random_colour(optional_text)
  else
    ::Colours.random_colour?
  end
end
random_value() click to toggle source
#

random_value

#
# File lib/colours/toplevel_methods/use_colours.rb, line 286
def random_value
  rand(255)
end
reset() click to toggle source
#

reset

#
# File lib/colours/toplevel_methods/use_colours.rb, line 198
def reset
  set_r
  set_g
  set_b
end
return_random_colour(this_string_to_display = 'test')
Alias for: random_colour
return_this_string( i = DEFAULT_TEXT+N, r = r?, g = g?, b = b? ) click to toggle source
#

return_this_string

#
# File lib/colours/toplevel_methods/use_colours.rb, line 243
def return_this_string(
    i = DEFAULT_TEXT+N,
    r = r?,
    g = g?,
    b = b?
  )
  i = DEFAULT_TEXT if i == :default
  i = i.join(' ') if i.is_a? Array
  i = i.to_s.dup
  i = build_this_rgb_string(r, g, b)+i
  return i
end
seed_rgb_values() click to toggle source
#

seed_rgb_values

Use this method to randomly obtain R,G,B values.

#
# File lib/colours/toplevel_methods/use_colours.rb, line 279
def seed_rgb_values
  set_rgb(random_value, random_value, random_value)
end
set_b(i = nil) click to toggle source
#

set_b

#
# File lib/colours/toplevel_methods/use_colours.rb, line 162
def set_b(i = nil)
  @b = i
end
set_g(i = nil) click to toggle source
#

set_g

#
# File lib/colours/toplevel_methods/use_colours.rb, line 155
def set_g(i = nil)
  @g = i
end
set_input(i = nil) click to toggle source
#

set_input

#
# File lib/colours/toplevel_methods/use_colours.rb, line 191
def set_input(i = nil)
  @input = i
end
set_r(i = nil) click to toggle source
#

set_r

#
# File lib/colours/toplevel_methods/use_colours.rb, line 148
def set_r(i = nil)
  @r = i
end
set_rgb(r,g,b) click to toggle source
#

set_rgb

#
# File lib/colours/toplevel_methods/use_colours.rb, line 182
def set_rgb(r,g,b)
  set_r(r)
  set_g(g)
  set_b(b)
end
write_this_in_random_colour( i = DEFAULT_TEXT+N, r = r?, g = g?, b = b? )
Alias for: output_this_string