Gem 'oekaki' リファレンス

GTK2 を使ったシンプルな描画ライブラリです。Gem のページはこちら。

• インストール
• 簡単な使い方
• メソッド一覧

こちらのブログ記事も参考になるかと。

Gem なのでふつうに $ gem install oekaki や Bundler を使ってどうぞ。

• ウインドウを出してみます。

  require 'oekaki'
  
  Oekaki.app width: 400, height: 300 do
    draw do
      clear
    end
  end
  

  draw {..} のブロック内に描画処理を書きます。なお、以下 require 'oekaki' は省略します。

• 白地に半径 100 の赤い円を描いてみます。

  Oekaki.app width: 300, height: 300 do      #ウィンドウの大きさは 300×300
    draw do
      white = color(65535, 65535, 65535)
      red   = color(65535, 0, 0)
      
      clear(white)                           #画面全体を白く塗りつぶす
      circle(true, 150, 150, 100, red)       #赤い円を描く
    end
  end
  

  circle(fill, x, y, r, color = nil) の fill は true ならば内部を塗りつぶします。

• タイマーを使ってアニメーションします。

  Oekaki.app width: 300, height: 300, title: :lines do
    draw do
      clear(color(0xffff, 0xffff, 0xffff))
    end
    
    x = 0
    id = timer(30) do
      color(0, 0xffff, 0)
      line(x, 0, 299 - x, 299)
      x += 1
      timer_stop(id) if x >= 300
      true
    end
  end
  

  timer(wait) {..} で wait ミリ秒ごとにブロック内を呼び出します。id が返るので、timer_stop(id) でタイマーを止めることができます。なお、ブロックが true を返さないと一度きりの呼び出しになります。なお、color(r, g, b) は Gdk::Color オブジェクトを返し、その値を内部で保持します。

• スター（星形）を描きます。

  Oekaki.app do
    draw do
      color(0, 0, 0)
      rectangle(true, 0, 0, 300, 300)
      
      color(0xdc00, 0xdc00, 0xdc00)     #gainsboro
      circle(true, 150, 150, 150) 
      color(0x6b00, 0x8e00, 0x2300)     #olivedrab
      star(true, 150, 150, 150, 0)
    end
  end
  

  star(fill, x1, y1, x2, y2, color = nil) は (x1, y1) がスターの中心、(x2, y2) は頂点（のひとつ）の座標です。rectangle(fill, x, y, width, height, color = nil) は長方形を描画します。

• 多角形と文字列をを描き、png 画像ファイルとして保存します。

  Oekaki.app width: 300, height: 300 do
    draw do
      white = color(65535, 65535, 65535)
      red   = color(65535, 0, 0)
      blue  = color(0, 0, 65535)
      
      clear(white)
      
      ar = []
      50.times {ar << [rand(300), rand(300)]}      #線の数は50本（配列に座標を入れる）
      polygon(true, ar, blue)                      #多角形を描く
      
      text("Polygon", 180, 260, 20 * 1000, red)    #文字列を描く
      
      img = get_pic(0, 0, 300, 300)                #画像の取り込み
      save_pic(img, "sample.png")                  #画像ファイルに保存
    end
  end
  

• タートルグラフィックスを使います。

  Oekaki.app width: 500, height: 500 do
    draw do
      clear(color(0x1694, 0x3447, 0x8d60))
      
      t = Oekaki::Turtle.new
      t.color(0xfe5f, 0xaa9a, 0x212a)
      ln = 10
      
      60.times do
        4.times do
          t.forward(ln)
          t.left(90)
        end
        t.left(6)
        ln += 4
      end
    end
  end
  

  Oekaki::Turtle.new でタートルのインスタンスを生成します。

• module Oekaki
  • self.app(width: 300, height: 300, title: "oekaki", resizable: false) {..}
    ブロック内に以下を記述します。
• Class Tool
  • color(r, g, b)
    色をセットします。Gdk::Color オブジェクトを返し、その値を内部で保持します。数値の範囲は 0 以上 65535(0xffff) 以下です。
  • clear(color = nil)
    画面をクリアします。このメソッドだけ、color が nil だと黒でクリアします。
  • rectangle(fill, x, y, width, height, color = nil)
    長方形を描きます。fill が true ならば内部を塗りつぶします。color が省略された場合は、内部で保持している値を使います。
  • arc(fill, x, y, width, height, d1, d2, color = nil)
    楕円を描きます。d1, d2 は開始角、回転角で、それぞれ 1度の 1 / 64 が単位です。なので、64 * 360 で 360度になります。
  • circle(fill, x, y, r, color = nil)
    半径 r の円を描きます。
  • point(x, y, color = nil)
    点を打ちます。
  • line(x1, y1, x2, y2, color = nil)
    線を引きます。
  • lines(array, color = nil)
    連続した線を描きます。array は [[0, 0], [100, 10], [20, 250], [0, 0]] といった具合に指定します。
  • polygon(fill, array, color = nil)
    多角形を描きます。
  • text(str, x, y, size, color = nil)
    文字列を描きます。size は 1ポイントが 1024 に相当します。
  • star(fill, x1, y1, x2, y2, color = nil)
    スター（星形）を描きます。(x1, y1) がスターの中心、(x2, y2) は頂点（のひとつ）の座標です。
  • get_window_size
    ウィンドウのサイズを返します。
  • load_pic(filename)
    画像ファイルを読み込んで、GdkPixbuf::Pixbuf オブジェクトを返します。
  • save_pic(img, filename, type = "png")
    画像 img を画像ファイルとして出力します。img は GdkPixbuf::Pixbuf オブジェクトです。
  • show_pic(img, x, y)
    画像 img をウィンドウに貼り付けます。
  • get_pic(x, y, width, height)
    指定した範囲の画像を読み込んで、GdkPixbuf::Pixbuf オブジェクトを返します。
  • timer_stop(id)
    id なるタイマーを停止します。
• Class Event < Tool
  • draw {..}
    ブロック内を描画します。
  • timer(interval) {..}
    ブロック内を interval ミリ秒間隔で呼び出します。ブロックは true を返さないと一度きりの呼び出しとなります。タイマーを識別する id を返します。
  • key_in {|w, e| ..}
    キー入力がなされるとブロック内が呼び出されます。w にはウィジェット、e にはイベントが入ります。e.keyval で押されたキーが数値でわかります。キーの定数などはここなどを参考にして下さい。
  • mouse_button {|w, e| ..}
    マウスのボタンが押されるとブロック内が呼び出されます。e.button で押されたボタンが数値でわかります。e.x, e.y で押された位置が返ります。
  • make_window {|w| ..}
    新しい子ウィンドウを作ります。w にはウィンドウが入ります。ブロック内は w が self です。
  • window_changed {|w| ..}
    
• class Turtle < Tool
  タートルグラフィックスを使います。Oekaki::Turtle.new でインスタンスを生成します。初期位置はウィンドウの中心です。座標系は右方向と上方向がプラス方向になります。
  • left(deg)
    角 deg 度だけ左を向きます。
  • right(deg)
    角 deg 度だけ右を向きます。
  • forward(length, draw = true)
    長さ length だけ進みます。draw が false なら描画はされません。
  • back(length)
    描画はせずに長さ length だけ戻ります。ペンの向きは変わりません。
  • color(r, g, b)
    ペンの色を指定します。デフォルトは白色です。
  • circle(radius, fill = false)
    ペンの位置を中心に半径 radius の円を描きます。
  • move(x, y)
    位置 (x, y) に移動します。
  • pen_po
    ペンの位置を Vector オブジェクトで返します。位置を代入することもできます。
  • dir
    ペンの方向を長さ 1 の Vector オブジェクトで返します。代入することもできます。代入するときは単位ベクトルにして下さい。初期値は Vector[1, 0]（右方向）です。