Module: Processing::HelperMethods

Included in:
App
Defined in:
lib/ruby-processing/helper_methods.rb

Instance Method Summary collapse

Instance Method Details

#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) 


7
8
9
10
11
12
13
 
# File 'lib/ruby-processing/helper_methods.rb', line 7

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 



31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/ruby-processing/helper_methods.rb', line 31

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

#find_method(method_name) ⇒ Object

There’s just so many functions in Processing, Here’s a convenient way to look for them.



69
70
71
72
 
# File 'lib/ruby-processing/helper_methods.rb', line 69

def find_method(method_name)
  reg = Regexp.new("#{method_name}", true)
  self.methods.sort.select { |meth| reg.match(meth) }
end

#frame_count ⇒ Object 



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

def frame_count;  frameCount;   end

#frame_rate(fps = nil) ⇒ Object

frame_rate needs to support reading and writing



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

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.



17
18
19
20
21
22
23
 
# File 'lib/ruby-processing/helper_methods.rb', line 17

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.



99
100
101
 
# File 'lib/ruby-processing/helper_methods.rb', line 99

def java_self
  @java_self ||= 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



93
94
95
96
 
# File 'lib/ruby-processing/helper_methods.rb', line 93

def key
  int = @declared_fields['key'].value(java_self)
  int < 256 ? int.chr : int
end

#key_code ⇒ Object 



116
 
# File 'lib/ruby-processing/helper_methods.rb', line 116

def key_code;     keyCode;      end

#key_pressed? ⇒ Boolean

Is a key pressed for this frame?

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/ruby-processing/helper_methods.rb', line 142

def key_pressed?
  @declared_fields['keyPressed'].value(java_self)
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:



27
28
29
 
# File 'lib/ruby-processing/helper_methods.rb', line 27

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



120
121
122
 
# File 'lib/ruby-processing/helper_methods.rb', line 120

def load_strings(file_or_url)
  loadStrings(file_or_url).to_a
end

#loop(&block) ⇒ Object

Overrides convenience function loop, to add ability to loop over a block if supplied, otherwise perform as the PApplet class would



47
48
49
50
51
52
53
54
55
 
# File 'lib/ruby-processing/helper_methods.rb', line 47

def loop(&block)
  if block_given?
    while true do
      yield
    end
  else
    super
  end
end

#mouse_button ⇒ Object 



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

def mouse_button; mouseButton;  end

#mouse_pressed? ⇒ Boolean

Is the mouse pressed for this frame?

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/ruby-processing/helper_methods.rb', line 137

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

#mouse_x ⇒ Object

Fields that should be made accessible as under_scored.



110
 
# File 'lib/ruby-processing/helper_methods.rb', line 110

def mouse_x;      mouseX;       end

#mouse_y ⇒ Object 



111
 
# File 'lib/ruby-processing/helper_methods.rb', line 111

def mouse_y;      mouseY;       end

#pmouse_x ⇒ Object 



112
 
# File 'lib/ruby-processing/helper_methods.rb', line 112

def pmouse_x;     pmouseX;      end

#pmouse_y ⇒ Object 



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

def pmouse_y;     pmouseY;      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.



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

def proxy_java_fields
  @declared_fields = {}
  fields = %w(sketchPath key frameRate frame mousePressed keyPressed)
  fields.each { |f| @declared_fields[f] = java_class.declared_field(f) }
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



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

def save_strings(filename, strings)
  saveStrings(filename, [strings].flatten.to_java(:String))
end

#set_sketch_path(path = 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.



84
85
86
87
 
# File 'lib/ruby-processing/helper_methods.rb', line 84

def set_sketch_path(path = nil)
  field = @declared_fields['sketchPath']
  field.set_value(java_self, path || SKETCH_ROOT)
end

#sketch_path ⇒ Object

Get the sketch path



105
106
107
 
# File 'lib/ruby-processing/helper_methods.rb', line 105

def sketch_path
  @declared_fields['sketchPath'].value(java_self)
end

#thread(*args, &block) ⇒ Object

Overrides Processing convenience function thread, which takes a String arg (for a function) to more rubylike version, takes a block…



59
60
61
62
63
64
65
 
# File 'lib/ruby-processing/helper_methods.rb', line 59

def thread(*args, &block)
  if block_given?
    Thread.new *args, &block
  else
    raise ArgumentError, 'thread must be called with a block' , caller
  end
end