Class: Processing::App

Inherits:
PApplet
  • Object
show all
Includes:
Math, HelperMethods
Defined in:
lib/ruby-processing/app.rb

Constant Summary collapse

@@library_loader = 
LibraryLoader.new

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HelperMethods

#blend_color, #buffer, #color, #constrain, #dist, #find_method, #frame_rate, #grid, #java_self, #key, #key_pressed?, #lerp, #lerp_color, #load_strings, #map, #map1d, #max, #min, #mouse_pressed?, #norm, #proxy_java_fields, #save_strings, #set_sketch_path, #sketch_path, #thread

Constructor Details

#initialize(options = {}) ⇒ App

It is ‘NOT’ usually necessary to directly pass options to a sketch, it gets done automatically for you. Since processing-2.0 you should prefer setting the sketch width and height and renderer using the size method, in the sketch (as with vanilla processing), which should be the first argument in setup. Sensible options to pass are x and y to locate sketch on the screen, or full_screen: true (prefer new hash syntax)



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/ruby-processing/app.rb', line 105

def initialize(options = {})
  super()
  post_initialize(options)
  $app = self
  proxy_java_fields
  set_sketch_path # unless Processing.online?
  mix_proxy_into_inner_classes
  # @started = false

  java.lang.Thread.default_uncaught_exception_handler = proc do
  |_thread_, exception|
    puts(exception.class.to_s)
    puts(exception.message)
    puts(exception.backtrace.map { |trace| "\t#{trace}" })
    close
  end

  # For the list of all available args, see:-
  # http://processing.org/reference/, however not all convenience functions
  # are implemented in ruby-processing (you should in general prefer ruby
  # alternatives when available and methods using java reflection, are best
  # avoided entirely)

  args = []
  @width, @height = options[:width], options[:height]
  if options[:full_screen]
    present = true
    args << '--full-screen'
    args << "--bgcolor=#{options[:bgcolor]}" if options[:bgcolor]
  end
  @render_mode  ||= JAVA2D
  xc = Processing::RP_CONFIG['X_OFF'] ||= 0
  yc = Processing::RP_CONFIG['Y_OFF'] ||= 0
  x = options[:x] || xc
  y = options[:y] || yc
  args << "--location=#{x},#{y}"  # important no spaces here
  title = options[:title] ||
  File.basename(SKETCH_PATH).sub(/(\.rb)$/, '').titleize
  args << title
  PApplet.run_sketch(args.to_java(:string), self)
end

Class Attribute Details

.sketch_class ⇒ Object

Returns the value of attribute sketch_class.



60
61
62
 
# File 'lib/ruby-processing/app.rb', line 60

def sketch_class
  @sketch_class
end

Class Method Details

.inherited(subclass) ⇒ Object

Keep track of what inherits from the Processing::App, because we’re going to want to instantiate one.



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

def self.inherited(subclass)
  super(subclass)
  @sketch_class = subclass
end

.library_loaded?(library_name) ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/ruby-processing/app.rb', line 81

def library_loaded?(library_name)
  @@library_loader.library_loaded?(library_name)
end

.load_java_library(*args) ⇒ Object 



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

def load_java_library(*args)
  @@library_loader.load_java_library(*args)
end

.load_libraries(*args) ⇒ Object Also known as: load_library 



76
77
78
 
# File 'lib/ruby-processing/app.rb', line 76

def load_libraries(*args)
  @@library_loader.load_library(*args)
end

.load_ruby_library(*args) ⇒ Object 



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

def load_ruby_library(*args)
  @@library_loader.load_ruby_library(*args)
end

.method_added(method_name) ⇒ Object

When certain special methods get added to the sketch, we need to let Processing call them by their expected Java names.



52
53
54
55
56
 
# File 'lib/ruby-processing/app.rb', line 52

def self.method_added(method_name) #:nodoc:
  if METHODS_TO_ALIAS.key?(method_name)
    alias_method METHODS_TO_ALIAS[method_name], method_name
  end
end

Instance Method Details

#close ⇒ Object

Cleanly close and shutter a running sketch.



179
180
181
182
183
 
# File 'lib/ruby-processing/app.rb', line 179

def close
  control_panel.remove if respond_to?(:control_panel)
  dispose
  frame.dispose
end

#inspect ⇒ Object

Provide a loggable string to represent this sketch.



174
175
176
 
# File 'lib/ruby-processing/app.rb', line 174

def inspect
  "#<Processing::App:#{self.class}:#{@title}>"
end

#library_loaded?(library_name) ⇒ Boolean

Returns:

  • (Boolean) 


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

def library_loaded?(library_name)
  self.class.library_loaded?(library_name)
end

#post_initialize(_args) ⇒ Object 



163
164
165
 
# File 'lib/ruby-processing/app.rb', line 163

def post_initialize(_args)
  nil
end

#size(*args) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/ruby-processing/app.rb', line 147

def size(*args)
  w, h, mode       = *args
  @width           ||= w     
  @height          ||= h     
  @render_mode     ||= mode  
  if /opengl/ =~ mode
    # Include processing opengl classes that we'd like to use:
    %w(FontTexture FrameBuffer LinePath LineStroker PGL
     PGraphics2D PGraphics3D PGraphicsOpenGL PShader
     PShapeOpenGL Texture).each do |klass|
     java_import "processing.opengl.#{klass}"        
    end
  end
  super(*args)
end

#sketch_class ⇒ Object 



63
64
65
 
# File 'lib/ruby-processing/app.rb', line 63

def sketch_class
  self.class.sketch_class
end

#start ⇒ Object

Set the size if we set it before we start the animation thread.



168
169
170
171
 
# File 'lib/ruby-processing/app.rb', line 168

def start
  size(@width, @height) if @width && @height
  super()
end