インストール

JRubyをインストールし、パスを通して下さい。

http://jruby.codehaus.org/Home

Processingをインスールして下さい。

http://processing.org/download/index.html

本ソフトウェアをチェックアウトして下さい。

$ svn checkout http://action-coding.googlecode.com/svn/trunk/ action-coding-read-only

svn/trunk/config.yamlをテキストエディタで開き、Processingのパスを指定して下さい。

p5home: /Applications/Processing 0135

簡単な使い方

svn/trunk/run.commandを実行します。

ファイルダイアログが表示されますので、以下のファイルを選択します。アプレットが起動されるはずです。

svn/trunk/examples/basics/arrays/array_objects.rb

別の起動方法として以下のものがあります。

$ jruby aco.rb examples/basics/arrays/array_objects.rb

テキストエディタで以下のファイルを開きます。

svn/trunk/examples/basics/array/array_objects.rb

47行目を以下のように書き換えてファイルを保存します。

p.stroke 4 * p.second, 0, 0

ストロークの色が赤に変わりましたか？ ファイルを保存することで、Modクラスの定義が実行時に置き換わりました。 続いて、4行目を以下のように書き換えてファイルを保存して下さい。

size 300, 300

Processingをご存知の方なら、ウィンドウサイズが変わると予想したことでしょう。 しかし、setup()はアプレットの起動時に一度だけ呼び出されるだけですので、関数の定義が変わっただけでは反映されません。

プログラムを始めから実行したいときは、アプレットが表示されているウィンドウにフォーカスがある状態で、

⌘R (または Ctrl R)

と入力します。setup()関数が再び評価され、ウィンドウが大きくなります。基本的な使い方は以上になります。

なお、コーディング中にエラーが起きた場合も、スタックトレースを参考にコードを修正し、アプレットにフォーカスを合わせて⌘Rで再起動して下さい。

コマンドラインオプション

$ jruby aco.rb <オプション> ファイル名

とすることで、コマンドラインからアプレットを起動できます。 オプションは以下の通りです。

• -i, --interval=VAL ファイルの更新を監視する頻度を秒単位で指定します。デフォルトは0.1です。
• -n, --no-file-observe ファイルの更新を監視しません。単に作品を見せたいときに使います。
• -r, --reload-always ファイル保存時に、常にアプレットを再起動させます。
• -f, --fullscreen アプレットをフルスクーンで起動します。
• -d, --display=VAL 何番目のディスプレイでフルスクーン表示するか指定します。デフォルトは0です。
• -b, --bgcolor=VAL ウィンドウの背景色を指定します。デフォルトは0x000000です。

-fオプションを使用したサンプルは以下にあります。

svn/trunk/examples/3d_and_opengl/opengl/full_screen_app

PFontを使う

PFontを利用するには、事前にビットマップフォントを準備する必要があります。

1. Processingを起動する
2. メニューからTools => Create Font...を選ぶ
3. 使用する書体と級数を入力し、OKをクリック
4. メニューからSketch => Show Sketch Folderを選ぶ
5. dataフォルダの中に.vlwという拡張子を持つファイルが作られているので、ソースコードと同じ階層にコピー

以上の準備ができたら、例えば以下のように書きます。

def setup
  size 400, 400
  background 0
  fill 255
             
  fontA = loadFont "CourierNew36.vlw" #書体のファイル名は書き換えて下さい
  textFont fontA, 36
  textAlign CENTER
  
  text 'Hello PFont', 200, 200
end

Processingでは、リソースを格納するdataフォルダが作られ、ファイル名を指定する際のベースパスとなっていました。action-codingではソースコードと同階層がベースパスとなることを覚えておいて下さい。

Processing用ライブラリを使う

Processingのlibraries以下にあるライブラリをロードするには、ソースコードの先頭で

include_class 'クラス名'

と指定します。パッケージ単位でロードする場合は

include_package 'パッケージ名'

と指定します。以下に例を挙げます。

include_package 'processing.pdf'

def setup
  size 594, 842
  @pdf = beginRecord PDF, "RandomBook.pdf"
  beginRecord @pdf
end

def draw
  background 255
  
  100.times do |i|
    if random(1.0) < 0.2
      stroke 255
    else
      stroke 0
    end
    sw = pow random(1.0), 12
    strokeWeight sw * 260
    x1 = random -200, -100
    x2 = random width+100, width+200
    y1 = random -100, height+100
    y2 = random -100, height+100
    line x1, y1, x2, y2
  end

  if frameCount == 768
    endRecord
    exit
  else
    @pdf.nextPage
  end
end

パラメーターの調整を手軽に行う

NodeBoxにはプログラム中にマジックナンバーを書く代わりに、スライダー等のGUIによってユーザーが調整できるパラメーターを作成する機能があります。

http://nodebox.net/code/index.php/Variables (のページの一番下)

同様の機能をControlというモジュールが提供しています。 これを利用するにはソースコードの先頭で、Controlモジュールをインクルードします。

require 'control.rb'   
include Control

続いて、setup()関数の中で以下のメソッドを呼び出します。

• slider(変数名のシンボル, デフォルト値, 最小値, 最大値)

• text_field(変数名のシンボル, デフォルト値)

• check_box(変数名のシンボル, デフォルト値)

• button(関数名のシンボル)

このようにすることで、GUIの値を自由に参照できるようになります。 例を以下に挙げます。

require 'control.rb'   
include Control

def setup                
  size 200, 200  
  smooth
  noStroke
  fill 0
  slider :radius, 100, 0, 200  
  text_field :msg, 'hello'
  button :click      
  check_box :visible, true 
end

def draw        
  background 255
  ellipse 100, 100, radius, radius if visible
end                

def click
  puts msg
end

mousePressed及び、keyPressedについて

JRubyでは、イベントハンドラとしてのmousePressed()と、フィールドとしてのmousePressedの区別がつきません。keyPressedも同様です。action-codingでは、フィールドのほうに別な名前をつけて解消しています。以下の表を参照して下さい。

RubyでProcessing用ライブラリを書く

ProcessingのAPIのほとんどを提供するPAppletクラスでは、ライブラリ作成者のためのイベントハンドラとして、以下を用意しています。

• dispose() アプレットの終了時に呼ばれる
• pre() drawが呼ばれる前に呼ばれる
• draw() フレームレートに従い、定期的に呼ばれる
• mouseEvent(MouseEvent e) マウス関連のイベントが発生すると呼ばれる
• keyEvent(KeyEvent e) キー関連のイベントが発生すると呼ばれる
• post() drawが呼ばれた後に呼ばれる
• size(int width, int height) アプレットのサイズが設定されたら呼ばれる

リスナーの登録はPAppletの以下のメソッドから行います。

• registerDispose(Object o)
• registerPre(Object o)
• registerDraw(Object o)
• registerMouseEvent(Object o)
• registerKeyEvent(Object o)
• registerPost(Object o)
• registerSize(Object o)

しかし、RubyのオブジェクトをregisterDispose等の引数に渡してもリフレクション関連のエラーが発生してしまいうまくいきません。このエラーを回避するために、IPAppletAdapterというJavaインターフェースを提供しています。このインタフェースをincludeすることで、あなたのRubyクラスをPAppletと協調させることができます。

非常にシンプルな例を以下に挙げます。

require 'java'
require 'rplib.jar'
include_class 'processing.core.PApplet'
include_class 'IPAppletAdapter' 

class BoringLibrary
  include IPAppletAdapter

  def initialize(applet)
    super()
    @applet = applet
    applet.registerDispose(self)
  end

  def dispose
    #anything in here will be called automatically when 
    #the parent applet shuts down. for instance, this might
    #shut down a thread used by this library.
  end
end 

TextMateから使う

TextMateを使っている方は、以下の手順を踏むことで、エディタ内からアプレットを直接実行できるようになります。デバッグ情報やエラーもTextMateのコンソールに表示されるため便利です。

以下のバンドルをそれぞれダブルクリックしてインストールします。

svn/trunk/textmate/Run (action-coding).tmCommand

svn/trunk/textmate/Reload (action-coding).tmCommand

svn/trunk/textmate/Eval Line / Selection (action-coding).tmCommand

⌘, でPreferencesを開き、AdvancedのShell Variablesで以下の変数を追加します。

参考までに、私の環境では以下のようになっています。

以上で、セットアップは完了です。基本的な使い方は以下のようになります。

1. 新規テキストを作成
2. 言語をRubyに切り替え
3. ⌥⌘R でaction-codingを起動
4. コードを書く
5. ⌘S で反映
6. 必要に応じて4に戻る。

その他の機能も含めると、以下のようになっています。

スコープについて

あなたが書いたコードは、以下のように変換されてから実行されると思って下さい。TextMateからEval Line / Selectionしたコードも同様です。

class MyApplet < PApplet
  <あなたのソースコード>
end

そのため、スコープには十分気をつけて下さい。 例えば、ソースコードのトップレベルで以下のようなことはできません。

background 0

また、以下のようなコードも意図通り動かないと思います。

def hoge
  p "hoge"
end
hoge()

一方、以下はうまくいきます。

def self.hoge
  p "hoge"
end
hoge()