cyross-ruby-miyako-mswin32 2.0.5

data/lib/Miyako/API/map_event.rb

@@ -0,0 +1,198 @@
+# -*- encoding: utf-8 -*-
+=begin
+--
+Miyako v2.0
+Copyright (C) 2007-2009  Cyross Makoto
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+++
+=end
+
+require 'csv'
+require 'forwardable'
+
+module Miyako
+  #==マップ上のイベント全体を管理するクラス
+  #Map/FixedMapクラス内で使用する
+  #使い方：
+  #
+  #(1)インスタンスを生成する
+  #
+  #em = MapEventManager.new
+  #
+  #(2)MapEventクラスとIDを登録する
+  #
+  #(例)MapEventモジュールをmixinしたクラスXを、ID=0のイベントとして登録
+  #
+  #em.add(0, X)
+  #
+  #(3)Map/FixedMapクラスインスタンス生成時に引数として渡す
+  #
+  #@map = Map.new(...,em)
+  #
+  #(注)登録するIDは、イベントレイヤー上の番号と対応しておくこと
+  class MapEventManager
+    #===インスタンスを生成する
+    #_map_obj_:: Managerが属するMap/FixedMapクラスのインスタンス
+    #返却値:: 生成されたインスタンス
+    def initialize
+      @map = nil
+      @id2event = Hash.new
+    end
+
+    def set(map) #:nodoc:
+      @map = map
+    end
+
+    #===イベントクラスをマップに追加登録する
+    #_id_:: マップ(イベントレイヤ)上の番号。
+    #イベントレイヤ上に存在しない番号を渡してもエラーや警告は発しない
+    #_event_:: イベントクラス。クラスのインスタンスではないことに注意！
+    #返却値:: 自分自身を返す
+    def add(id, event)
+      @id2event[id] = event
+      return self
+    end
+
+    #===イベントが登録されているかを確認する
+    #引数で渡した番号に対応するイベントクラスが登録されているかどうかを確認する
+    #_id_:: イベントクラスに対応した番号
+    #返却値:: イベントクラスが登録されている時はtrueを返す
+    def include?(id)
+      raise MiyakoError, "This MapEventManager instance is not set Map/FixedMap instance!" unless @map
+      return @id2event.has_key?(id)
+    end
+
+    #===イベントのインスタンスを生成する(番号指定)
+    #インスタンス生成と同時に、マップ上の座標を渡して初期位置を設定する
+    #登録していないIDを指定するとエラーになる
+    #
+    #設置は、マップ上の座標に設置する。表示上の座標ではない事に注意。
+    #_id_:: イベントクラスと登録した際の番号
+    #_x_:: イベントを設置する位置(X座標)
+    #_y_:: イベントを設置する位置(Y座標)
+    #返却値:: 生成したインスタンス
+    def create(id, x = 0, y = 0)
+      raise MiyakoError, "This MapEventManager instance is not set Map/FixedMap instance!" unless @map
+      raise MiyakoError, "Unknown Map Event ID! : #{id}" unless include?(id)
+      return @id2event[id].new(@map, x, y)
+    end
+
+    #===すべての登録済みイベントクラスの登録を解除する
+    def clear
+      @id2event.keys.each{|k| @id2event[k] = nil }
+    end
+
+    def dispose
+      @map = nil
+      @id2event.clear
+      @id2event = nil
+    end
+  end
+
+  #==マップ上のイベントを管理するモジュール
+  #実際に使う際にはmix-inして使う
+  module MapEvent
+    #===イベントのインスタンスを作成する
+    #引数として渡せるX,Y座標の値は、表示上ではなく理論上の座標位置
+    #_map_obj_:: 関連づけられたMap/FixedMapクラスのインスタンス
+    #_x_:: マップ上のX座標の値。デフォルトは0
+    #_y_:: マップ上のY座標の値。デフォルトは0
+    #返却値:: 生成されたインスタンス
+    def initialize(map_obj, x = 0, y = 0)
+      init(map_obj, x, y)
+    end
+
+    #===イベント生成時のテンプレートメソッド
+    #イベントクラスからインスタンスが生成された時の初期化処理を実装する
+    #_map_obj_:: 関連づけられたMap/FixedMapクラスのインスタンス
+    #_x_:: マップ上のX座標の値
+    #_y_:: マップ上のY座標の値
+    def init(map_obj, x, y)
+    end
+    
+    #===インスタンス内の表示やデータを更新するテンプレートメソッド
+    #マップ画像が更新された時に呼び出される
+    #_map_obj_:: インスタンスが組み込まれているMap/FixedMapクラスのインスタンス
+    #_events_:: マップに登録されているイベントインスタンスの配列
+    #_params_:: 開発者が明示的に用意した引数。内容はハッシュ
+    def update(map_obj, events, params)
+    end
+
+    #===イベントを指定の分量で移動させる(テンプレートメソッド)
+    #_dx_:: 移動量(x座標)。単位はピクセル
+    #_dy_:: 移動量(y座標)。単位はピクセル
+    #返却値:: 自分自身を返す
+    def move(dx,dy)
+      return self
+    end
+
+    #===イベントを指定の位置へ移動させる(テンプレートメソッド)
+    #_x_:: 移動先の位置(x座標)。単位はピクセル
+    #_y_:: 移動先の位置(y座標)。単位はピクセル
+    #返却値:: 自分自身を返す
+    def move_to(x,y)
+      return self
+    end
+
+    #===イベント発生可否問い合わせ(テンプレートメソッド)
+    #イベント発生が可能なときはtrueを返す(その後、startメソッドを呼び出す)処理を実装する
+    #_param_:: 問い合わせに使用するパラメータ群。デフォルトはnil
+    #返却値:: イベント発生可能ならばtrue
+    def met?(*params)
+      return false
+    end
+    
+    #===画面に画像を描画する(テンプレートメソッド)
+    #イベントで所持している画像を描画するメソッドを実装する
+    #(イベント内部で用意している画像の描画用テンプレートメソッド)
+    def render
+    end
+
+    #===イベントを発生させる(テンプレートメソッド)
+    #ここに、イベント発生イベントを実装する。更新はupdateメソッドに実装する
+    #_param_:: イベント発生に必要なパラメータ群。デフォルトはnil
+    #返却値:: 自分自身を返す
+    def start(*params)
+      return self
+    end
+    
+    #===イベントを停止・終了させる(テンプレートメソッド)
+    #ここに、イベント停止・終了イベントを実装する。更新はupdateメソッドに実装する
+    #_param_:: イベント発生に必要なパラメータ群。デフォルトはnil
+    #返却値:: 自分自身を返す
+    def stop(*params)
+      return self
+    end
+    
+    #===イベント発生中問い合わせ(テンプレートメソッド)
+    #ここに、イベント発生中の問い合わせ処理を実装する。
+    #_param_:: あとで書く
+    #返却値:: イベント発生中の時はtrue
+    def executing?
+      return false
+    end
+    
+    #===イベント終了後の後処理(テンプレートメソッド)
+    #ここに、イベント終了後の後処理を実装する。
+    def final
+    end
+
+    #===イベントに使用しているインスタンスを解放する(テンプレートメソッド)
+    #ここに、インスタンス解放処理を実装する。
+    def dispose
+    end
+  end
+end

data/lib/Miyako/API/modules.rb

@@ -0,0 +1,109 @@
+# -*- encoding: utf-8 -*-
+=begin
+--
+Miyako v2.0
+Copyright (C) 2007-2009  Cyross Makoto
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+++
+=end
+
+module Miyako
+=begin rdoc
+==基本スプライトモジュール
+スプライトの基本メソッドで構成されるテンプレートモジュール
+=end
+  module SpriteBase
+    #===スプライトインスタンスを取得するメソッドのテンプレート
+    #_data_:: あとで書く
+    #返却値:: 自分自身を返す
+    def to_sprite(data = nil)
+      return self
+    end
+
+    #===SpriteUnit構造体を取得するメソッドのテンプレート
+    #返却値:: nilを返す
+    def to_unit
+      return nil
+    end
+    
+    #===領域の矩形を取得するメソッドのテンプレート
+    #返却値:: nilを返す
+    def rect
+      return nil
+    end
+    
+    #===領域の最大矩形を取得するメソッドのテンプレート
+    #返却値:: nilを返す
+    def broad_rect
+      return nil
+    end
+    
+    #===画像(Bitmapクラスのインスタンス)を取得するメソッドのテンプレート
+    #返却値:: nilを返す
+    def bitmap
+      return nil
+    end
+    
+    #===画像内での描画開始位置(x座標)を取得するメソッドのテンプレート
+    #返却値:: 0を返す
+    def ox
+      return 0
+    end
+    
+    #===画像内での描画開始位置(y座標)を取得するメソッドのテンプレート
+    #返却値:: 0を返す
+    def oy
+      return 0
+    end
+    
+    #===画面への描画を指示するメソッドのテンプレート
+    #_block_:: 呼び出し時にブロック付き呼び出しが行われたときのブロック本体。呼び先に渡すことが出来る。ブロックがなければnilが入る
+    #返却値:: 自分自身を返す
+    def render(&block)
+      return self
+    end
+  end
+
+=begin rdoc
+==基本アニメーションモジュール
+アニメーションの基本メソッドで構成されるテンプレートモジュール
+=end
+  module Animation
+    #===アニメーションを開始するメソッドのテンプレート
+    #返却値:: 自分自身を返す
+    def start
+      return self
+    end
+
+    #===アニメーションを停止するメソッドのテンプレート
+    #返却値:: 自分自身を返す
+    def stop
+      return self
+    end
+
+    #===アニメーションパターンを先頭に戻すメソッドのテンプレート
+    #返却値:: 自分自身を返す
+    def reset
+      return self
+    end
+
+    #===アニメーションを更新するメソッドのテンプレート
+    #返却値:: falseを返す(アニメーションパターンが更新されたときにtrueを返す)
+    def update_animation
+      return false
+    end
+  end
+end

data/lib/Miyako/API/movie.rb

@@ -0,0 +1,154 @@
+# -*- encoding: utf-8 -*-
+=begin
+--
+Miyako v2.0
+Copyright (C) 2007-2009  Cyross Makoto
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+++
+=end
+
+module Miyako
+  #==動画管理クラス
+  #動画ファイル(MPEGファイル限定)をロード・再生するクラス
+  class Movie
+    include SpriteBase
+    include Layout
+    extend Forwardable
+
+    @@movie_list = []
+
+    attr_accessor :visible #レンダリングの可否(true->描画 false->非描画)
+    
+    #===動画のインスタンスを作成する
+    #(但し、現在の所、loopパラメータは利用できない)
+    #_fname_:: 動画ファイル名
+    #_loops_:: ループ再生の可否。ループ再生させるときは true を渡す
+    #返却値:: 生成したインスタンス
+    def initialize(fname, loops = true)
+      init_layout
+
+      @x = 0
+      @y = 0
+      
+      @movie = SDL::MPEG.load(fname)
+      @size = Size.new(@movie.info.width, @movie.info.height)
+      set_layout_size(*(@size.to_a))
+
+      @visible = true
+      @sprite = Sprite.new({:size=>@size , :type=>:movie})
+      @sprite.snap(self)
+      
+      @movie.enable_audio(true) unless $not_use_audio
+      @movie.enable_video(true)
+      @movie.set_loop(loops)
+      
+      @movie.set_display(@sprite.bitmap)
+      @movie.scale(1.0)
+      @@movie_list.push(self)
+    end
+
+    def update_layout_position #:nodoc:
+      @x = @layout.pos[0]
+      @y = @layout.pos[1]
+      @sprite.move_to(*@layout.pos)
+    end
+    
+    #===動画再生時の音量を指定する
+    #_v_:: 指定する音量。(0～100までの整数)
+    def set_volume(v)
+      return if v < 0 || v > 100 || $not_use_audio
+      @movie.set_volume(v)
+    end
+
+    #===動画再生中かを返す
+    #返却値:: 再生中のときは true を返す
+    def playing?
+      return @movie.status == SDL::MPEG::PLAYING
+    end
+
+    #===動画データを解放する
+    def dispose
+      @movie.stop if playing?
+      @sprite.dispose
+      layout_dispose
+      @@movie_list.delete(self)
+      @movie = nil
+    end
+
+    #===再生領域の範囲を設定する
+    #元動画のうち、表示させたい箇所を Rect クラスのインスタンスか4要素の配列で指定する
+    #_rect_:: 再生領域。
+    def region(rect)
+      @movie.set_display_region(*(rect.to_a))
+    end
+
+    #===動画の再生を一時停止する
+    #再生を裁可するには、 Miyako::Movie#rewind メソッドを呼び出す必要がある
+    #_pause_by_input_:: ダミー
+    def pause(pause_by_input)
+      @movie.pause
+    end
+
+    #===動画を再生させる
+    #動画の先頭から再生する。ブロックを渡したときは、ブロックを評価している間動画を再生する
+    #_vol_:: 動画再生時の音量。0～100の整数
+    def start(vol = nil)
+      set_volume(vol) if vol
+      @movie.play
+      if block_given?
+        yield self
+        @movie.stop
+      end
+    end
+
+    #===動画再生を停止する
+    def stop
+      @movie.stop
+    end
+
+    #===再生中の動画の再生位置を返す
+    #位置は秒単位で返す
+    #返却値:: 再生位置
+    def current
+      return @movie.info.current_time
+    end
+
+    #===動画の長さを返す
+    #長さは、秒単位で返す。
+    #返却値:: 動画の長さ
+    def length
+      return @movie.info.total_time
+    end
+
+    #===画面に描画を指示する
+    #現在表示できる選択肢を、現在の状態で描画するよう指示する
+    #visibleメソッドの値がfalseのときは描画されない。
+    #返却値:: 自分自身を返す
+    def render
+      return slef nless @visible
+      @sprite.render
+      return self
+    end
+    
+    #===一時停止中の動画の再生を再開する
+    #Miyako::Movie#pause メソッドを実行した後に呼び出す
+    def_delegators(:@movie, :rewind)
+    #===指定時間ぶん、スキップ再生を行う
+    #size:: スキップ長(秒単位)
+    def_delegators(:@movie, :skip)
+    def_delegators(:@sprite, :rect, :broad_rect, :ox, :oy)
+  end
+end