ruby-miyako 2.1.10 → 2.1.11

data/README

@@ -1,8 +1,8 @@
 *******************************************************************************
 【   作者名   】　サイロス誠
 【  ソフト名  】　Interactive Media Authoring System "Miyako"
-【 バージョン 】　2.1.10
-【   作成日   】　2010/04/20
+【 バージョン 】　2.1.11
+【   作成日   】　2010/05/01
 【    種別    】　フリーウェア
 【  開発言語  】　Ruby 1.9.1
 【 ランタイム 】　Ruby 1.9.1～,Ruby/SDL 2.1～,SDL
@@ -15,7 +15,7 @@
 
 【 注意事項  】
 
-本バージョンは、2.1.10公式リリース版です。
+本バージョンは、2.1.11公式リリース版です。
 本バージョンでは、ドキュメント・リファレンスは不十分ですが、「サイログ。」内や、サンプルプログラムの紹介等で随時ドキュメントを公開して行きます。
 （RDOC化を進めていますので、我こそはと思う方は是非・・・）
 
@@ -1673,5 +1673,59 @@ v2.1.10(2010.04.20)
 <ドキュメント>
 ・リファレンスマニュアルの項目追加
 
+v2.1.11(2010.05.01)
+<バグ修正>
+・エラーメッセージの修正(ScenarioEngine,InitiativeScenarioEngine)
+<機能改善>
+<仕様変更>
+・ScenarioEngine/InitiativeScenarioEngine#commandメソッドの見直し
+　・インタフェース使用に変化なし
+　・配列の中身がChoicesクラスオブジェクト(の配列)のときにも対応した
+・Choice構造体の:rightと:upの順番を入れ替え
+・SpriteAnimation.newメソッドの:sprite引数に加えて、:sprites引数に置き換え可能とした
+・SpriteAnimation#render,render_toの高速化を廃止
+・SpriteAnimation#newに渡すスプライトの範囲を拡大(要素はSpriteBase・Layoutモジュールを取り込んだ物なら何でも良くなった)
+<ファイル追加>
+・lib/EXT/drawer.rb
+・sample/drawer_sample.rb
+<ファイル削除>
+<グローバル変数追加>
+<定数追加>
+<定数削除>
+<構造体追加>
+<クラス追加>
+Drawer
+<モジュール追加>
+<mixin>
+<クラス・モジュールメソッド追加>
+<クラス・モジュールメソッド廃止>
+<モジュール関数追加>
+・SpriteBase#.ox=
+・SpriteBase#.oy=
+・SpriteBase#.ow=
+・SpriteBase#.oh=
+・SpriteArray#.render_xy
+・SpriteArray#.render_xy_to
+<モジュール関数廃止>
+<インスタンスメソッド追加>
+・ScenarioEngine::Command#to_choice
+・ScenarioEngine::CommandEx#to_choice
+・ScenarioEngine#start_all
+・ScenarioEngine#stop_all
+・ScenarioEngine#reset_all
+・ScenarioEngine#animation_all
+・InitiativeScenarioEngine::Command#to_choice
+・InitiativeScenarioEngine::CommandEx#to_choice
+・InitiativeScenarioEngine#start_all
+・InitiativeScenarioEngine#stop_all
+・InitiativeScenarioEngine#reset_all
+・InitiativeScenarioEngine#animation_all
+・Choice#arrow
+・SpriteList#render_xy
+・SpriteList#render_xy_to
+<インスタンスメソッド廃止>
+<ドキュメント>
+・リファレンスマニュアルの項目追加
+
 *******************************************************************************
 このReadMeファイルは「れ～どめ～えじた～」によって作成されました。

data/lib/Miyako/API/choices.rb

@@ -26,6 +26,8 @@ module Miyako
     include Animation
     include Layout
 
+    DIRECTION_LIST = [:up, :down, :left, :right, :base]
+
     attr_accessor :visible #レンダリングの可否(true->描画 false->非描画)
 
     def initialize(*params)
@@ -120,6 +122,18 @@ module Miyako
       min_y, max_y = yy.minmax
       return Rect.new(min_x, min_y, max_x-min_x, max_y-min_y)
     end
+
+    #===方向と移動先とを関連づける
+    # _hash_:: (方向)=>(移動先)の関係を持つハッシュ
+    # ハッシュキーは、:up,:down,:left,:right,:baseの5つ
+    #返却値:: 生成された矩形(Rect構造体のインスタンス)
+    def arrow(hash)
+      hash.each{|key, value|
+        raise MiakoValueError, "illegal hash key!" unless DIRECTION_LIST.include?(key)
+        self[key] = value
+      }
+      return self
+    end
   end
 
   #==選択肢構造体
@@ -136,10 +150,10 @@ module Miyako
   #_selected_:: 選択肢が選択されているときはtrue、選択されていないときはfalse
   #_result_:: 選択した結果を示すインスタンス
   #_left_:: 左方向を選択したときに参照するChoice構造体のインスタンス
-  #_right_:: 右方向を選択したときに参照するChoice構造体のインスタンス
   #_up_:: 上方向を選択したときに参照するChoice構造体のインスタンス
+  #_right_:: 右方向を選択したときに参照するChoice構造体のインスタンス
   #_down_:: 下方向を選択したときに参照するChoice構造体のインスタンス
-  #_base_:: 構造体が要素となっている配列
+  #_base_:: 構造体が要素となっているChoices
   #_attribute_:: 属性を示すハッシュ
   #_end_select_proc_:: この選択肢を選択したときに優先的に処理するブロック。
   #ブロックは1つの引数を取る(コマンド選択テキストボックス))。
@@ -147,7 +161,7 @@ module Miyako
   #_name_:: 選択肢の名前。名前を明示的に指定しないときは、オブジェクトIDを文字列化したものが入る
   Choice = ChoiceStruct.new(:body, :body_selected, :body_disable,
                             :condition, :enable, :selected, :result,
-                            :left, :right, :up, :down,
+                            :left, :up, :right, :down,
                             :base, :attribute, :end_select_proc, :name)
 
   #==選択肢を管理するクラス

data/lib/Miyako/API/i_yuki.rb

@@ -71,6 +71,8 @@ module Miyako
     include SpriteBase
     include Animation
 
+    ALL_TRUE = lambda{ true }
+
     #==キャンセルを示す構造体
     #コマンド選択がキャンセルされたときに生成される構造体
     Canceled = Struct.new(:dummy)
@@ -84,6 +86,43 @@ module Miyako
     #_enabe_:: コマンド選択の時はtrue、選択不可の時はfalseを設定
     Command = Struct.new(:body, :body_selected, :body_disable, :enable, :condition, :result)
 
+    class Command
+      # Command構造体をChoice構造体に変換する
+      def to_choice(font=Font.sans_serif, size=16, color=Color[:white])
+        org_font_color = font.color
+        org_font_size = font.size
+
+        font.color = color
+        tmp = self[:body]
+        body = tmp.method(:to_sprite).arity == 0 ? tmp.to_sprite : tmp.to_sprite(font)
+
+        font.color = Color[:red]
+        tmp = self[:body_selected]
+        body_selected = tmp ? (tmp.method(:to_sprite).arity == 0 ? tmp.to_sprite : tmp.to_sprite(font)) : body
+
+        font.color = Color[:dark_gray]
+        tmp = self[:body_disable]
+        body_disable= tmp ? (tmp.method(:to_sprite).arity == 0 ? tmp.to_sprite : tmp.to_sprite(font)) : body
+
+        cond = self[:condition] || ALL_TRUE
+
+        choice = Choice.new(body, body_selected, body_disable,
+                            cond, self[:enable], false, self[:result],
+                            nil, nil, nil, nil,
+                            nil, {}, lambda{}, nil)
+        choice.left = choice
+        choice.right = choice
+        choice.up = choice
+        choice.down = choice
+        choice.name = choice.__id__.to_s
+
+        font.color = org_font_color
+        font.size  = org_font_size
+
+        choice
+      end
+    end
+
     #==コマンド構造体
     #_body_:: コマンドの名称（移動する、調べるなど、アイコンなどの画像も可）
     #_body_selected_:: 選択時コマンドの名称（移動する、調べるなど、アイコンなどの画像も可）(省略時は、bodyと同一)
@@ -95,6 +134,43 @@ module Miyako
     #_enabe_:: コマンド選択の時はtrue、選択不可の時はfalseを設定
     CommandEX = Struct.new(:body, :body_selected, :condition, :body_disable, :enable, :result, :end_select_proc)
 
+    class CommandEx
+      # Command構造体をChoice構造体に変換する
+      def to_choice(font=Font.sans_serif, size=16, color=Color[:white])
+        org_font_color = font.color
+        org_font_size = font.size
+
+        font.color = color
+        tmp = self[:body]
+        body = tmp.method(:to_sprite).arity == 0 ? tmp.to_sprite : tmp.to_sprite(font)
+
+        font.color = Color[:red]
+        tmp = self[:body_selected]
+        body_selected = tmp ? (tmp.method(:to_sprite).arity == 0 ? tmp.to_sprite : tmp.to_sprite(font)) : body
+
+        font.color = Color[:dark_gray]
+        tmp = self[:body_disable]
+        body_disable= tmp ? (tmp.method(:to_sprite).arity == 0 ? tmp.to_sprite : tmp.to_sprite(font)) : body
+
+        cond = self[:condition] || ALL_TRUE
+
+        choice = Choice.new(body, body_selected, body_disable,
+                            cond, self[:enable], false, self[:result],
+                            nil, nil, nil, nil,
+                            nil, {}, self[:end_select_proc], nil)
+        choice.left = choice
+        choice.right = choice
+        choice.up = choice
+        choice.down = choice
+        choice.name = choice.__id__.to_s
+
+        font.color = org_font_color
+        font.size  = org_font_size
+
+        choice
+      end
+    end
+
     attr_reader :visibles, :pre_visibles, :bgs, :base
     attr_reader :valign
     #release_checks:: ポーズ解除を問い合わせるブロックの配列。
@@ -224,7 +300,7 @@ module Miyako
 
       @engine_stack = []
 
-      raise MiyakoProcError, "Aagument count is not same block parameter count!" if proc && proc.arity.abs != params.length
+      raise MiyakoProcError, "Argument count is not same block parameter count!" if proc && proc.arity.abs != params.length
       instance_exec(*params, &proc) if block_given?
     end
 
@@ -274,6 +350,38 @@ module Miyako
       self.pre_visibles.render
     end
 
+    def start_all
+      self.bgs.start
+      self.visibles.start
+      self.textbox_all.start
+      self.commandbox_all.start unless self.box_shared?
+      self.pre_visibles.start
+    end
+
+    def stop_all
+      self.bgs.stop
+      self.visibles.stop
+      self.textbox_all.stop
+      self.commandbox_all.stop unless self.box_shared?
+      self.pre_visibles.stop
+    end
+
+    def reset_all
+      self.bgs.reset
+      self.visibles.reset
+      self.textbox_all.reset
+      self.commandbox_all.reset unless self.box_shared?
+      self.pre_visibles.reset
+    end
+
+    def animation_all
+      self.bgs.update_animation
+      self.visibles.update_animation
+      self.textbox_all.update_animation
+      self.commandbox_all.update_animation unless self.box_shared?
+      self.pre_visibles.update_animation
+    end
+
     #===Yuki#showで表示指定した画像を描画する
     #描画順は、showメソッドで指定した順に描画される(先に指定した画像は後ろに表示される)
     #なお、visibleの値がfalseの時は描画されない。
@@ -798,7 +906,7 @@ module Miyako
       @now_page = nil
       @first_page = nil
 
-      raise MiyakoProcError, "Aagument count is not same block parameter count!" if proc && proc.arity.abs != params.length
+      raise MiyakoProcError, "Argument count is not same block parameter count!" if proc && proc.arity.abs != params.length
       instance_exec(*params, &proc) if proc
 
       return self
@@ -829,9 +937,9 @@ module Miyako
     #返却値:: 自分自身を返す
     def start_plot(base, plot_proc = nil, *params, &plot_block)
       raise MiyakoValueError, "Yuki Error! Textbox is not selected!" unless @text_box
-      raise MiyakoProcError, "Aagument count is not same block parameter count!" if plot_proc && plot_proc.arity.abs != params.length
-      raise MiyakoProcError, "Aagument count is not same block parameter count!" if plot_block && plot_block.arity.abs != params.length
-      raise MiyakoProcError, "Aagument count is not same block parameter count!" if @exec_plot && @exec_plot.arity.abs != params.length
+      raise MiyakoProcError, "Argument count is not same block parameter count!" if plot_proc && plot_proc.arity.abs != params.length
+      raise MiyakoProcError, "Argument count is not same block parameter count!" if plot_block && plot_block.arity.abs != params.length
+      raise MiyakoProcError, "Argument count is not same block parameter count!" if @exec_plot && @exec_plot.arity.abs != params.length
       @base = base
       plot_facade(plot_proc, *params, &plot_block)
       return self
@@ -1314,7 +1422,7 @@ module Miyako
     #引数無しのブロックを渡せば、コマンド選択開始前に、決定判別・キャンセル判別に必要な前処理を施すことが出来る
     #選択中、update_innerメソッドを呼び出し、続けて、処理をYuki#startもしくはYuki#update呼び出し直後に戻す
     #Yuki#updateが呼び出されても選択中の場合は、再び上記の処理を繰り返す
-    #_command_list_:: 表示するコマンド群。各要素はCommand構造体の配列
+    #_command_list_:: 表示するコマンド群。各要素はCommand構造体/CommandEx構造体/Choicesクラスオブジェクトの配列
     #_cancel_to_:: キャンセルボタンを押したときの結果。デフォルトはnil（キャンセル無効）
     #_chain_block_:: コマンドの表示方法。TextBox#create_choices_chainメソッド参照
     #返却値:: 自分自身を返す
@@ -1322,22 +1430,29 @@ module Miyako
       raise MiyakoValueError, "Yuki Error! Commandbox is not selected!" unless @command_box
       @cancel = cancel_to
 
-      choices = []
-      command_list.each{|cm|
-        if (cm[:condition] == nil || cm[:condition].call)
-          cm_array = [cm[:body], cm[:body_selected], cm[:body_disable], cm[:enable], cm[:result]]
-          methods = cm.methods
-          cm_array << (methods.include?(:end_select_proc) ? cm[:end_select_proc] : nil)
-          choices.push(cm_array)
-        end
-      }
-      return self if choices.length == 0
+      if command_list.kind_of?(Choices)
+        @pre_command.each{|proc| proc.call}
+        @pre_cancel.each{|proc| proc.call}
+        @command_box_all.show if @command_box_all.object_id != @text_box_all.object_id
+        @command_box.command(command_list)
+      else
+        choices = []
+        command_list.each{|cm|
+          if (cm[:condition] == nil || cm[:condition].call)
+            cm_array = [cm[:body], cm[:body_selected], cm[:body_disable], cm[:enable], cm[:result]]
+            methods = cm.methods
+            cm_array << (methods.include?(:end_select_proc) ? cm[:end_select_proc] : nil)
+            choices.push(cm_array)
+          end
+        }
+        return self if choices.length == 0
+
+        @pre_command.each{|proc| proc.call}
+        @pre_cancel.each{|proc| proc.call}
+        @command_box_all.show if @command_box_all.object_id != @text_box_all.object_id
+        @command_box.command(@command_box.create_choices_chain(choices, &chain_block))
+      end
 
-      @pre_command.each{|proc| proc.call}
-      @pre_cancel.each{|proc| proc.call}
-      yield if block_given?
-      @command_box_all.show if @command_box_all.object_id != @text_box_all.object_id
-      @command_box.command(@command_box.create_choices_chain(choices, &chain_block))
       @result = nil
       selecting = true
       reset_selecting

data/lib/Miyako/API/modules.rb

@@ -86,6 +86,18 @@ module Miyako
       return 0
     end
 
+    #=== mixin されたインスタンスの部分矩形開始位置(x軸)を取得する
+    #返却値:: 部分矩形開始位置(デフォルトは0)
+    def ox=(v)
+      v
+    end
+
+    #=== mixin されたインスタンスの部分矩形開始位置(y軸)を取得する
+    #返却値::部分矩形開始位置(デフォルトは0)
+    def oy=(v)
+      v
+    end
+
     #=== mixin されたインスタンスの部分矩形幅を取得する
     #返却値:: インスタンスの幅(デフォルトは0)
     def ow
@@ -98,6 +110,18 @@ module Miyako
       return 0
     end
 
+    #=== mixin されたインスタンスの部分矩形幅を取得する
+    #返却値:: インスタンスの幅(デフォルトは0)
+    def ow=(v)
+      v
+    end
+
+    #=== mixin されたインスタンスの部分矩形高を取得する
+    #返却値:: インスタンスの高さ(デフォルトは0)
+    def oh=(v)
+      v
+    end
+
     #=== スプライトの部分矩形を返す
     #返却値:: Rect構造体インスタンス(デフォルトはnil)
     def part_rect
@@ -284,7 +308,7 @@ module Miyako
     #_v_:: 設定する値(true/false)
     #返却値:: 自分自身を返す
     def visible=(v)
-      self.sprite_only.each{|e| e.visible = v}
+      self.each{|e| e.visible = v if e.class.include?(SpriteBase) || e.class.include?(SpriteArray)}
       return self
     end
 
@@ -308,9 +332,9 @@ module Miyako
     #返却値:: 自分自身を返す
     def move!(dx, dy)
       if block_given?
-        self.sprite_only.each_with_index{|e, i| e.move!(*(yield e, i, dx, dy))}
+        self.each_with_index{|e, i| e.move!(*(yield e, i, dx, dy)) if e.class.include?(SpriteBase) || e.class.include?(SpriteArray)}
       else
-        self.sprite_only.each{|e| e.move!(dx, dy)}
+        self.each{|e| e.move!(dx, dy) if e.class.include?(SpriteBase) || e.class.include?(SpriteArray)}
       end
       self
     end
@@ -335,9 +359,9 @@ module Miyako
     #返却値:: 自分自身を返す
     def move_to!(x, y)
       if block_given?
-        self.sprite_only.each_with_index{|e, i| e.move_to!(*(yield e, i, x, y))}
+        self.each_with_index{|e, i| e.move_to!(*(yield e, i, x, y)) if  e.class.include?(SpriteBase) || e.class.include?(SpriteArray)}
       else
-        self.sprite_only.each{|e| e.move_to!(x, y)}
+        self.each{|e| e.move_to!(x, y) if e.class.include?(SpriteBase) || e.class.include?(SpriteArray)}
       end
       self
     end
@@ -346,7 +370,7 @@ module Miyako
     #各要素のstartメソッドを呼び出す
     #返却値:: 自分自身を返す
     def start
-      self.sprite_only.each{|sprite| sprite.start }
+      self.each{|sprite| sprite.start if e.class.include?(SpriteBase) || e.class.include?(SpriteArray) }
       return self
     end
 
@@ -354,7 +378,7 @@ module Miyako
     #各要素のstopメソッドを呼び出す
     #返却値:: 自分自身を返す
     def stop
-      self.sprite_only.each{|sprite| sprite.stop }
+      self.each{|sprite| sprite.stop if e.class.include?(SpriteBase) || e.class.include?(SpriteArray) }
       return self
     end
 
@@ -362,7 +386,7 @@ module Miyako
     #各要素のresetメソッドを呼び出す
     #返却値:: 自分自身を返す
     def reset
-      self.sprite_only.each{|sprite| sprite.reset }
+      self.each{|sprite| sprite.reset if e.class.include?(SpriteBase) || e.class.include?(SpriteArray) }
       return self
     end
 
@@ -370,9 +394,7 @@ module Miyako
     #各要素のupdate_animationメソッドを呼び出す
     #返却値:: 描く画像のupdate_spriteメソッドを呼び出した結果を配列で返す
     def update_animation
-      self.sprite_only.map{|e|
-        e.update_animation
-      }
+      self.map{|e| (e.class.include?(SpriteBase) || e.class.include?(SpriteArray)) ? e.update_animation : false }
     end
 
     #===指定した要素の内容を入れ替える
@@ -393,7 +415,7 @@ module Miyako
     #描画するインスタンスは、SpriteBaseモジュールがmixinされているクラスのみ
     #返却値:: 自分自身を帰す
     def render
-      self.sprite_only.each{|e| e.render }
+      self.each{|e| e.render if  e.class.include?(SpriteBase) || e.class.include?(SpriteArray) }
       return self
     end
 
@@ -402,9 +424,34 @@ module Miyako
     #_dst_:: 描画対象の画像インスタンス
     #返却値:: 自分自身を帰す
     def render_to(dst)
-      self.each{|e| e.render_to(dst) }
+      self.each{|e| e.render_to(dst) if  e.class.include?(SpriteBase) || e.class.include?(SpriteArray) }
       return self
     end
+
+    #===位置を指定して画面への描画を指示するメソッドのテンプレート
+    #オブジェクトで保持している位置情報ではなく、引数で渡された位置に描画する
+    #基本的に、メソッドのオーバーライドにより機能するが、pos,move_to!メソッドを持っているときは、
+    #これらのメソッドを呼び出して同じ動作を行うが処理速度的に課題あり
+    #ただし、上記のメソッドを持っていない場合は、単純にrenderメソッドを呼び出す
+    #_x_:: 描画位置のx座標
+    #_y_:: 描画位置のy座標
+    #返却値:: 自分自身を返す
+    def render_xy(x, y)
+      return self.each{|e| e.render_xy(x, y) if  e.class.include?(SpriteBase) || e.class.include?(SpriteArray) }
+    end
+
+    #===位置を指定して画像への描画を指示するメソッドのテンプレート
+    #オブジェクトで保持している位置情報ではなく、引数で渡された位置に描画する
+    #基本的に、メソッドのオーバーライドにより機能するが、pos,move_to!メソッドを持っているときは、
+    #これらのメソッドを呼び出して同じ動作を行うが、処理速度的に課題あり
+    #ただし、上記のメソッドを持っていない場合は、単純にrender_toメソッドを呼び出す
+    #_dst_:: 対象の画像
+    #_x_:: 描画位置のx座標
+    #_y_:: 描画位置のy座標
+    #返却値:: 自分自身を返す
+    def render_xy_to(dst, x, y)
+      return self.each{|e| e.render_xy_to(dst, x, y) if e.class.include?(SpriteBase) || e.class.include?(SpriteArray)}
+    end
   end
 
   #==ディープコピーを実装するモジュール