Class: Colours::Colour

Inherits:
Object
  • Object
show all
Defined in:
lib/colours/colour/colour.rb

Overview

Colours::Colour

Instance Method Summary collapse

Constructor Details

#initialize(optional_input = nil) ⇒ Colour

#

initialize

#


17
18
19
20
21
22
 
# File 'lib/colours/colour/colour.rb', line 17

def initialize(
    optional_input = nil
  )
  reset
  set_input(optional_input) if optional_input
end

Instance Method Details

#b? ⇒ Boolean

#

b?

#

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/colours/colour/colour.rb', line 100

def b?
  @b
end

#build_this_rgb_string(r, g, b) ⇒ Object

#

build_this_rgb_string

#


138
139
140
 
# File 'lib/colours/colour/colour.rb', line 138

def build_this_rgb_string(r, g, b)
  Colours.build_this_rgb_string(r,g,b)
end

#g? ⇒ Boolean

#

g?

#

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/colours/colour/colour.rb', line 93

def g?
  @g
end

#output_this_string(i = DEFAULT_TEXT+N, r = r?, , g = g?, , b = b? ) ⇒ Object Also known as: output_this, output, write_this_in_random_colour

#

output_this_string

#


107
108
109
110
111
112
113
114
115
 
# File 'lib/colours/colour/colour.rb', line 107

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? ⇒ Boolean

#

r?

#

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/colours/colour/colour.rb', line 86

def r?
  @r
end

#random_colour(this_string_to_display = 'test') ⇒ Object Also known as: return_random_colour

#

random_colour

Return a random colour here.

#


147
148
149
150
151
 
# File 'lib/colours/colour/colour.rb', line 147

def random_colour(this_string_to_display = 'test')
  return_this_string(
    this_string_to_display, random_value, random_value, random_value
  )
end

#random_colour?(optional_text = nil) ⇒ Boolean

#

random_colour?

#

Returns:

  • (Boolean) 


48
49
50
51
52
53
54
55
56
 
# File 'lib/colours/colour/colour.rb', line 48

def random_colour?(
    optional_text = nil
  )
  if optional_text
    write_this_in_random_colour(optional_text)
  else
    ::Colours.random_colour?
  end
end

#random_value ⇒ Object

#

random_value

#


165
166
167
 
# File 'lib/colours/colour/colour.rb', line 165

def random_value
  rand(255)
end

#reset ⇒ Object

#

reset

#


77
78
79
80
81
 
# File 'lib/colours/colour/colour.rb', line 77

def reset
  set_r
  set_g
  set_b
end

#return_this_string(i = DEFAULT_TEXT+N, r = r?, , g = g?, , b = b? ) ⇒ Object

#

return_this_string

#


122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/colours/colour/colour.rb', line 122

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 ⇒ Object

#

seed_rgb_values

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

#


158
159
160
 
# File 'lib/colours/colour/colour.rb', line 158

def seed_rgb_values
  set_rgb(random_value, random_value, random_value)
end

#set_b(i = nil) ⇒ Object

#

set_b

#


41
42
43
 
# File 'lib/colours/colour/colour.rb', line 41

def set_b(i = nil)
  @b = i
end

#set_g(i = nil) ⇒ Object

#

set_g

#


34
35
36
 
# File 'lib/colours/colour/colour.rb', line 34

def set_g(i = nil)
  @g = i
end

#set_input(i = nil) ⇒ Object

#

set_input

#


70
71
72
 
# File 'lib/colours/colour/colour.rb', line 70

def set_input(i = nil)
  @input = i
end

#set_r(i = nil) ⇒ Object

#

set_r

#


27
28
29
 
# File 'lib/colours/colour/colour.rb', line 27

def set_r(i = nil)
  @r = i
end

#set_rgb(r, g, b) ⇒ Object

#

set_rgb

#


61
62
63
64
65
 
# File 'lib/colours/colour/colour.rb', line 61

def set_rgb(r,g,b)
  set_r(r)
  set_g(g)
  set_b(b)
end