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

Instance Method Details

#blend_color(c1, c2, mode) ⇒ Object

Uses PImage class method under hood



118
119
120
 
# File 'lib/ruby-processing/helper_methods.rb', line 118

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.

Yields:

  • (buf) 


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



113
114
115
 
# File 'lib/ruby-processing/helper_methods.rb', line 113

def constrain(amt, low, high)
  (low..high).clip(amt)
end

#dist(*args) ⇒ Object

explicitly provide ‘processing.org’ dist instance method



101
102
103
104
105
106
107
108
109
 
# File 'lib/ruby-processing/helper_methods.rb', line 101

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.



124
125
126
127
 
# File 'lib/ruby-processing/helper_methods.rb', line 124

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



188
189
190
191
 
# File 'lib/ruby-processing/helper_methods.rb', line 188

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.



152
153
154
 
# File 'lib/ruby-processing/helper_methods.rb', line 152

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



146
147
148
149
 
# File 'lib/ruby-processing/helper_methods.rb', line 146

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?

Returns:

  • (Boolean) 


199
200
201
 
# File 'lib/ruby-processing/helper_methods.rb', line 199

def key_pressed?
  @declared_fields['keyPressed'].value(java_self)
end

#lerp(start, stop, amt) ⇒ Object

explicitly provide ‘processing.org’ lerp instance method



82
83
84
 
# File 'lib/ruby-processing/helper_methods.rb', line 82

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



177
178
179
 
# File 'lib/ruby-processing/helper_methods.rb', line 177

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

Parameters:

  • value (float) —

    input

  • start1, (range) —

    stop1

  • start1, (range) —

    stop2

Returns:

  • (float) —

    mapped value



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



96
97
98
 
# File 'lib/ruby-processing/helper_methods.rb', line 96

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



89
90
91
 
# File 'lib/ruby-processing/helper_methods.rb', line 89

def min(*args)
  args.min  #  { |a,b| a <=> b } optional block not reqd
end

#mouse_pressed? ⇒ Boolean

Is the mouse pressed for this frame?

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/ruby-processing/helper_methods.rb', line 194

def mouse_pressed?
  @declared_fields['mousePressed'].value(java_self)
end

#norm(value, start, stop) ⇒ Object

explicitly provide ‘processing.org’ norm instance method



77
78
79
 
# File 'lib/ruby-processing/helper_methods.rb', line 77

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.



131
132
133
134
135
 
# File 'lib/ruby-processing/helper_methods.rb', line 131

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



183
184
185
 
# File 'lib/ruby-processing/helper_methods.rb', line 183

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.



139
140
141
142
 
# File 'lib/ruby-processing/helper_methods.rb', line 139

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



157
158
159
 
# File 'lib/ruby-processing/helper_methods.rb', line 157

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