[Processing][仕様]外部ライブラリ(*.jar)の設置方法

 Processingで高度なことをやろうとすると、Processingに標準搭載されていないProcessing用ライブラリや、Java用のライブラリを使うことがあるかもしれません。今回は、そういった外部ライブラリはどこに置けば良いのかを調べてみました。

1. codeフォルダに置く (一番簡単、その場限り、古くからの方法)

 一番簡単な方法としては、該当スケッチのフォルダに、codeフォルダを作成して、その中に外部ライブラリのjarファイルを置きます。フォルダ構造だと、以下のようになります。

  • SampleSketch
    • code
      • SomeExternalLibrary01.jar
      • AnotherExternalLibrary01.jar
      • ***.jar
    • SampleSketch.pde

 codeフォルダの中に置いた外部ライブラリのjarファイルは、自動的にProcessing側が判断して読み込まれます。ただし、関係のない*.jarファイルを置いていても読み込まれてしまうので注意が必要です。Java Appletにエクスポートするときに関係のないライブラリまで一緒にパックされるので、アプレットのファイルサイズがその分だけ増えてしまいます。

 codeフォルダの中に置く方法は、Processingの古いバージョンから使われている方法です。この方法では、スケッチの数だけ外部ライブラリのjarファイルが増殖してしまうという欠点がありました。その欠点を補うべく、今のProcessingでは新しいライブラリシステムが提供されていて、そちらの利用が推奨されています。

2. ライブラリシステムを利用する (少し複雑)

 いつからサポートされたのかはわかりませんが、前述のとおり、今のProcessingでは外部ライブラリを効率よく呼び出すための仕組みが提供されています。少し構造がわかりにくいかもしれませんが、いくつかフォルダ構造例がでてくるので、悟ってもらえると助かります。

 このライブラリシステムでは、jarファイル名、フォルダ構造、設置場所の3つの決まりがあります。

2-1. jarファイル名

 jarファイル名は、A?Z、a?z、0?9、_(アンダーバー)の63文字の組み合わせでなければなりません。また1文字目が数字であってもいけません。もちろん拡張子の「.jar」は例外です。もし、この規則に当てはまらないjarファイル名であった場合は、自己責任でファイル名を変更しなければなりません。いくつか例を示します。

  • OK  internationalization.jar
  • OK  Sample007Example.jar
  • OK  traer_animation.jar (アンダーバーはOK)
  • NG  007Sample.jar (数字で始まっている)
  • NG  traer_animation-1.6.jar (ハイフンとドットが含まれている)

2-2. フォルダ構造

 フォルダ構造は、jarファイル名と同名のフォルダを作り、その下にlibraryという名前のフォルダを作り、さらにその下にjarファイルを置きます。たとえばsample.jarという名前のライブラリがある場合、フォルダ構造は

  • sample
    • library
      • sample.jar

となります。

2-3. 設置場所

 設置場所の候補は2箇所あります。

 1箇所目はProcessingのプログラム(processing.exe)が置いてあるフォルダの中のlibrariesフォルダの中です。このlibrariesフォルダは、video・net・opengl・pdfなどのProcessingに標準搭載されている追加ライブラリのためのフォルダですが、ここに追加しても問題ありません。ためしにsampleライブラリを追加してみると以下のようなフォルダ構造になります。

  • C:\Program Files\Processing\libraries (私の環境)
    • candy
    • dxf
    • javascript
    • net
    • opengl
    • pdf
    • serial
    • sample
      • library
        • sample.jar
    • video
    • xml

 設置したら、Processingを再起動(全てのProcessingエディタを閉じた後に再びProcessingエディタを起動)してみてください。以下のようにメニューアイテムが追加されます。

processing_pde_add_library_to_libraries.jpg

 もう1箇所の設置場所がユーザーのスケッチブックフォルダ以下です。スケッチブックフォルダの場所は、Processingエディタメニューの[File]-[Preferences]で表示される設定ダイアログの[Sketchbook location:]に指定されているフォルダです。デフォルトのスケッチブックフォルダは、Windowsであれば「自分のアカウント\My Documents\Processing\」です。Mac OS Xであれば「自分のアカウント/Documents/Processing」です。このスケッチブックフォルダ以下にライブラリフォルダを追加します。ライブラリ用に「_libraries」というフォルダを作って、そこに入れるのがお勧めです。ためしにsampleライブラリを追加してみると以下のようなフォルダ構造になります。

  • C:\Documents and Settings\自分のアカウント\My Documents\Processing (私の環境)
    • _libraries
      • sample
        • library
          • sample.jar
    • 2D (私の作業フォルダ)
      • Work (私の作業フォルダ)
    • 3D (私の作業フォルダ)
      • Work (私の作業フォルダ)

 設置したら、Processingを再起動(全てのProcessingエディタを閉じた後に再びProcessingエディタを起動)してみてください。以下のようにメニューアイテムが追加されます。

processing_pde_add_library_to_sketchbook.jpg

 外部ライブラリを使えば、Processingの可能性はとても広がります。是非ともチャレンジしてみてください。

?

About: uechoco


One thought on “[Processing][仕様]外部ライブラリ(*.jar)の設置方法”

Comments are closed.