Module: Processing::HelperMethods
- Included in:
- App
- Defined in:
- lib/ruby-processing/helper_methods.rb
Overview
Provides some convenience methods available in vanilla processing
Instance Method Summary collapse
-
#blend_color(c1, c2, mode) ⇒ Object
Uses PImage class method under hood.
-
#buffer(buf_width = width, buf_height = height, renderer = @render_mode) {|buf| ... } ⇒ Object
Nice block method to draw to a buffer.
- #color(*args) ⇒ Object
-
#constrain(amt, low, high) ⇒ Object
explicitly provide ‘processing.org’ constrain instance method to return a float:- amt, low and high need to be floats.
-
#constrained_map(val, r_in, r_out) ⇒ Object
Explicitly provides ‘processing.org’ map instance method, where value is mapped from range 1 to range 2 where values are clamped to range 2.
-
#dist(*args) ⇒ Object
explicitly provide ‘processing.org’ dist instance method.
-
#find_method(method_name) ⇒ Object
There’s just so many functions in Processing, Here’s a convenient way to look for them.
-
#frame_rate(fps = nil) ⇒ Object
frame_rate needs to support reading and writing.
-
#grid(cols, rows, col_size = 1, row_size = 1) ⇒ Object
A nice method to run a given block for a grid.
-
#java_self ⇒ Object
Provide a convenient handle for the Java-space version of self.
-
#key ⇒ Object
Fix java conversion problems getting the last key If it’s ASCII, return the character, otherwise the integer.
-
#key_pressed? ⇒ Boolean
Is a key pressed for this frame?.
-
#lerp(start, stop, amt) ⇒ Object
explicitly provide ‘processing.org’ lerp instance method.
-
#lerp_color(*args) ⇒ Object
lerp_color takes three or four arguments, in Java that’s two different methods, one regular and one static, so:.
-
#load_strings(file_or_url) ⇒ Object
Ensure that load_strings returns a real Ruby array.
-
#map(value, start1, stop1, start2, stop2) ⇒ float
Explicitly provides ‘processing.org’ map instance method, in which value is mapped from range 1, to range 2 (NB: values are not clamped to range 1).
-
#map1d(val, r_in, r_out) ⇒ Object
ruby alternative implementation of map using range parameters (begin..end) and excluded end (begin…end) produce the same result.
-
#max(*args) ⇒ Object
explicitly provide ‘processing.org’ max instance method to return a float:- a, b and c need to be floats.
-
#min(*args) ⇒ Object
explicitly provide ‘processing.org’ min instance method to return a float:- a, b and c need to be floats.
-
#mouse_pressed? ⇒ Boolean
Is the mouse pressed for this frame?.
-
#norm(value, start, stop) ⇒ Object
explicitly provide ‘processing.org’ norm instance method.
-
#proxy_java_fields ⇒ Object
Proxy over a list of Java declared fields that have the same name as some methods.
-
#save_strings(filename, strings) ⇒ Object
Writes an array of strings to a file, one line per string.
-
#set_sketch_path(spath = nil) ⇒ Object
By default, your sketch path is the folder that your sketch is in.
-
#sketch_path ⇒ Object
Get the sketch path.
-
#thread(&block) ⇒ Object
Overrides Processing convenience function thread, which takes a String arg (for a function) to more rubylike version, takes a block…
Instance Method Details
#blend_color(c1, c2, mode) ⇒ Object
Uses PImage class method under hood
135 136 137 |
# File 'lib/ruby-processing/helper_methods.rb', line 135 def blend_color(c1, c2, mode) Java::ProcessingCore::PImage::blendColor(c1, c2, mode) end |
#buffer(buf_width = width, buf_height = height, renderer = @render_mode) {|buf| ... } ⇒ Object
Nice block method to draw to a buffer. You can optionally pass it a width, a height, and a renderer. Takes care of starting and ending the draw for you.
9 10 11 12 13 14 15 |
# File 'lib/ruby-processing/helper_methods.rb', line 9 def buffer(buf_width = width, buf_height = height, renderer = @render_mode) buf = create_graphics(buf_width, buf_height, renderer) buf.begin_draw yield buf buf.end_draw buf end |
#color(*args) ⇒ Object
33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/ruby-processing/helper_methods.rb', line 33 def color(*args) a = args[0] # convert to signed int if args.length == 1 if a.is_a?(Fixnum) && a >= 2**31 args = [a - 2**32] elsif a.is_a?(String) && a[0].eql?('#') h = a[1..-1].rjust(6, '0').prepend('ff') return color(h.hex) end end super(*args) end |
#constrain(amt, low, high) ⇒ Object
explicitly provide ‘processing.org’ constrain instance method to return a float:- amt, low and high need to be floats
130 131 132 |
# File 'lib/ruby-processing/helper_methods.rb', line 130 def constrain(amt, low, high) (low..high).clip(amt) end |
#constrained_map(val, r_in, r_out) ⇒ Object
Explicitly provides ‘processing.org’ map instance method, where value is mapped from range 1 to range 2 where values are clamped to range 2.
83 84 85 86 87 88 89 90 91 |
# File 'lib/ruby-processing/helper_methods.rb', line 83 def constrained_map(val, r_in, r_out) unless r_in.include? val return r_out.begin if (val < r_in.begin && r_in.begin < r_in.end) || (val > r_in.begin && r_in.begin > r_in.end) return r_out.end end r_out.begin + (r_out.end - r_out.begin) * ((val - r_in.begin).to_f / (r_in.end - r_in.begin)) end |
#dist(*args) ⇒ Object
explicitly provide ‘processing.org’ dist instance method
118 119 120 121 122 123 124 125 126 |
# File 'lib/ruby-processing/helper_methods.rb', line 118 def dist(*args) len = args.length if len == 4 return dist2d(*args) elsif len == 6 return dist3d(*args) end fail ArgumentError, 'takes 4 or 6 parameters' end |
#find_method(method_name) ⇒ Object
There’s just so many functions in Processing, Here’s a convenient way to look for them.
141 142 143 144 |
# File 'lib/ruby-processing/helper_methods.rb', line 141 def find_method(method_name) reg = Regexp.new("#{method_name}", true) methods.sort.select { |meth| reg.match(meth) } end |
#frame_rate(fps = nil) ⇒ Object
frame_rate needs to support reading and writing
205 206 207 208 |
# File 'lib/ruby-processing/helper_methods.rb', line 205 def frame_rate(fps = nil) return @declared_fields['frameRate'].value(java_self) unless fps super(fps) end |
#grid(cols, rows, col_size = 1, row_size = 1) ⇒ Object
A nice method to run a given block for a grid. Lifted from action_coding/Nodebox.
19 20 21 22 23 24 25 |
# File 'lib/ruby-processing/helper_methods.rb', line 19 def grid(cols, rows, col_size = 1, row_size = 1) (0...cols * rows).map do |i| x = col_size * (i % cols) y = row_size * i.div(cols) yield x, y end end |
#java_self ⇒ Object
Provide a convenient handle for the Java-space version of self.
169 170 171 |
# File 'lib/ruby-processing/helper_methods.rb', line 169 def java_self @java_self ||= to_java(Java::ProcessingCore::PApplet) end |
#key ⇒ Object
Fix java conversion problems getting the last key If it’s ASCII, return the character, otherwise the integer
163 164 165 166 |
# File 'lib/ruby-processing/helper_methods.rb', line 163 def key int = @declared_fields['key'].value(java_self) int < 256 ? int.chr : int end |
#key_pressed? ⇒ Boolean
Is a key pressed for this frame?
216 217 218 |
# File 'lib/ruby-processing/helper_methods.rb', line 216 def key_pressed? @declared_fields['keyPressed'].value(java_self) end |
#lerp(start, stop, amt) ⇒ Object
explicitly provide ‘processing.org’ lerp instance method
99 100 101 |
# File 'lib/ruby-processing/helper_methods.rb', line 99 def lerp(start, stop, amt) start + (stop - start) * amt end |
#lerp_color(*args) ⇒ Object
lerp_color takes three or four arguments, in Java that’s two different methods, one regular and one static, so:
29 30 31 |
# File 'lib/ruby-processing/helper_methods.rb', line 29 def lerp_color(*args) args.length > 3 ? self.class.lerp_color(*args) : super(*args) end |
#load_strings(file_or_url) ⇒ Object
Ensure that load_strings returns a real Ruby array
194 195 196 |
# File 'lib/ruby-processing/helper_methods.rb', line 194 def load_strings(file_or_url) loadStrings(file_or_url).to_a end |
#map(value, start1, stop1, start2, stop2) ⇒ float
Explicitly provides ‘processing.org’ map instance method, in which value is mapped from range 1, to range 2 (NB: values are not clamped to range 1). It may be better to explicitly write your own interpolate function
65 66 67 |
# File 'lib/ruby-processing/helper_methods.rb', line 65 def map(value, start1, stop1, start2, stop2) start2 + (stop2 - start2) * ((value - start1).to_f / (stop1 - start1)) end |
#map1d(val, r_in, r_out) ⇒ Object
ruby alternative implementation of map using range parameters (begin..end) and excluded end (begin…end) produce the same result
71 72 73 74 |
# File 'lib/ruby-processing/helper_methods.rb', line 71 def map1d(val, r_in, r_out) r_out.begin + (r_out.end - r_out.begin) * ((val - r_in.begin).to_f / (r_in.end - r_in.begin)) end |
#max(*args) ⇒ Object
explicitly provide ‘processing.org’ max instance method to return a float:- a, b and c need to be floats
113 114 115 |
# File 'lib/ruby-processing/helper_methods.rb', line 113 def max(*args) args.max # { |a, b| a <=> b } optional block not reqd end |
#min(*args) ⇒ Object
explicitly provide ‘processing.org’ min instance method to return a float:- a, b and c need to be floats
106 107 108 |
# File 'lib/ruby-processing/helper_methods.rb', line 106 def min(*args) args.min # { |a,b| a <=> b } optional block not reqd end |
#mouse_pressed? ⇒ Boolean
Is the mouse pressed for this frame?
211 212 213 |
# File 'lib/ruby-processing/helper_methods.rb', line 211 def mouse_pressed? @declared_fields['mousePressed'].value(java_self) end |
#norm(value, start, stop) ⇒ Object
explicitly provide ‘processing.org’ norm instance method
94 95 96 |
# File 'lib/ruby-processing/helper_methods.rb', line 94 def norm(value, start, stop) (value - start).to_f / (stop - start) end |
#proxy_java_fields ⇒ Object
Proxy over a list of Java declared fields that have the same name as some methods. Add to this list as needed.
148 149 150 151 152 |
# File 'lib/ruby-processing/helper_methods.rb', line 148 def proxy_java_fields fields = %w(sketchPath key frameRate frame mousePressed keyPressed) methods = fields.map { |field| java_class.declared_field(field) } @declared_fields = Hash[fields.zip(methods)] end |
#save_strings(filename, strings) ⇒ Object
Writes an array of strings to a file, one line per string. This file is saved to the sketch’s data folder
200 201 202 |
# File 'lib/ruby-processing/helper_methods.rb', line 200 def save_strings(filename, strings) saveStrings(filename, [strings].flatten.to_java(:String)) end |
#set_sketch_path(spath = nil) ⇒ Object
By default, your sketch path is the folder that your sketch is in. If you’d like to do something fancy, feel free.
156 157 158 159 |
# File 'lib/ruby-processing/helper_methods.rb', line 156 def set_sketch_path(spath = nil) field = @declared_fields['sketchPath'] field.set_value(java_self, spath || SKETCH_ROOT) end |
#sketch_path ⇒ Object
Get the sketch path
174 175 176 |
# File 'lib/ruby-processing/helper_methods.rb', line 174 def sketch_path @declared_fields['sketchPath'].value(java_self) end |
#thread(&block) ⇒ Object
Overrides Processing convenience function thread, which takes a String arg (for a function) to more rubylike version, takes a block…
49 50 51 52 53 54 55 |
# File 'lib/ruby-processing/helper_methods.rb', line 49 def thread(&block) if block_given? Thread.new(&block) else fail ArgumentError, 'thread must be called with a block', caller end end |