UI_ProgressBar ¶

   <task pointer> = UI_ProgressBar( <parent pointer>, <order>, <x>, <y>, <width>, <height>,
                              <full image>, <empty image> [, <start pix>, <end pix>, <anim time>, <vertical flag>, <barfilter image>])

引数 ¶

• <parent pointer> 親UIのポインタ
• <order> 表示プライオリティ
• <x>, <y> 表示座標
• <width>, <height> プログレスバー全体の表示域サイズ
• <full image> 100%状態で使用する画像asset
• <empty image> 0%状態で使用する画像asset
• <start pix> ゲージ開始点となるpixel位置。縦方向か横方向かはバーの成長方向による。
• <end pix> ゲージ終了店となるpixel位置。縦方向か横方向かはバーの成長方向による。
• <anim time> バーの変化にかけるアニメーション時間(単位:[ms])
• <vertical flag> 縦方向プログレスバーフラグ
• <barfilter image> バーの長さに合わせて伸縮するフィルタ画像asset

戻り値 ¶

• <task pointer> 生成された UI_ProgressBar タスクのポインタ

解説 ¶

指定された二つの画像を適切な位置で分割し繋ぎ合わせることでプログレスバーの表示をおこなう。 このタスクを使用する上では下記の制約がある。

• 使用される画像assetは、必ず同一の .texb に含まれている必要がある(<barfilter image>含む)。
• 使用される画像assetは、必ず4頂点かつ、頂点indexが左上から時計回りに割り当てられている必要がある。

上記の制約に当てはまらない画像assetを<full image>もしくは<empty image>に指定した場合の動作は保証されない。

コマンド ¶

UI_PROGRESS_RESET

プログレスバーの進捗を0にリセットする

• UI_PROGRESS_RESET

     pProgressBar = UI_ProgressBar(...)
     sysCommand(pProgressBar, UI_PROGRESS_RESET)
  

UI_PROGRESS_SET

プログレスバーの進捗を設定する。進捗は 0.0から 1.0の間(実数)で与える。

• UI_PROGRESS_SET

     pProgressBar= UI_ProgressBar(...)
     sysCommand(pProgressBar, UI_PROGRESS_SET, <progress>)
  

UI_PROGRESS_MAX

プログレスバーの進捗を最大(1.0)にする

• UI_PROGRESS_MAX

     pProgressBar= UI_ProgressBar(...)
     sysCommand(pProgressBar, UI_PROGRESS_MAX)
  

UI_PROGRESS_GET

現在プログレスバーに与えられている進捗値を取得する。

• UI_PROGRESS_GET

     pProgressBar= UI_ProgressBar(...)
     <progress> = sysCommand(pProgressBar, UI_PROGRESS_GET)
  

UI_PROGRESS_FILTER_VISIBLE

<barfilter image>が指定されている場合に、バーフィルタの visible をコントロールする

• UI_PROGRESS_FILTER_VISIBLE

     pProgressBar = UI_ProgerssBar(...)
     sysCommand(pProgressBar, UI_PROGRESS_FILTER_VISIBLE, <visible>)
  
     <visible> true / false
  

UI_PROGRESS_FILTER_COLOR

<barfilter image>が指定されている場合に、バーフィルタに対して与える頂点 RGBA 値を指定する

• UI_PROGRESS_FILTER_COLOR

     pProgressBar = UI_ProgressBar(...)
     sysCommand(pProgressBar, UI_PROGRESS_FILTER_COLOR, <alpha>, <rgb>)
  

UI_PROGRESS_FILTER_ANIM

<barfilter image>が指定されている場合に、バーフィルタに対して与えるカラーアニメーションを指定する。 アニメーションは与えられた二つのRGBA値の間をサインカーブ的に補間し、指定された周期で往復するものになる。

• UI_PROGRESS_FILTER_ANIM

     pProgressBar = UI_ProgressBar(...)
     sysCommand(pProgressBar, UI_PROGRESS_FILTER_ANIM, <anim-enable>, <alpha-1>, <rgb-1>, <alpha-2>, <rgb-2>, <period>)
  
     <anim-enable>  true:カラーアニメを有効にする / false:カラーアニメを無効にする。falseの場合は以降のパラメータは省略可能で、あっても無視される。
     <alpha-1>   カラー1のalpha値
     <rgb-1>     カラー1のRGB値
     <alpha-2>   カラー2のalpha値
     <rgb-2>     カラー2のRGB値
     <period>    往復にかかる周期(単位:[ms])