AnimatedImage

アニメーテッドイメージ (AnimatedImage) 要素を使えば、ページめくりスタイルのアニメーションを自動化することができます。

Summary
AnimatedImageアニメーテッドイメージ (AnimatedImage) 要素を使えば、ページめくりスタイルのアニメーションを自動化することができます。
実装の詳細アニメーテッドイメージはページめくりスタイルのアニメーションを生成するために、与えられたテクスチャのテクスチャ座標の変更を自動化します。
XML定義
XMLタグ
任意属性
texture表示するテクスチャの名前。
textureScaleテクスチャの縮尺。
filteringレンダリング時にこのテクスチャに使用するブレンドモードを指定できます。
fpsアニメーション動作時の毎秒のフレーム数を指定できます。
mirrorTexCoordsテクスチャを縦方向に反転させることができます。
要素
AnimFramesアニメーション動作時の各フレームの座標を指定します。
TexDims各フレームに使用するテクスチャのサイズを明確に指定します。
関数
関数
AnimatedImageSetTexture()この画像に表示するテクスチャを設定します。
AnimatedImageStartAnimation()パラメータに従ってこのアニメーションを再生します。
AnimatedImageStopAnimation()動作中のアニメーションを停止します。
AnimatedImageSetPlaySpeed()アニメーション再生の速度（fps）を設定します。

実装の詳細

アニメーテッドイメージはページめくりスタイルのアニメーションを生成するために、与えられたテクスチャのテクスチャ座標の変更を自動化します。

以下は本のページめくりアニメーションのフレームセットの一例です。

XML定義

Summary
XMLタグ
任意属性
texture表示するテクスチャの名前。
textureScaleテクスチャの縮尺。
filteringレンダリング時にこのテクスチャに使用するブレンドモードを指定できます。
fpsアニメーション動作時の毎秒のフレーム数を指定できます。
mirrorTexCoordsテクスチャを縦方向に反転させることができます。
要素
AnimFramesアニメーション動作時の各フレームの座標を指定します。
TexDims各フレームに使用するテクスチャのサイズを明確に指定します。

XMLタグ

<AnimatedImage>
....
</AnimatedImage>

代替グループ

任意属性

texture

表示するテクスチャの名前。

アニメーションの全てのフレームは、一つのテクスチャに属していなければなりません。

データ型

string有効なUI Texture の名前。

デフォルト値

  • ””

textureScale

テクスチャの縮尺。

この値は、テクスチャの元画像のサイズに乗算されます。

データ型

float_t(1.0 = 100%)

デフォルト値

  • 1

メモ

  • TexDims 要素でテクスチャのサイズを明確に指定した場合、 textureScale のパラメータは無視されます。

filtering

レンダリング時にこのテクスチャに使用するブレンドモードを指定できます。

データ型

boolean

trueバイリニアフィルタを使う。
falseニアレストネイバーフィルタを使う。

デフォルト値

  • false

fps

アニメーション動作時の毎秒のフレーム数を指定できます。

データ型

float_t(1.0 = 1フレーム/秒)

デフォルト値

  • 1

mirrorTexCoords

テクスチャを縦方向に反転させることができます。

データ型

boolean

trueテクスチャを反転させる。
falseテクスチャを反転させない。

デフォルト値

  • false

要素

AnimFrames

アニメーション動作時の各フレームの座標を指定します。

構文

<AnimFrames>
      <AnimFrame id="1" x="0" y="0" />
      <AnimFrame id="2" x="342" y="0" />
      ...
      <AnimFrame id="6" x="684" y="328" />
</AnimFrames>
id定義されたフレームのID番号。
xフレーム画像の左上のXピクセル座標。
yフレーム画像の左上のYピクセル座標。

デフォルト値

x0
y0

TexDims

各フレームに使用するテクスチャのサイズを明確に指定します。

この要素が含まれている場合、 textureScale による縮尺の影響を受けません。

構文

<TexDims x="100" y="100" />
xXピクセルのテクスチャサイズ。
yYピクセルのテクスチャサイズ。

デフォルト値

x0
y0

関数

Summary
関数
AnimatedImageSetTexture()この画像に表示するテクスチャを設定します。
AnimatedImageStartAnimation()パラメータに従ってこのアニメーションを再生します。
AnimatedImageStopAnimation()動作中のアニメーションを停止します。
AnimatedImageSetPlaySpeed()アニメーション再生の速度（fps）を設定します。

関数

AnimatedImageSetTexture()

この画像に表示するテクスチャを設定します。

パラメータ

animatedImageName(string) アニメーテッドイメージの名前。
texture(string) 表示するUI Texture の名前。

戻り値

nil戻り値無し。

関連するXML

例

AnimatedImageSetTexture("SomeAnimatedImage", "some_anim_texture" )

AnimatedImageStartAnimation()

パラメータに従ってこのアニメーションを再生します。

パラメータ

animatedImageName(string) アニメーテッドイメージの名前。
startFrame(integer) 開始フレームのID番号。
loop(boolean) ループするか否か？
hideWhenDone(boolean) 終了時に自動的にアニメーションを隠すか否か？
delay(integer) アニメーション開始前のディレイの長さ。

戻り値

nil戻り値無し。

メモ

  • 一連のアニメーションにディレイパラメータを設定することで、適切な時間に手動でLuaの各アニメーションを始めなくても一斉に動作するようにできます。

例

AnimatedImageStartAnimation( animWindow, 0, false, true, 0 )

AnimatedImageStopAnimation()

動作中のアニメーションを停止します。

パラメータ

animatedImageName(string) アニメーテッドイメージの名前。

戻り値

nil戻り値無し。

例

AnimatedImageStopAnimation( animWindow )

AnimatedImageSetPlaySpeed()

アニメーション再生の速度（fps）を設定します。

パラメータ

animatedImageName(string) アニメーテッドイメージの名前。
fpsSpeed(string) フレームの毎秒の再生速度。

戻り値

nil戻り値無し。

例

AnimatedImageSetPlaySpeed( "SomeAnimWindow", 12 )
ウィンドウ (Window) 要素はウィンドウを作成する際に使用する基本的な要素です。他のウィンドウ要素もこの要素の内容を継承しており、全ての属性、要素、データメンバー、関数をサポートしています。
単体のアートテクスチャコンポーネントを定義します。
各フレームに使用するテクスチャのサイズを明確に指定します。
テクスチャの縮尺。
表示するテクスチャの名前。
Close