Class: Miyako::TextBox

Inherits:
Object show all
Extended by:
Forwardable
Includes:
Animation, Layout, SpriteBase
Defined in:
lib/Miyako/API/textbox.rb

Overview

テキストボックスを構成するクラス

テキスト表示部、ウェイトカーソル、選択カーソルで構成される

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Layout

#add_snap_child, #bottom, #bottom!, #center, #center!, #centering, #centering!, #copy_layout, #delete_snap_child, #get_snap_children, #get_snap_sprite, #h, #include_snap_child?, #init_layout, #layout_dispose, #left, #left!, #middle, #middle!, #move, #move!, #move_to, #move_to!, #on_move, #outside_bottom, #outside_bottom!, #outside_left, #outside_left!, #outside_right, #outside_right!, #outside_top, #outside_top!, #pos, #rect, #relative_move_to, #relative_move_to!, #reset_snap, #right, #right!, #segment, #set_layout_size, #set_snap_children, #set_snap_sprite, #snap, #top, #top!, #update_layout, #w, #x, #y

Methods included from Animation

[], []=, anim_hash, reset, start, stop, update, update_animation

Methods included from SpriteBase

#bitmap, #hide, #image_rect, #image_size, #oh, #oh=, #ow, #ow=, #ox, #ox=, #oy, #oy=, #part_rect, #rect, #render_d, #render_xy, #render_xy_to, #show

Constructor Details

#initialize(params = {}) ⇒ TextBox

インスタンスの作成

テキストボックスを生成する。パラメータは以下の通り。 (括弧内は省略形)

:font

描画フォント(Fontクラスのインスタンス) デフォルトはFont.sans_serif

:size

描画文字数(2要素の配列またはSize構造体のインスタンス) デフォルトはSize(20,8)

_:wait_cursor(:wc)_

ボタン入力待ちを示すカーソル(SpriteもしくはSpriteAnimationクラスのインスタンス)

_:select_cursor(:sc)_

選択カーソル(SpriteもしくはSpriteAnimationクラスのインスタンス)

:page_size

一度にテキストボックスに表示させる選択肢の数(縦方向、デフォルトは8)

params

生成時のパラメータ(ハッシュ引数)

返却値

TextBoxクラスのインスタンス


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/Miyako/API/textbox.rb', line 49

def initialize(params = {})
  init_layout
  @visible = true
  @font = params[:font] || Font.sans_serif
  @max_height = @font.line_height
  @locate     = Point.new(0, 0)

  @base = params[:size] || Size.new(20, 8)
  @size = Size.new((@font.size + @font.hspace) * @base[0] - @font.hspace +
                    (@font.use_shadow ? @font.shadow_margin[0] : 0),
                   @font.line_height *
                    @base[1] - @font.vspace)
  @pos = Point.new(0, 0)
  set_layout_size(*@size)

  @margin = 0

  @textarea = Sprite.new({:size => @size, :type => :ac, :is_fill => true})

  @default_wait_cursor_position = lambda{|wcursor, tbox| wcursor.center!.outside_bottom!}
  @default_select_cursor_position = lambda{|scursor, tbox| scursor.outside_left!.middle!}

  @wait_cursor = params[:wait_cursor] || params[:wc] || nil
  @wait_cursor_position = @default_wait_cursor_position
  @select_cursor = params[:select_cursor] || params[:sc] || nil
  @select_cursor_position = @default_select_cursor_position

  @on_pause = lambda{}

  @on_release = lambda{}

  @on_draw = lambda{}

  @command_page_size = params[:page_size] || @base[1]

  @choices = Choices.new
  @choices.snap(self)
  @choices.left!.top!

  @now_choice = nil
  @pre_attach = false

  @waiting = false
  @selecting = false

  @textarea.snap(self)
  @textarea.centering!

  @fiber = nil

  if @wait_cursor
    @wait_cursor.snap(self)
    @default_wait_cursor_position.call(@wait_cursor, self)
  end
  @select_cursor.snap(self) if @select_cursor

  @move_list = [
                [lambda{                       },
                 lambda{ @choices.right_choice },
                 lambda{ @choices.left_choice  }],
                [lambda{ @choices.down_choice  },
                 lambda{                       },
                 lambda{                       }],
                [lambda{ @choices.up_choice    },
                 lambda{                       },
                 lambda{                       }]
               ]

end

Instance Attribute Details

#choicesObject (readonly)

Returns the value of attribute choices


35
36
37
# File 'lib/Miyako/API/textbox.rb', line 35

def choices
  @choices
end

#fontObject

Returns the value of attribute font


34
35
36
# File 'lib/Miyako/API/textbox.rb', line 34

def font
  @font
end

#locateObject (readonly)

Returns the value of attribute locate


36
37
38
# File 'lib/Miyako/API/textbox.rb', line 36

def locate
  @locate
end

#marginObject

Returns the value of attribute margin


34
35
36
# File 'lib/Miyako/API/textbox.rb', line 34

def margin
  @margin
end

#max_heightObject (readonly)

Returns the value of attribute max_height


36
37
38
# File 'lib/Miyako/API/textbox.rb', line 36

def max_height
  @max_height
end

#select_cursorObject (readonly)

Returns the value of attribute select_cursor


35
36
37
# File 'lib/Miyako/API/textbox.rb', line 35

def select_cursor
  @select_cursor
end

#selectingObject

Returns the value of attribute selecting


33
34
35
# File 'lib/Miyako/API/textbox.rb', line 33

def selecting
  @selecting
end

#sizeObject (readonly)

Returns the value of attribute size


36
37
38
# File 'lib/Miyako/API/textbox.rb', line 36

def size
  @size
end

#textareaObject

Returns the value of attribute textarea


32
33
34
# File 'lib/Miyako/API/textbox.rb', line 32

def textarea
  @textarea
end

#visibleObject

Returns the value of attribute visible


32
33
34
# File 'lib/Miyako/API/textbox.rb', line 32

def visible
  @visible
end

#wait_cursorObject (readonly)

Returns the value of attribute wait_cursor


35
36
37
# File 'lib/Miyako/API/textbox.rb', line 35

def wait_cursor
  @wait_cursor
end

#waitingObject

Returns the value of attribute waiting


33
34
35
# File 'lib/Miyako/API/textbox.rb', line 33

def waiting
  @waiting
end

Instance Method Details

#attach_any_command?(x, y) ⇒ Boolean

マウスカーソルの位置にコマンドがあるかどうかを問い合わせる

マウスカーソルがどれかのコマンドの上にあるときはtrue、どれにも当たっていないときはfalseを返す

x

マウスカーソルの位置(x軸方向)

y

マウスカーソルの位置(y軸方向)

返却値

マウスカーソルがどれかのコマンドにあるときはtrueを返す


610
611
612
# File 'lib/Miyako/API/textbox.rb', line 610

def attach_any_command?(x, y)
  return @choices.attach(x, y)
end

#attach_cursor(x, y) ⇒ Object

マウスカーソルの位置とコマンドを照合する

選択肢・選択カーソルを、マウスカーソルが当たっているコマンドに移動させる どのコマンドにも当たっていない場合は、すべてのコマンドは非選択状態になる

x

マウスカーソルの位置(x軸方向)

y

マウスカーソルの位置(y軸方向)

返却値

自分自身を返す


586
587
588
589
590
591
592
593
594
595
596
597
598
599
# File 'lib/Miyako/API/textbox.rb', line 586

def attach_cursor(x, y)
  attach = @choices.attach(x, y)
  if attach
    if @select_cursor
      @select_cursor.snap(@choices.body)
      @select_cursor_position.call(@select_cursor, @choices.body)
    end
  else
    @choices.non_select if @pre_attach
    @select_cursor.snap(@choices.body) if @select_cursor
  end
  @pre_attach = attach
  return self
end

#attach_cursor?Boolean


601
602
603
# File 'lib/Miyako/API/textbox.rb', line 601

def attach_cursor?
  @choices.attach?(Input.mouse_x, Input.mouse_y)
end

#broad_rectObject

現在の画面の最大の大きさを矩形で取得する

テキストボックスの状態により、取得できる矩形の大きさが変わる

返却値

生成された矩形(Rect構造体のインスタンス)


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/Miyako/API/textbox.rb', line 288

def broad_rect
  rect = self.rect.to_a
  rect_list = []
  rect_list << @wait_cursor.broad_rect if (@wait_cursor && @waiting)
  if @selecting
    rect_list << @choices.broad_rect
    rect_list << @select_cursor.broad_rect if @select_cursor
  end
  return self.rect if rect_list.length == 0
  rect_list = rect.zip(*rect_list)  # width -> right

  rect_list[2] = rect_list[2].zip(rect_list[0]).map{|xw| xw[0] + xw[1]}  # height -> bottom

  rect_list[3] = rect_list[3].zip(rect_list[1]).map{|xw| xw[0] + xw[1]}
  x, y = rect_list[0].min, rect_list[1].min
  return Rect.new(x, y, rect_list[2].max - x, rect_list[3].max - y)
end

#clearObject

テキストエリアに描画している文字を消去する

透明色で消去したあと、描画開始位置を左上(0,0)に移動する

返却値

自分自身を返す


751
752
753
754
755
756
757
# File 'lib/Miyako/API/textbox.rb', line 751

def clear
  @textarea.bitmap.fillRect(0, 0, @size[0], @size[1], [0, 0, 0, 0])
  @locate = Point.new(0, 0)
  @max_height = @font.line_height
  Fiber.yield if @fiber
  return self
end

#color_during(color) ⇒ Object

ブロックを評価している間、文字色を変更する

color

変更する文字色(の3要素の配列(値:0~255))

返却値

自分自身を返す

Raises:


366
367
368
369
370
# File 'lib/Miyako/API/textbox.rb', line 366

def color_during(color)
  raise MiyakoProcError, "not given block!" unless block_given?
  @font.color_during(Color.to_rgb(color)){ yield }
  return self
end

#columnsObject

一列に表示可能な文字数を取得する

返却される値は全角文字の数だが、半角文字も全角文字1文字と計算されるので注意

返却値

表示可能な文字数


174
175
176
# File 'lib/Miyako/API/textbox.rb', line 174

def columns
  return @base.w
end

#command(choices, dx = nil, dy = nil) ⇒ Object

コマンド選択を設定する

コマンド選択処理に移る(self#selecting?メソッドがtrueになる)

引数choicesに配列を渡すとき、各要素の構成は以下のようになる

コマンド文字列・画像,選択時コマンド文字列・画像,選択した結果(オブジェクト)

引数choicesにChoicesクラスインスタンスを渡したとき、内部で、インスタンスを複写したものに置き換える

このメソッドが呼び出された時、選択肢はlocateメソッドの値となる位置に移動する 引数dx,dyともにnil以外の数値を渡すと、上記の位置から更に移動する(位置が補正される) body_selectedをnilにした場合は、bodyと同一となる body_selectedを文字列を指定した場合は、文字色が赤色になることに注意

choices

選択肢の配列、もしくはChoicesクラスのインスタンス

dx

選択肢を表示するx座標の移動量。デフォルトはnil(移動しない)

dy

選択肢を表示するy座標の移動量。デフォルトはnil(移動しない)

返却値

自分自身を返す


520
521
522
523
524
525
526
527
528
529
530
531
532
533
# File 'lib/Miyako/API/textbox.rb', line 520

def command(choices, dx = nil, dy = nil)
  if choices.methods.include?(:start_choice)
    @choices = choices
    @choices.snap(self)
  else
    @choices.clear
    choices.each{|cc| @choices.create_choices(cc) }
  end
  @choices.left!{|b| @locate.x}.top!{|b| @locate.y}
  @choices.move!(dx, dy) if (dx != nil && dy != nil)
  start_command
  Fiber.yield if @fiber
  return self
end

#cr(height = @max_height) ⇒ Object

縦方向のスペースを空ける

現在描画可能な位置から、指定したピクセルで下方向に移動する 但し、文字の大きさもピクセル数に含むことに注意すること

height

スペースを空けるピクセル数

返却値

自分自身を返す


764
765
766
767
768
769
770
# File 'lib/Miyako/API/textbox.rb', line 764

def cr(height = @max_height)
  @locate.x = 0
  @locate.y += height
  @max_height = @font.line_height
  Fiber.yield if @fiber
  return self
end

#create_choices_chain(choices) ⇒ Object

選択肢の集合をTextBoxインスタンスに見合う形のChoicesクラスインスタンスの配列に変換する

ブロック(引数一つのブロックのみ有効)を渡したときは、ブロックを評価して変換したChoicesクラスの配列を作成する。 引数は、以下の構成を持つ配列のリスト。 [非選択時スプライト(文字列可),選択時スプライト(文字列・nil可),選択不可時スプライト(文字列・nil可), 使用可・不可フラグ,選択結果インスタンス] 非選択時スプライト:自身が選択されていない時に表示するスプライト。文字列の時は、Shapeクラスなどでスプライトに変更する 選択時スプライト:自身が選択されている時に表示するスプライト。文字列の時は、Shapeクラスなどでスプライトに変更する (そのとき、文字色が赤色になる)。 nilを渡すと、非選択時スプライトが使われる 選択不可時スプライト:自身が選択不可の時に表示するスプライト。文字列の時は、Shapeクラスなどでスプライトに変更する (そのとき、文字色が灰色になる)。 nilを渡すと、非選択時スプライトが使われる 注:スプライトは、画面にスナップしておくこと 使用可・使用不可フラグ:自身が使用可のときはtrue、使用不可の時はfalseを返す 選択結果インスタンス:コマンドが決定したときに、resultメソッドの値として渡すインスタンス。 デフォルト処理の選択肢の位置は、画面左上から下へ順番に設定される 注:ブロックを渡すとき、選択肢の位置計算が、全選択肢の左上位置がとする相対座標になっていること

choices

選択肢の集合(上記参照)

返却値

Choicesクラスのインスタンスの配列


465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'lib/Miyako/API/textbox.rb', line 465

def create_choices_chain(choices)
  if block_given?
    return yield(choices)
  end
  choices = choices.map{|v|
    org_font_color = @font.color
    @font.color = Color[:white]
    body = v[0].method(:to_sprite).arity == 0 ? v[0].to_sprite : v[0].to_sprite(@font)
    @font.color = Color[:red]
    body_selected = v[1] ? (v[1].method(:to_sprite).arity == 0 ? v[1].to_sprite : v[1].to_sprite(@font)) : body
    @font.color = Color[:dark_gray]
    body_disable  = v[2] ? (v[2].method(:to_sprite).arity == 0 ? v[2].to_sprite : v[2].to_sprite(@font)) : body
    @font.color = org_font_color
    choice = Choices.create_choice(body, body_selected, false, body_disable, v[3])
    choice.result = v[4]
    choice.end_select_proc = v[5]
    next choice
  }
  choices2 = choices.each_slice(@command_page_size).to_a
  choices2.each_with_index{|cc, x|
    len = cc.length
    right = choices2[x + 1] || choices2[0]
    left = choices2[x - 1]
    yp = 0
    cc.each_with_index{|v, y|
      v.down = cc[y + 1] || cc[0]
      v.up = cc[y - 1]
      v.right = right[y] || right.last
      v.left = left[y] || left.last
      v.move_to!(0, yp)#          v.body.move_to!(0, yp)
#          v.body_selected.move_to!(0, yp)
#          v.body_disable.move_to!(0, yp)

      yp += [v.body.broad_rect.h, v.body_selected.broad_rect.h].max
    }
  }
  return choices2
end

#disposeObject

情報を解放する


783
784
785
786
# File 'lib/Miyako/API/textbox.rb', line 783

def dispose
  @textarea.dispose
  @textarea = nil
end

#draw_text(text) ⇒ Object

テキストエリアに文字を描画する

text

描画する文字列

返却値

自分自身を返す


423
424
425
426
427
428
429
# File 'lib/Miyako/API/textbox.rb', line 423

def draw_text(text)
  @locate.x = @font.draw_text(@textarea, text, @locate.x, @locate.y + @margin)
  @max_height = [@max_height, @font.line_height].max
  @on_draw.call
  Fiber.yield if @fiber
  return self
end

#enable_choice?Boolean

選択した選択肢が利用可能か問い合わせる

選択した選択肢(Choice構造体)が選択可能(Chices#enable?の値)のときはtrue、選択不可の時はfalseを返す

返却値

true/false


617
618
619
# File 'lib/Miyako/API/textbox.rb', line 617

def enable_choice?
  @choices.enable?
end

#execute(*params, &block) ⇒ Object

並行なブロック処理を開始する

ブロックをFiberに渡して、並行実行できるようにして、Fiberを開始する ブロックには引数を必ず一つ付けること。引数には自分自身と、 executeメソッドの引数リスト(配列化されて渡ってくる)が渡ってくる。 渡したブロックは、現在の処理と切り替えて実行することになる 現在の処理からブロック処理へ切り替えるときは、TextBox#updateメソッドを呼び出す ブロック処理から現在の処理に戻るには、ブロックから抜け出すか、 draw_text・command・pause・clear・cr・spaceのどれかのメソッドを呼び出す。

params

Fiberに渡す引数リスト。Fiberへは配列として渡される

Raises:


195
196
197
198
199
200
# File 'lib/Miyako/API/textbox.rb', line 195

def execute(*params, &block)
  raise MiyakoProcError, "This method needs a block!" unless block
  raise MiyakoProcError, "This method needs a block with one parameter!" unless block.arity == 2
  @fiber = Fiber.new(&block)
  @fiber.resume(self, params)
end

#execute?Boolean

並行ブロック処理が実行中かどうかを問い合わせる

返却値

Fiberが評価中ならば、trueを返す


204
205
206
# File 'lib/Miyako/API/textbox.rb', line 204

def execute?
  return @fiber != nil
end

#finish_commandObject

コマンド選択を終了する

選択した選択肢(Choice構造体)にend_select_procブロックが設定されていれば自動的に評価される

返却値

自分自身を返す


553
554
555
556
557
558
559
# File 'lib/Miyako/API/textbox.rb', line 553

def finish_command
  @choices.end_choice(self)
  @choices.left!.top!
  @choices.stop
  @selecting = false
  return self
end

#font_boldObject

ブロックを評価している間、太字に変更する

文字が領域外にはみ出る場合があるので注意!

返却値

自分自身を返す

Raises:


397
398
399
400
401
# File 'lib/Miyako/API/textbox.rb', line 397

def font_bold
  raise MiyakoProcError, "not given block!" unless block_given?
  @font.bold{ yield }
  return self
end

#font_italicObject

ブロックを評価している間、斜体文字に変更する

文字が領域外にはみ出る場合があるので注意!

返却値

自分自身を返す

Raises:


406
407
408
409
410
# File 'lib/Miyako/API/textbox.rb', line 406

def font_italic
  raise MiyakoProcError, "not given block!" unless block_given?
  @font.italic{ yield }
  return self
end

#font_size=(size) ⇒ Object

フォントサイズを変更する

行中の最大フォントサイズが更新されるので、見栄えの良い表示のためにこちらを使用することをお薦めします

size

変更するフォントサイズ

返却値

自分自身を返す


376
377
378
379
380
# File 'lib/Miyako/API/textbox.rb', line 376

def font_size=(size)
  @font.size = size
  @max_height = @font.line_height if @max_height < @font.line_height
  return self
end

#font_size_during(size) ⇒ Object

ブロックを評価している間、フォントサイズを変更する

size

変更するフォントサイズ

返却値

自分自身を返す

Raises:


385
386
387
388
389
390
391
392
# File 'lib/Miyako/API/textbox.rb', line 385

def font_size_during(size)
  raise MiyakoProcError, "not given block!" unless block_given?
  @font.size_during(size){
    @max_height = @font.line_height if @max_height < @font.line_height
    yield
  }
  return self
end

#font_under_lineObject

ブロックを評価している間、下線付き文字に変更する

返却値

自分自身を返す

Raises:


414
415
416
417
418
# File 'lib/Miyako/API/textbox.rb', line 414

def font_under_line
  raise MiyakoProcError, "not given block!" unless block_given?
  @font.under_line{ yield }
  return self
end

#initialize_copy(obj) ⇒ Object

複写時に呼び出されるメソッド

複写と同時に、本インスタンスに対するスナップの関係を解消するが、 内部で使用するスプライトとはスナップをやり直す


122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/Miyako/API/textbox.rb', line 122

def initialize_copy(obj)
  copy_layout
  reset_snap

  @locate = @locate.dup
  @base = @base.dup
  @size = @size.dup
  @pos = @pos.dup

  @default_wait_cursor_position = @default_wait_cursor_position.dup
  @default_select_cursor_position = @default_select_cursor_position.dup

  @wait_cursor = @wait_cursor.dup
  @wait_cursor_position = @wait_cursor_position.dup
  @select_cursor = @select_cursor.dup
  @select_cursor_position = @select_cursor_position.dup

  @on_pause = @on_pause.dup

  @on_release = @on_release.dup

  @on_draw = @on_draw.dup

  @choices = @choices.dup
  @choices.snap(self)
  @choices.left!.top!

  @waiting = false
  @selecting = false

  @textarea = @textarea.dup
  @textarea.snap(self)
  @textarea.centering!

  if @wait_cursor
    @wait_cursor.snap(self)
    @default_wait_cursor_position.call(@wait_cursor, self)
  end
  @select_cursor.snap(self) if @select_cursor

  @move_list = @move_list.dup
end

#margin_during(margin) ⇒ Object

文字の描画位置にマージンを設定する

marginで指定したピクセルぶん、下に描画する ブロックを渡すと、ブロックを評価している間だけマージンが有効になる

margin

設定するマージン

返却値

自分自身を返す

Raises:


341
342
343
344
345
346
347
# File 'lib/Miyako/API/textbox.rb', line 341

def margin_during(margin)
  raise MiyakoError, "not given block!" unless block_given?
  omargin, @margin = @margin, margin
  yield
  @margin = omargin
  return self
end

#margin_height(align, height = @max_height) ⇒ Object

指定した高さで描画する際のマージンを求める

現在のフォントの設定で指定の文字列を描画したとき、予想される描画サイズを返す。実際に描画は行われない。 第1引数に渡す“align”は、以下の3種類のシンボルのどれかを渡す

:top

上側に描画(マージンはゼロ)

:middle

中間に描画

:bottom

下部に描画

align

描画位置

height

描画する高さ(デフォルトは、描画した最大の高さ)

返却値

マージンの値


359
360
361
# File 'lib/Miyako/API/textbox.rb', line 359

def margin_height(align, height = @max_height)
  return @font.margin_height(align, height)
end

#move_cursor(dx, dy) ⇒ Object

選択肢・選択カーソルを移動させる

但し、非選択状態だったときは、選択状態に戻るだけ (そのときの選択肢は、最後に選択した選択肢を指定する)

dx

移動量(x軸方向)。-1,0,1の3種類

dy

移動量(y軸方向)。-1,0,1の3種類

返却値

自分自身を返す


567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/Miyako/API/textbox.rb', line 567

def move_cursor(dx, dy)
  unless @choices.any_select?
    @choices.start_choice(nil) # 選択状態を元に戻す
    return self
  end
  @move_list[dy][dx].call
  if @select_cursor
    @select_cursor.snap(@choices.body)
    @select_cursor_position.call(@select_cursor, @choices.body)
  end
  return self
end

#on_draw=(event) ⇒ Object

文字描画時に行う処理を記述したブロックを登録する

処理を行うブロックはオブジェクトとして渡す。 ブロック引数の時は、そのブロックを処理している間のみ、そのオブジェクトを呼び出して処理させる

event

文字描画時処理するブロック

返却値

自分自身を返す


436
437
438
439
440
441
442
443
444
# File 'lib/Miyako/API/textbox.rb', line 436

def on_draw=(event)
  tdraw = @on_draw
  @on_draw = event
  if block_given?
    yield
    @on_draw = tdraw
  end
  return self
end

#on_pause=(event) ⇒ Object

ポーズ時に行う処理を記述したブロックを登録する

処理を行うブロックはオブジェクトとして渡す。 ブロック引数の時は、そのブロックを処理している間のみ、そのオブジェクトを呼び出して処理させる

event

ポーズ時処理するブロック

返却値

自分自身を返す


696
697
698
699
700
701
702
703
704
# File 'lib/Miyako/API/textbox.rb', line 696

def on_pause=(event)
  tpause = @on_pause
  @on_pause = event
  if block_given?
    yield
    @on_pause = tpause
  end
  return self
end

#on_release=(event) ⇒ Object

ポーズ解除時に行う処理を記述したブロックを登録する

処理を行うブロックはオブジェクトとして渡す。 ブロック引数の時は、そのブロックを処理している間のみ、そのオブジェクトを呼び出して処理させる

event

ポーズ解除時処理するブロック

返却値

自分自身を返す


720
721
722
723
724
725
726
727
728
# File 'lib/Miyako/API/textbox.rb', line 720

def on_release=(event)
  trelease = @on_release
  @on_release = event
  if block_given?
    yield
    @on_release = trelease
  end
  return self
end

#pauseObject

入力待ち状態(ポーズ)にする

ポーズカーソルを表示する。pause?メソッドの結果がtrueになる ポーズカーソルの位置は、set_wait_cursor_positionで設定したブロックが評価されて決定される (デフォルトはテキストエリアの中下

返却値

自分自身を返す


682
683
684
685
686
687
688
689
# File 'lib/Miyako/API/textbox.rb', line 682

def pause
  @waiting = true
  return self unless @wait_cursor
  @wait_cursor_position.call(@wait_cursor, self)
  @on_pause.call
  Fiber.yield if @fiber
  return self
end

#pause?Boolean

入力待ち状態かを確認する

返却値

入力待ち状態の時はtrueを返す


732
733
734
# File 'lib/Miyako/API/textbox.rb', line 732

def pause?
  return @waiting
end

#releaseObject

入力待ち状態を解除する

同時に、ポーズカーソルを隠蔽する。pause?メソッドの結果がfalseになる

返却値

自分自身を返す


709
710
711
712
713
# File 'lib/Miyako/API/textbox.rb', line 709

def release
  @waiting = false
  @on_release.call
  return self
end

#renderObject

画面に描画する

現在のテキストエリア・カーソルを、現在の状態で描画する visibleメソッドの値がfalseのときは描画されない。

返却値

自分自身を返す


310
311
312
313
314
315
316
317
318
319
# File 'lib/Miyako/API/textbox.rb', line 310

def render
  return unless @visible
  @textarea.render
  @wait_cursor.render if (@wait_cursor && @waiting)
  if @selecting
    @choices.render
    @select_cursor.render if @select_cursor
  end
  return self
end

#render_to(dst) ⇒ Object

画面に描画する

現在のテキストエリア・カーソルを、現在の状態で描画する visibleメソッドの値がfalseのときは描画されない。

返却値

自分自身を返す


325
326
327
328
329
330
331
332
333
334
# File 'lib/Miyako/API/textbox.rb', line 325

def render_to(dst)
  return unless @visible
  @textarea.render_to(dst)
  @wait_cursor.render(dst) if (@wait_cursor && @waiting)
  if @selecting
    @choices.render(dst)
    @select_cursor.render(dst) if @select_cursor
  end
  return self
end

#resetObject

テキストボックスのアニメーションを先頭に戻す

返却値

自分自身を返す


242
243
244
245
246
247
248
# File 'lib/Miyako/API/textbox.rb', line 242

def reset
  @textarea.reset
  @wait_cursor.reset if @wait_cursor
  @choices.reset
  @select_cursor.reset if @select_cursor
  return self
end

#reset_select_cursor_positionObject

入力待ち状態(ポーズ)に表示するカーソルの位置をデフォルトに戻す

デフォルトの位置は、テキストエリアの中下(center!.bottom!)に設定されている

返却値

自分自身を返す


671
672
673
674
675
# File 'lib/Miyako/API/textbox.rb', line 671

def reset_select_cursor_position
  @select_cursor_position = @default_select_cursor_position
  @select_cursor_position.call(@select_cursor, @choices.body) if (@select_cursor && @choices.body)
  return self
end

#reset_wait_cursor_positionObject

入力待ち状態(ポーズ)に表示するカーソルの位置をデフォルトに戻す

デフォルトの位置は、テキストエリアの中下(center!.bottom!)に設定されている

返却値

自分自身を返す


646
647
648
649
650
# File 'lib/Miyako/API/textbox.rb', line 646

def reset_wait_cursor_position
  @wait_cursor_position = @default_wait_cursor_position
  @wait_cursor_position.call(@wait_cursor, self) if @wait_cursor
  return self
end

#resultObject

選択結果を取得する

返却値

コマンドの選択結果(選択中のnilを返す)


744
745
746
# File 'lib/Miyako/API/textbox.rb', line 744

def result
  return @choices.result
end

#rowsObject

表示可能な文字行数を取得する

返却値

表示可能な行数


167
168
169
# File 'lib/Miyako/API/textbox.rb', line 167

def rows
  return @base.h
end

#selecting?Boolean

コマンド選択中かどうかを確認する

返却値

選択中の時はtrueを返す


738
739
740
# File 'lib/Miyako/API/textbox.rb', line 738

def selecting?
  return @selecting
end

#set_select_cursor_position(&proc) ⇒ Object

コマンド選択時に表示するカーソルの位置を設定する

カーソルの位置を、パラメータ二つ(カーソル本体・選択肢)を引数に取るブロックで実装する 位置は、テキストエリアをsnapしていると想定して実装する デフォルトは、選択肢の左側に置かれる(outside_left!.middle!) (例)選択肢の右側 -> {|wc, choice| wc.outside_right!.middle! }

  選択肢の真上 -> {|wc, choice| wc.centering! }

ブロックを渡していなかったり、ブロックの引数が2個でなければエラーを返す

返却値

自分自身を返す

Raises:


660
661
662
663
664
665
666
# File 'lib/Miyako/API/textbox.rb', line 660

def set_select_cursor_position(&proc)
  raise MiyakoProcError, "Can't find block!" unless proc
  raise MiyakoProcError, "This method must have two parameters!" unless proc.arity == 2
  @select_cursor_position = proc
  @select_cursor_position.call(@select_cursor, @choices.body) if (@select_cursor && @choices.body)
  return self
end

#set_wait_cursor_position(&proc) ⇒ Object

入力待ち状態(ポーズ)に表示するカーソルの位置を設定する

ポーズカーソルの位置を、パラメータ二つ(カーソル本体・テキストボックス)を引数に取るブロックで実装する 位置は、テキストエリアをsnapしていると想定して実装する デフォルトは、テキストエリアの中下に置かれる(center!.bottom!) (例)テキストボックスの中下(テキストエリアの外) -> {|wc, tbox| wc.center!.outside_bottom! }

  テキストボックスの右下(テキストエリアの中) -> {|wc, tbox| wc.right!.bottom! }
  テキストの最後尾 -> {|wc, tbox| wc.left!{|b| tbox.locate.x }.top!{|b| tbox.locate.y} }
   (テキストエリアの左上から右下へ現在の描画開始位置(tbox.locateメソッドで示した値)の距離移動した箇所)

ブロックを渡していなかったり、ブロックの引数が2個でなければエラーを返す

返却値

自分自身を返す

Raises:


635
636
637
638
639
640
641
# File 'lib/Miyako/API/textbox.rb', line 635

def set_wait_cursor_position(&proc)
  raise MiyakoProcError, "Can't find block!" unless proc
  raise MiyakoProcError, "This method must have two parameters!" unless proc.arity == 2
  @wait_cursor_position = proc
  @wait_cursor_position.call(@wait_cursor, self) if @wait_cursor
  return self
end

#space(length) ⇒ Object

横方向のスペースを空ける

現在描画可能な位置から、指定したピクセルで右方向に移動する

length

スペースを空けるピクセル数

返却値

自分自身を返す


776
777
778
779
780
# File 'lib/Miyako/API/textbox.rb', line 776

def space(length)
  @locate.x += length
  Fiber.yield if @fiber
  return self
end

#startObject

テキストボックスのアニメーションを開始する

返却値

自分自身を返す


222
223
224
225
226
227
228
# File 'lib/Miyako/API/textbox.rb', line 222

def start
  @textarea.start
  @wait_cursor.start if @wait_cursor
  @choices.start
  @select_cursor.start if @select_cursor
  return self
end

#start_commandObject

コマンド選択を開始する

但し、commandメソッドを呼び出したときは自動的に呼ばれる

返却値

自分自身を返す

Raises:


538
539
540
541
542
543
544
545
546
547
548
# File 'lib/Miyako/API/textbox.rb', line 538

def start_command
  raise MiyakoValueError, "don't set Choice!" if @choices.length == 0
  @choices.start
  @choices.start_choice
  if @select_cursor
    @select_cursor.snap(@choices.body)
    @select_cursor_position.call(@select_cursor, @choices.body)
  end
  @selecting = true
  return self
end

#stopObject

テキストボックスのアニメーションを停止する

返却値

自分自身を返す


232
233
234
235
236
237
238
# File 'lib/Miyako/API/textbox.rb', line 232

def stop
  @textarea.stop
  @wait_cursor.stop if @wait_cursor
  @choices.stop
  @select_cursor.stop if @select_cursor
  return self
end

#text_sizeObject

一列に表示可能な文字数と行数を取得する

文字数はcolumns、行数はrowsの値と同一 Size構造体のインスタンスとして取得

返却値

表示可能な文字数と行数


182
183
184
# File 'lib/Miyako/API/textbox.rb', line 182

def text_size
  return Size.new(@base.w, @base.h)
end

#to_sprite {|sprite| ... } ⇒ Object

スプライトに変換した画像を表示する

すべてのパーツを貼り付けた、1枚のスプライトを返す 引数1個のブロックを渡せば、スプライトに補正をかけることが出来る

返却値

描画したスプライト

Yields:

  • (sprite)

268
269
270
271
272
273
274
275
276
# File 'lib/Miyako/API/textbox.rb', line 268

def to_sprite
  rect = self.broad_rect
  sprite = Sprite.new(:size=>rect.to_a[2,2], :type=>:ac)
  Drawing.fill(sprite, [0,0,0])
  Bitmap.ck_to_ac!(sprite, [0,0,0])
  self.render_to(sprite){|sunit, dunit| sunit.x -= rect.x; sunit.y -= rect.y }
  yield sprite if block_given?
  return sprite
end

#to_unitObject

SpriteUnit構造体を生成する

いったんSpriteインスタンスを作成し、それをもとにSpriteUnit構造体を生成する。

返却値

生成したSpriteUnit構造体


281
282
283
# File 'lib/Miyako/API/textbox.rb', line 281

def to_unit
  return self.to_sprite.to_unit
end

#updateObject

並行ブロック処理を更新する

内部でFiberが評価中ならば、Fiberに処理を移す

返却値

自分自身を返す


211
212
213
214
215
216
217
218
# File 'lib/Miyako/API/textbox.rb', line 211

def update
  begin
    @fiber.resume if @fiber
  rescue FiberError
    @fiber = nil
  end
  return self
end

#update_animationObject

テキストボックスの表示を更新する

テキストボックス・選択カーソル・選択肢・ウェイトカーソルのアニメーションを更新する

返却値

どれか一つ変更があったときはtrueを返す。それ以外はfalseを返す


253
254
255
256
257
258
259
260
261
262
# File 'lib/Miyako/API/textbox.rb', line 253

def update_animation
  f = false
  f |= @textarea.update_animation
  f |= @wait_cursor.update_animation if (@wait_cursor && @waiting)
  if @selecting
    f |= @choices.update_animation.any?
    f |= @select_cursor.update_animation if @select_cursor
  end
  return f
end

#update_layout_positionObject

:nodoc:


621
622
623
# File 'lib/Miyako/API/textbox.rb', line 621

def update_layout_position #:nodoc:
  @pos.move_to!(*@layout.pos)
end