ruby-miyako 2.1.0

data/lib/Miyako/API/utility.rb

@@ -0,0 +1,419 @@
+# -*- encoding: utf-8 -*-
+=begin
+--
+Miyako v2.1
+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
+  #==ユーティリティモジュール
+  module Utility
+    def Utility.get_step_array_f(v1, v2, amount, skip_even = false) #:nodoc:
+      steps = []
+      amount = amount.abs
+      val = v1
+      if v1 < v2
+        loop do
+          val = val + amount
+          break if (skip_even && (v2-val).abs < Float::EPSILON)
+          break if val > v2
+          steps << val
+        end
+      else
+        loop do
+          val = val - amount
+          break if (skip_even && (v2-val).abs < Float::EPSILON)
+          break if val < v2
+          steps << val
+        end
+      end
+      return steps
+    end
+
+    def Utility.product_liner_inner_f(x1, y1, x2, y2, amount) #:nodoc:
+      array = nil
+      step_x = get_step_array_f(x1, x2, amount)
+      step_y = get_step_array_f(y1, y2, amount)
+      dx = x2 - x1
+      dy = y2 - y1
+      a = dx < Float::EPSILON ? dy.to_f : dy.to_f / dx.to_f
+      b = y1.to_f - a * x1.to_f
+      array = [[x1,y1] , [x2,y2]] + step_x.map{|x| [x, (a * x.to_f + b).to_i]}
+      array += step_y.map{|y| [((y.to_f - b) / a).to_i, y]} if (a.abs >= Float::EPSILON)
+      return array.uniq
+    end
+
+    #===矩形内の対角線の座標リストを実数で取得する
+    # (互換性維持のために残している)
+    # 矩形内の対角線の座標リストを取得する
+    # 引数には、Rect(x,y,w,h)形式のインスタンスを渡す
+    # 幅・高さはマイナスの値の設定が可能。
+    # 幅・高さのどちらかの値が0(Float::EPSILON未満)の場合は[]が返る
+    # 刻みの値は1以上の整数を渡す。0(Float::EPSILON未満)以下の場合は例外が発生する。
+    # 結果は[x,y]の配列となるが、正確さを優先したため、必ず刻みの値の間隔で並んでいない
+    #(刻みの値より小さい)ことがある
+    #_rect_:: 矩形情報
+    #_amount_:: 配列を作成する座標の刻み。デフォルトは1.0
+    #返却値:: 矩形左上位置[x,y]の配列(指定の矩形に掛かる位置の組み合わせ)
+    def Utility.product_liner_f(rect, amount = 1.0)
+      raise MiyakoValueError, "Illegal amount! #{amount}" if amount < Float::EPSILON
+      return [] if rect[2] < Float::EPSILON || rect[3] < Float::EPSILON
+      x1 = rect[0]
+      y1 = rect[1]
+      x2 = x1 + rect[2] - 1
+      y2 = y1 + rect[3] - 1
+      return product_liner_inner_f(x1, y1, x2, y2, amount)
+    end
+
+    #===矩形内の対角線の座標リストを実数で取得する
+    # (互換性維持のために残している)
+    # 矩形内の対角線の座標リストを取得する
+    # 引数には、Rect(x,y,w,h)形式のインスタンスを渡す
+    # 幅・高さはマイナスの値の設定が可能。
+    # 幅・高さのどちらかの値が0(Float::EPSILON未満)の場合は[]が返る
+    # 刻みの値は1以上の整数を渡す。0(Float::EPSILON未満)以下の場合は例外が発生する。
+    # 結果は[x,y]の配列となるが、正確さを優先したため、必ず刻みの値の間隔で並んでいない
+    #(刻みの値より小さい)ことがある
+    #_rect_:: 矩形情報
+    #_amount_:: 配列を作成する座標の刻み。デフォルトは1
+    #返却値:: 矩形左上位置[x,y]の配列(指定の矩形に掛かる位置の組み合わせ)
+    def Utility.product_liner_by_square_f(square, amount = 1.0)
+      raise MiyakoValueError, "Illegal amount! #{amount}" if amount < Float::EPSILON
+      return [] if (square[2] - square[0]) < Float::EPSILON || (square[3] - square[1]) < Float::EPSILON
+      return product_liner_inner_f(*square, amount)
+    end
+
+    def Utility.product_liner_inner(x1, y1, x2, y2, amount) #:nodoc:
+      array = nil
+      step_x = []
+      step_y = []
+      dx = x2 - x1
+      dy = y2 - y1
+      a  = 0.0
+      if [x1, y1, x2, y2, amount].all?{|v| v.methods.include?(:step)}
+        step_x = x1 < x2 ? x1.step(x2, amount).to_a : x1.step(x2, -amount).to_a
+        step_y = y1 < y2 ? y1.step(y2, amount).to_a : y1.step(y2, -amount).to_a
+        a = dx == 0 ? dy.to_f : dy.to_f / dx.to_f
+      else
+        step_x = get_step_array_f(x1, x2, amount)
+        step_y = get_step_array_f(y1, y2, amount)
+        a = dx < Float::EPSILON ? dy.to_f : dy.to_f / dx.to_f
+      end
+      b = y1.to_f - a * x1.to_f
+      array = [[x1,y1] , [x2,y2]] + step_x.map{|x| [x, (a * x.to_f + b).to_i]}
+      array += step_y.map{|y| [((y.to_f - b) / a).to_i, y]} if (a.abs >= Float::EPSILON)
+      return array.uniq
+    end
+
+    #===矩形内の対角線の座標リストを取得する
+    # 矩形内の対角線の座標リストを取得する
+    # 引数には、Rect(x,y,w,h)形式のインスタンスを渡す
+    # 幅・高さはマイナスの値の設定が可能。
+    # 幅・高さのどちらかの値が0の場合は[]が返る
+    # 刻みの値は1以上の整数を渡す。0以下の場合は例外が発生する。
+    # 結果は[x,y]の配列となるが、正確さを優先したため、必ず刻みの値の間隔で並んでいない
+    #(刻みの値より小さいことがある)ことがある
+    #_rect_:: 矩形情報
+    #_amount_:: 配列を作成する座標の刻み。デフォルトは1
+    #返却値:: 矩形左上位置[x,y]の配列(指定の矩形に掛かる位置の組み合わせ)
+    def Utility.product_liner(rect, amount = 1)
+      raise MiyakoValueError, "Illegal amount! #{amount}" if amount <= 0
+      return [] if rect[2] == 0 || rect[3] == 0
+      x1 = rect[0]
+      y1 = rect[1]
+      x2 = x1 + rect[2] - 1
+      y2 = y1 + rect[3] - 1
+      return product_liner_inner(x1, y1, x2, y2, amount)
+    end
+
+    #===矩形内の対角線の座標リストを取得する
+    # 矩形内の対角線の座標リストを取得する
+    # 引数には、Rect(x,y,w,h)形式のインスタンスを渡す
+    # 幅・高さはマイナスの値の設定が可能。
+    # 幅・高さのどちらかの値が0の場合は[]が返る
+    # 刻みの値は1以上の整数を渡す。0以下の場合は例外が発生する。
+    # 結果は[x,y]の配列となるが、正確さを優先したため、必ず刻みの値の間隔で並んでいない
+    #(刻みの値より小さいことがある)ことがある
+    #_rect_:: 矩形情報
+    #_amount_:: 配列を作成する座標の刻み。デフォルトは1
+    #返却値:: 矩形左上位置[x,y]の配列(指定の矩形に掛かる位置の組み合わせ)
+    def Utility.product_liner_by_square(square, amount = 1)
+      raise MiyakoValueError, "Illegal amount! #{amount}" if amount <= 0
+      return [] if (square[2] - square[0]) == 0 || (square[3] - square[1]) == 0
+      return product_liner_inner(*square, amount)
+    end
+
+    def Utility.product_inner(x1, y1, x2, y2, size) #:nodoc:
+      x_array = ((x1 / size[0])..(x2 / size[0])).to_a.map{|e| e * size[0]}
+      y_array = ((y1 / size[1])..(y2 / size[1])).to_a.map{|e| e * size[1]}
+      return x_array.product(y_array)
+    end
+    
+    #===指定の矩形が格子状のどこに重なっているかを返す
+    # position(Point([x,y])形式)を基準として、矩形rect(Rect([x,y,w,h])形式)が、格子状の並べた矩形
+    # (基準を[0,0]とした、大きさ[size,size]の矩形をタイル状に並べた物)にある場合、
+    #どの格子状の矩形が重なっているかを、矩形の左上座標の配列として渡す(x座標とy座標の組み合わせ)。
+    #
+    #_position_:: 基準位置
+    #_rect_:: 矩形情報
+    #返却値:: 矩形左上位置の配列(指定の矩形に掛かる位置の組み合わせ)
+    def Utility.product_position(position, rect, size)
+      return product_inner(
+               position[0] + rect[0],
+               position[1] + rect[1],
+               position[0] + rect[0] + rect[2] - 1,
+               position[1] + rect[1] + rect[3] - 1,
+               size
+             )
+    end
+
+    #===指定の矩形が格子状のどこに重なっているかを返す
+    # 矩形square(Square([x1,y1,x2,y2])形式)が、格子状の並べた矩形
+    # (基準を[0,0]とした、大きさ[size,size]の矩形をタイル状に並べた物)にある場合、
+    #どの格子状の矩形が重なっているかを、矩形の左上座標の配列として渡す(x座標とy座標の組み合わせ)。
+    #_square_:: 矩形情報
+    #返却値:: 矩形左上位置の配列(指定の矩形に掛かる位置の組み合わせ)
+    def Utility.product_position_by_square(square, size)
+      return product_inner(*square.to_a, size)
+    end
+
+    def Utility.product_inner_f(x1, y1, x2, y2, size, skip_even = false) #:nodoc:
+      sz = size[0].to_f
+      min = (x1.to_f/sz).floor.to_f * sz
+      x_array = [min] + get_step_array_f(min, x2.to_f, sz, skip_even)
+      sz = size[1].to_f
+      min = (y1.to_f/sz).floor.to_f * sz
+      y_array = [min] + get_step_array_f(min, y2.to_f, sz, skip_even)
+      return x_array.uniq.product(y_array.uniq)
+    end
+    
+    #===指定の矩形が格子状のどこに重なっているかを返す(実数で指定)
+    #position(Point([x,y])形式)を基準として、矩形rect(Rect([x,y,w,h])形式)が、格子状の並べた矩形
+    #(基準を[0.0,0.0]とした、大きさ[size,size]の矩形をタイル状に並べた物)にある場合、
+    #どの格子状の矩形が重なっているかを、矩形の左上座標の配列として渡す(x座標とy座標の組み合わせ)。
+    #
+    #_position_:: 基準位置
+    #_rect_:: 矩形情報
+    #返却値:: 矩形左上位置の配列(指定の矩形に掛かる位置の組み合わせ)
+    def Utility.product_position_f(position, rect, size)
+      return product_inner_f(
+               position[0] + rect[0],
+               position[1] + rect[1],
+               position[0] + rect[0] + rect[2],
+               position[1] + rect[1] + rect[3],
+               size,
+               true
+             )
+    end
+
+    #===指定の矩形が格子状のどこに重なっているかを返す(実数で指定)
+    # 矩形square(Square([x1,y1,x2,y2])形式)が、格子状の並べた矩形
+    # (基準を[0.0,0.0]とした、大きさ[size,size]の矩形をタイル状に並べた物)にある場合、
+    #どの格子状の矩形が重なっているかを、矩形の左上座標の配列として渡す(x座標とy座標の組み合わせ)。
+    #_square_:: 矩形情報
+    #返却値:: 矩形左上位置の配列(指定の矩形に掛かる位置の組み合わせ)
+    def Utility.product_position_by_square_f(square, size)
+      return product_inner_f(*square.to_a, size)
+    end
+
+    #===２点間の距離を算出する
+    # ２点(点１、点２)がどの程度離れているかを算出する。
+    # 返ってくる値は、正の実数で返ってくる
+    #_point1_:: 点１の位置(Point/Rect/Square構造体、2要素以上の配列、もしくはx,yメソッドを持つインスタンス)
+    #_point2_:: 点２の位置(Point/Rect/Square構造体、2要素以上の配列、もしくはx,yメソッドを持つインスタンス)
+    #返却値:: 2点間の距離
+    def Utility.interval(point1, point2)
+      #2点間の距離を求める
+      d = Math.sqrt(((point1[0].to_f - point2[0].to_f) ** 2) +
+                    ((point1[1].to_f - point2[1].to_f) ** 2))
+      return d < Float::EPSILON ? 0.0 : d
+    end
+
+    #===２点間の傾きを角度で算出する
+    # ２点(点１、点２)がどの程度傾いているか算出する。傾きの中心は点１とする。
+    # 角度の単位は度(0.0<=θ<360.0)
+    # 返ってくる値は、正の実数で返ってくる
+    #_point1_:: 点１の位置(Point/Rect/Square構造体、2要素以上の配列、もしくはx,yメソッドを持つインスタンス)
+    #_point2_:: 点２の位置(Point/Rect/Square構造体、2要素以上の配列、もしくはx,yメソッドを持つインスタンス)
+    #返却値:: 2点間の傾き
+    def Utility.theta(point1, point2)
+      #2点間の距離を求める
+      d = Math.sqrt(((point1[0].to_f - point2[0].to_f) ** 2) +
+                    ((point1[1].to_f - point2[1].to_f) ** 2))
+      x = point2[0].to_f - point[1].to_f
+      # 傾き・幅が０のときは傾きは０度
+      return 0.0 if (x.abs < Float::EPSILON or d < Float::EPSILON)
+      theta = (Math.acos(x / d) / (2 * Math::PI)) * 360.0
+      return theta < Float::EPSILON ? 0.0 : theta
+    end
+
+    #===小線分を移動させたとき、大線分が範囲内かどうかを判別する
+    # 移動後の小線分が大線分の範囲内にあるかどうかをtrue/falseで取得する
+    #_mini_segment_:: 小線分の範囲。[min,max]で構成された2要素の配列
+    #_big_segment_:: 大線分の範囲。[min,max]で構成された2要素の配列
+    #_d_:: mini_segmentの移動量
+    #_flag_:: 大線分の端いっぱいも範囲外に含めるときはtrueを設定する。デフォルトはfalse
+    #返却値:: 範囲内のときはtrue、範囲外の時はfalseを返す
+    def Utility.in_bounds?(mini_segment, big_segment, d, flag = false)
+      nx = mini_segment[0] + d
+      nx2 = mini_segment[1] + d
+      nx, nx2 = nx2, nx if nx > nx2
+      return flag ? (nx >= big_segment[0] && nx2 <= big_segment[1]) : (nx > big_segment[0] && (nx2 - 1) < big_segment[1])
+    end
+
+    #===小線分を移動させたとき、大線分が範囲内かどうかを判別して、その状態によって値を整数で返す
+    # 移動後の小線分の範囲が大線分の範囲内のときは0、
+    # マイナス方向で範囲外に出るときは-1、
+    # プラス方向で出るときは1を返す
+    #_mini_segment_:: 小線分の範囲。[min,max]で構成された2要素の配列
+    #_big_segment_:: 大線分の範囲。[min,max]で構成された2要素の配列
+    #_d_:: mini_segmentの移動量
+    #_flag_:: 大線分の端いっぱいも範囲外に含めるときはtrueを設定する。デフォルトはfalse
+    #返却値:: 判別の結果
+    def Utility.in_bounds_ex?(mini_segment, big_segment, d, flag = false)
+      nx = mini_segment[0] + d
+      nx2 = mini_segment[1] + d - 1
+      nx, nx2 = nx2, nx if nx > nx2
+      return -1 if (nx < big_segment[0]) || (flag && (nx == big_segment[0]))
+      return (nx2 > big_segment[1]) || (flag && (nx2 == big_segment[1])) ? 1 : 0
+    end
+
+    #===移動先が表示範囲内かどうかを判別して、その状態によって値を整数で返す
+    # 移動後の小線分の範囲が大線分の範囲内のときは0、
+    # マイナス方向で範囲外に出るときは1、
+    # プラス方向で出るときは-1を返す
+    #_mini_segment_:: 小線分の範囲。[min,max]で構成された2要素の配列
+    #_big_segment_:: 大線分の範囲。[min,max]で構成された2要素の配列
+    #_d_:: mini_segmentの移動量
+    #_flag_:: 大線分の端いっぱいも範囲外に含めるときはtrueを設定する。デフォルトはfalse
+    #返却値:: 判別の結果
+    def Utility.in_bounds_rev?(mini_segment, big_segment, d, flag = false)
+      nx = mini_segment[0] + d
+      nx2 = mini_segment[1] + d - 1
+      nx, nx2 = nx2, nx if nx > nx2
+      return 1 if (nx < big_segment[0]) || (flag && (nx == big_segment[0]))
+      return (nx2 > big_segment[1]) || (flag && (nx2 == big_segment[1])) ? -1 : 0
+    end
+
+    #===移動先が表示範囲内かどうかを判別して、その状態によって値を整数で返す
+    # 移動量が0のときは0、
+    # 移動後の小線分の範囲が大線分の範囲内のときは1、
+    # 範囲外に出るときは-1を返す
+    #_mini_segment_:: 小線分の範囲。[min,max]で構成された2要素の配列
+    #_big_segment_:: 大線分の範囲。[min,max]で構成された2要素の配列
+    #_d_:: mini_segmentの移動量
+    #_flag_:: 大線分の端いっぱいも範囲外に含めるときはtrueを設定する。デフォルトはfalse
+    #返却値:: 判別の結果
+    def Utility.in_bounds_rev_ex?(mini_segment, big_segment, d, flag = false)
+      return 0 if d == 0
+      dir = (d <=> 0)
+      nx = mini_segment[0] + d
+      nx2 = mini_segment[1] + d - 1
+      nx, nx2 = nx2, nx if nx > nx2
+      return -dir if (nx < big_segment[0]) || (flag && (nx == big_segment[0]))
+      return (nx2 > big_segment[1]) || (flag && (nx2 == big_segment[1])) ? -dir : dir
+    end
+
+    #===小線分を移動させたとき、大線分が範囲内かどうかを判別する
+    # 移動後の小線分が大線分の範囲内にあるかどうかをtrue/falseで取得する
+    #_mini_pos_:: 小線分の開始点の位置
+    #_mini_size_:: 小線分の幅。0以上の整数
+    #_big_pos_:: 大線分の開始点の位置
+    #_big_size_:: 大線分の幅。1以上の整数
+    #_d_:: mini_segmentの移動量
+    #_flag_:: 大線分の端いっぱいも範囲外に含めるときはtrueを設定する。デフォルトはfalse
+    #返却値:: 範囲内のときはtrue、範囲外の時はfalseを返す
+    def Utility.in_bounds_by_size?(pos1, size1, pos2, size2, d, flag = false)
+      raise MiyakoValueError, "illegal size1! #{size1}" if size1 < 0
+      raise MiyakoValueError, "illegal size2! #{size2}" if size2 <= 0
+      raise MiyakoValueError, "size1 is more than size2! #{size1}, #{size2}" if size1 > size2
+      min_x1 = pos1 + d
+      min_x2 = pos1 + size1 + d
+      min_x1, min_x2 = min_x2, min_x1 if min_x1 > min_x2
+      return flag ? (min_x1 >= pos2 && min_x2 <= pos2+size2) : (minx_x1 > pos2 && min_x2 < pos2+size2)
+    end
+
+    #===小線分を移動させたとき、大線分が範囲内かどうかを判別して、その状態によって値を整数で返す
+    # 移動後の小線分の範囲が大線分の範囲内のときは0、
+    # マイナス方向で範囲外に出るときは-1、
+    # プラス方向で出るときは1を返す
+    #_mini_pos_:: 小線分の開始点の位置
+    #_mini_size_:: 小線分の幅。0以上の整数
+    #_big_pos_:: 大線分の開始点の位置
+    #_big_size_:: 大線分の幅。1以上の整数
+    #_d_:: mini_segmentの移動量
+    #_flag_:: 大線分の端いっぱいも範囲外に含めるときはtrueを設定する。デフォルトはfalse
+    #返却値:: 判別の結果
+    def Utility.in_bounds_ex_by_size?(pos1, size1, pos2, size2, d, flag = false)
+      raise MiyakoValueError, "illegal size1! #{size1}" if size1 < 0
+      raise MiyakoValueError, "illegal size2! #{size2}" if size2 <= 0
+      raise MiyakoValueError, "size1 is more than size2! #{size1}, #{size2}" if size1 > size2
+      min_x1 = pos1 + d
+      min_x2 = pos1 + size1 + d
+      min_x1, min_x2 = min_x2, min_x1 if min_x1 > min_x2
+      return -1 if (min_x1 < pos2) || (flag && (min_x1 == pos2))
+      return (min_x2 > pos2+size2) || (flag && (min_x2 == pos2+size2)) ? 1 : 0
+    end
+
+    #===移動先が表示範囲内かどうかを判別して、その状態によって値を整数で返す
+    # 移動後の小線分の範囲が大線分の範囲内のときは0、
+    # マイナス方向で範囲外に出るときは1、
+    # プラス方向で出るときは-1を返す
+    #_mini_pos_:: 小線分の開始点の位置
+    #_mini_size_:: 小線分の幅。0以上の整数
+    #_big_pos_:: 大線分の開始点の位置
+    #_big_size_:: 大線分の幅。1以上の整数
+    #_d_:: mini_segmentの移動量
+    #_flag_:: 大線分の端いっぱいも範囲外に含めるときはtrueを設定する。デフォルトはfalse
+    #返却値:: 判別の結果
+    def Utility.in_bounds_rev_by_size?(pos1, size1, pos2, size2, d, flag = false)
+      raise MiyakoValueError, "illegal size1! #{size1}" if size1 < 0
+      raise MiyakoValueError, "illegal size2! #{size2}" if size2 <= 0
+      raise MiyakoValueError, "size1 is more than size2! #{size1}, #{size2}" if size1 > size2
+      min_x1 = pos1 + d
+      min_x2 = pos1 + size1 + d
+      min_x1, min_x2 = min_x2, min_x1 if min_x1 > min_x2
+      return 1 if (min_x1 < pos2) || (flag && (min_x1 == pos2))
+      return (min_x2 > pos2+size2) || (flag && (min_x2 == pos2+size2)) ? -1 : 0
+    end
+
+    #===移動先が表示範囲内かどうかを判別して、その状態によって値を整数で返す
+    # 移動量が0のときは0、
+    # 移動後の小線分の範囲が大線分の範囲内のときは1、
+    # 範囲外に出るときは-1を返す
+    #_mini_pos_:: 小線分の開始点の位置
+    #_mini_size_:: 小線分の幅。0以上の整数
+    #_big_pos_:: 大線分の開始点の位置
+    #_big_size_:: 大線分の幅。1以上の整数
+    #_d_:: mini_segmentの移動量
+    #_flag_:: 大線分の端いっぱいも範囲外に含めるときはtrueを設定する。デフォルトはfalse
+    #返却値:: 判別の結果
+    def Utility.in_bounds_rev_ex_by_size?(pos1, size1, pos2, size2, d, flag = false)
+      return 0 if d == 0
+      raise MiyakoValueError, "illegal size1! #{size1}" if size1 < 0
+      raise MiyakoValueError, "illegal size2! #{size2}" if size2 <= 0
+      raise MiyakoValueError, "size1 is more than size2! #{size1}, #{size2}" if size1 > size2
+      dir = (d <=> 0)
+      min_x1 = pos1 + d
+      min_x2 = pos1 + size1 + d
+      min_x1, min_x2 = min_x2, min_x1 if min_x1 > min_x2
+      return -dir if (min_x1 < pos2) || (flag && (min_x1 == pos2))
+      return (min_x2 > pos2+size2) || (flag && (min_x2 == pos2+size2)) ? -dir : dir
+    end
+  end
+end

data/lib/Miyako/API/viewport.rb

@@ -0,0 +1,190 @@
+# -*- encoding: utf-8 -*-
+=begin
+--
+Miyako v2.1
+Copyright (C) 2007-2008  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
+  #==ビューポートクラス
+  # 描画時の表示範囲を変更する
+  # 画面全体を基準(640x480の画面のときは(0,0)-(639,479)の範囲)として、範囲を設定する
+  # 範囲の設定はいつでも行えるが、描画にはrenderメソッドを呼び出した時の値が反映される
+  class Viewport
+    include SpriteBase
+    include Animation
+    
+    attr_accessor :visible #レンダリングの可否(true->描画 false->非描画)
+
+    #===ビューポートのインスタンスを生成する
+    #_x_:: ビューポートの左上位置(x座標)
+    #_y_:: ビューポートの左上位置(y座標)
+    #_w_:: ビューポートの幅(共に1以上、0以下のときはエラーが出る)
+    #_h_:: ビューポートの高さ(共に1以上、0以下のときはエラーが出る)
+    def initialize(x, y, w, h)
+      raise MiyakoValueError, "Illegal size! w:#{w} h:#{h}" if (w <= 0 || h <= 0)
+      @rect = Rect.new(x, y, w, h)
+      @sq = Rect.new(x, y, x+w-1, y+h-1)
+      @visible = true
+    end
+    
+    def initialize_copy(obj) #:nodoc:
+      @rect = @rect.dup
+      @sq = @sq.dup
+    end
+
+    #===ビューポートの内容を画面に反映する
+    # ブロックが渡ってきたときは、範囲を変更して指定することが出来る(この変更は、本メソッドを呼ぶ時だけ有効)
+    # ブロックの引数は、|Rect構造体|が渡される。
+    #_block_:: 呼び出し時にブロック付き呼び出しが行われたときのブロック本体。
+    #呼び先に渡すことが出来る。ブロックがなければnilが入る
+    def render(&block)
+      return unless @visible
+      if block_given?
+        rect = @rect.dup
+        yield rect
+        Screen.bitmap.set_clip_rect(*rect)
+      else
+        Screen.bitmap.set_clip_rect(*@rect)
+      end
+    end
+
+    #===ビューポートの左上位置を変更する
+    # 移動量を指定して、位置を変更する
+    # ブロックを渡したとき、ブロックの評価した結果、偽になったときは移動させた値を元に戻す
+    #_dx_:: 移動量(x方向)
+    #_dy_:: 移動量(y方向)
+    #返却値:: 自分自身を返す
+    def move!(dx,dy)
+      orect = rect.to_a[0..1]
+      osq = sq.to_a[0..1]
+      @rect.move!(dx,dy)
+      @sq.move!(dx, dy)
+      if block_given?
+        unless yield(self)
+          @rect.move_to!(*orect)
+          @sq.move_to!(*osq)
+        end
+      end
+      return self
+    end
+
+    #===ビューポートの左上位置を変更する
+    # 移動先を指定して、位置を変更する
+    # ブロックを渡したとき、ブロックの評価した結果、偽になったときは移動させた値を元に戻す
+    #_x_:: 移動先位置(x方向)
+    #_y_:: 移動先位置(y方向)
+    #返却値:: 自分自身を返す
+    def move_to!(x,y)
+      orect = rect.to_a[0..1]
+      osq = sq.to_a[0..1]
+      @rect.move_to!(x,y)
+      @sq.move_to!(x, y)
+      if block_given?
+        unless yield(self)
+          @rect.move_to!(*orect)
+          @sq.move_to!(*osq)
+        end
+      end
+    end
+
+    #===ビューポートの大きさを変更する
+    # 変化量を指定して変更する
+    #_dw_:: 幅
+    #_dh_:: 高さ
+    #返却値:: 自分自身を返す
+    def resize!(dw,dh)
+      raise MiyakoValueError, "Illegal size! w:#{w} h:#{h}" if ((@rect.w + dw) <= 0 || (@rect.h + dh) <= 0)
+      @rect.resize!(dw, dh)
+      @sq.resize!(dw, dh)
+      return self
+    end
+
+    #===ビューポートの大きさを変更する
+    # 幅と高さを指定して変更する
+    #_w_:: 幅
+    #_h_:: 高さ
+    #返却値:: 自分自身を返す
+    def resize_to!(w,h)
+      raise MiyakoValueError, "Illegal size! w:#{w} h:#{h}" if (w <= 0 || h <= 0)
+      @rect.resize_to!(w,h)
+      @sq.resize_to!(w, h)
+      return self
+    end
+
+    #===ビューポートの左上位置を変更したときの位置を求める
+    #移動量を指定して、位置を変更する
+    #ただし、自分自身の位置は変わらない
+    #_dx_:: 移動量(x方向)
+    #_dy_:: 移動量(y方向)
+    #返却値:: 更新したインスタンス(Rect構造体)を返す
+    def move(dx,dy)
+      @rect.dup.move!(dx,dy)
+    end
+
+    #===ビューポートの左上位置を変更したときの位置を求める
+    #移動先を指定して、位置を変更する
+    #ただし、自分自身の位置は変わらない
+    #_x_:: 移動先位置(x方向)
+    #_y_:: 移動先位置(y方向)
+    #返却値:: 更新したインスタンス(Rect構造体)を返す
+    def move_to(x,y)
+      @rect.dup.move_to!(x,y)
+    end
+
+    #===ビューポートの大きさを変更したときの値を求める
+    #変化量を指定して変更する
+    #ただし、自分自身の位置は変わらない
+    #_dw_:: 幅
+    #_dh_:: 高さ
+    #返却値:: 更新したインスタンス(Rect構造体)を返す
+    def resize(dw,dh)
+      raise MiyakoValueError, "Illegal size! w:#{w} h:#{h}" if ((@rect.w + dw) <= 0 || (@rect.h + dh) <= 0)
+      @rect.dup.resize!(dw,dh)
+    end
+
+    #===ビューポートの大きさを変更したときの値を求める
+    #幅と高さを指定して変更する
+    #ただし、自分自身の位置は変わらない
+    #_w_:: 幅
+    #_h_:: 高さ
+    #返却値:: 更新したインスタンス(Rect構造体)を返す
+    def resize_to(w,h)
+      raise MiyakoValueError, "Illegal size! w:#{w} h:#{h}" if (w <= 0 || h <= 0)
+      @rect.dup.resize_to!(w,h)
+    end
+    
+    #===インスタンスを解放する
+    def dispose
+      @rect = nil
+      @sq   = nil
+    end
+    
+    #===ビューポートのインスタンスを複製する
+    #返却値:: 自分自身の複製
+    def viewport
+      return self.dup
+    end
+    
+    #===ビューポートのインスタンスを「左、右、上、下」の形式で取得する
+    #返却値:: ビューポートの矩形(Square構造体インスタンス)の複製
+    def square
+      return @sq.dup
+    end
+  end
+end