Win32 API 日本語リファレンス
ホームUI.Animation › IUIAnimationTransitionLibrary

IUIAnimationTransitionLibrary

COM
IIDca5a14b1-d24f-48b8-8fe4-c78169ba954e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

標準の遷移(トランジション)のライブラリを定義します。

解説(Remarks)

Windows Animation には、開発者がストーリーボードを通じて変数に適用できる一般的な遷移のライブラリが用意されています。遷移を指定するためのパラメーターは、遷移の種類によって異なります。一部の遷移では遷移の継続時間が明示的なパラメーターとなりますが、それ以外の遷移では、遷移開始時の速度や加速度などの他のパラメーターによって継続時間が決まります。不連続なジャンプが必要な場合は、遷移の初期値や初期速度を上書きできます。また、遷移をストーリーボードに追加した後で継続時間を照会できます。

遷移ライブラリでは指定できない効果がアプリケーションで必要な場合、開発者はカスタム遷移を実装できます。カスタム遷移を作成するには、まず遷移用の補間器関数を実装し、次にファクトリオブジェクトを使用して補間器から遷移を生成します。補間器は IUIAnimationInterpolator インターフェイスを実装する必要があります。遷移ファクトリオブジェクトの実装は UIAnimationTransitionFactory によって提供されます。

遷移ライブラリオブジェクトを作成する例については、Create the Main Animation Objects を参照してください。

メソッド 12

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT CreateInstantaneousTransition(DOUBLE finalValue, IUIAnimationTransition** transition)

瞬間的な遷移を作成します。

finalValueDOUBLEin遷移の終了時におけるアニメーション変数の値。
transitionIUIAnimationTransition**out新しい瞬間的な遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

瞬間的な遷移では、 アニメーション変数の値が現在の値から指定された最終値へ瞬時に変化します。この遷移の継続時間は常にゼロです。

次の図は、瞬間的な遷移における時間経過に伴うアニメーション変数への効果を示しています。

Diagram showing an instantaneous transition
vtbl 4 HRESULT CreateConstantTransition(DOUBLE duration, IUIAnimationTransition** transition)

一定値の遷移を作成します。

durationDOUBLEin遷移の継続時間。
transitionIUIAnimationTransition**out新しい一定値の遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

一定値の遷移では、遷移の継続時間の間、アニメーション変数の値は初期値のまま保たれます。

次の図は、一定継続時間の遷移における時間経過に伴うアニメーション変数への効果を示しています。

Diagram showing a constant-duration transition
vtbl 5 HRESULT CreateDiscreteTransition(DOUBLE delay, DOUBLE finalValue, DOUBLE hold, IUIAnimationTransition** transition)

離散的な遷移を作成します。

delayDOUBLEin最終値への瞬間的な切り替えを遅延させる時間。
finalValueDOUBLEin遷移の終了時におけるアニメーション変数の値。
holdDOUBLEin変数を最終値に保持する時間。
transitionIUIAnimationTransition**out新しい離散的な遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

離散的な遷移では、アニメーション変数は指定された遅延時間の間は初期値のまま保たれ、その後、指定された最終値へ瞬時に切り替わり、指定された保持時間の間その値を維持します。

次の図は、離散的な遷移における時間経過に伴うアニメーション変数への効果を示しています。

Diagram showing a discrete transition
vtbl 6 HRESULT CreateLinearTransition(DOUBLE duration, DOUBLE finalValue, IUIAnimationTransition** transition)

線形の遷移を作成します。

durationDOUBLEin遷移の継続時間。
finalValueDOUBLEin遷移の終了時におけるアニメーション変数の値。
transitionIUIAnimationTransition**out新しい線形の遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

線形の遷移では、アニメーション変数の値が初期値から指定された最終値まで線形に変化します。

次の図は、線形の遷移における時間経過に伴うアニメーション変数への効果を示しています。

Diagram showing a linear transition
vtbl 7 HRESULT CreateLinearTransitionFromSpeed(DOUBLE speed, DOUBLE finalValue, IUIAnimationTransition** transition)

線形速度の遷移を作成します。

speedDOUBLEin速度の絶対値。
finalValueDOUBLEin遷移の終了時におけるアニメーション変数の値。
transitionIUIAnimationTransition**out新しい線形速度の遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

線形速度の遷移では、アニメーション変数の値が指定された割合で変化します。遷移の継続時間は、初期値と指定された最終値との差によって決まります。

次の図は、線形速度の遷移における時間経過に伴うアニメーション変数への効果を示しています。

Diagram showing the linear transition from speed
vtbl 8 HRESULT CreateSinusoidalTransitionFromVelocity(DOUBLE duration, DOUBLE period, IUIAnimationTransition** transition)

初期速度によって振幅が決まる、正弦波速度の遷移を作成します。

durationDOUBLEin遷移の継続時間。
periodDOUBLEin正弦波の振動周期(秒単位)。
transitionIUIAnimationTransition**out新しい正弦波速度の遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

正弦波範囲の遷移では、遷移の継続時間全体を通じて、アニメーション変数の値が初期値の周りで振動します。振動の振幅は、遷移開始時の速度によって決まります。

次の図は、正弦波速度の遷移における時間経過に伴うアニメーション変数への効果を示しています。

Diagram showing a sinusoidal-velocity transition
vtbl 9 HRESULT CreateSinusoidalTransitionFromRange(DOUBLE duration, DOUBLE minimumValue, DOUBLE maximumValue, DOUBLE period, UI_ANIMATION_SLOPE slope, IUIAnimationTransition** transition)

指定された振動範囲を持つ、正弦波範囲の遷移を作成します。

durationDOUBLEin遷移の継続時間。
minimumValueDOUBLEin正弦波の谷におけるアニメーション変数の値。
maximumValueDOUBLEin正弦波の山におけるアニメーション変数の値。
periodDOUBLEin正弦波の振動周期(秒単位)。
slopeUI_ANIMATION_SLOPEin遷移開始時の傾き。
transitionIUIAnimationTransition**out新しい正弦波範囲の遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

正弦波範囲の遷移では、遷移の継続時間全体を通じて、アニメーション変数の値が指定された最小値と最大値の間で変動します。slope パラメーターは、その他のパラメーターによって定まる 2 つの正弦波のどちらであるかを区別するために使用されます。

次の図は、正弦波範囲の遷移における時間経過に伴うアニメーション変数への効果を示しています。UI_ANIMATION_SLOPE_INCREASING 列挙値を渡すと図中の実線のような波形になり、UI_ANIMATION_SLOPE_DECREASING 値を渡すと破線のような波形になります。

Diagram showing a sinusoidal-range transition
vtbl 10 HRESULT CreateAccelerateDecelerateTransition(DOUBLE duration, DOUBLE finalValue, DOUBLE accelerationRatio, DOUBLE decelerationRatio, IUIAnimationTransition** transition)

加速減速の遷移を作成します。

durationDOUBLEin遷移の継続時間。
finalValueDOUBLEin遷移の終了時におけるアニメーション変数の値。
accelerationRatioDOUBLEin継続時間に対する加速に費やす時間の比率。
decelerationRatioDOUBLEin継続時間に対する減速に費やす時間の比率。
transitionIUIAnimationTransition**out新しい加速減速の遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

加速減速の遷移では、アニメーション変数は 遷移の継続時間の間に加速し、その後減速して、指定された値で終了します。加速の比率と減速の比率を別々に指定することで、変数が加速および減速する速さをそれぞれ制御できます。

初期速度がゼロの場合、加速比率は変数が加速に費やす継続時間の割合となります。減速比率も同様です。初期速度がゼロでない場合は、速度がゼロに達してから遷移が終了するまでの時間に対する割合となります。加速比率と減速比率の合計は最大でも 1.0 とする必要があります。

次の図は、加速減速の遷移における、初期速度が異なるアニメーション変数への効果を示しています。

Diagram showing accelerate-decelerate transitions
注意 上の右側の図の d' は、速度がゼロに達してから遷移が終了するまでの時間を示しています。

例については、Create a Storyboard and Add Transitions を参照してください。

vtbl 11 HRESULT CreateReversalTransition(DOUBLE duration, IUIAnimationTransition** transition)

反転の遷移を作成します。

durationDOUBLEin遷移の継続時間。
transitionIUIAnimationTransition**out新しい反転の遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

反転の遷移では、指定された継続時間の間に滑らかに方向が変わります。最終値は初期値と同じになり、最終速度は初期速度の符号を反転した値になります。次の図はそのような反転の遷移を示しています。

Diagram showing a reversal transition
vtbl 12 HRESULT CreateCubicTransition(DOUBLE duration, DOUBLE finalValue, DOUBLE finalVelocity, IUIAnimationTransition** transition)

3 次(キュービック)の遷移を作成します。

durationDOUBLEin遷移の継続時間。
finalValueDOUBLEin遷移の終了時におけるアニメーション変数の値。
finalVelocityDOUBLEin遷移の終了時における変数の速度。
transitionIUIAnimationTransition**out新しい 3 次の遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

3 次の遷移では、遷移の継続時間の間にアニメーション変数の値が初期値から指定された最終値へ変化し、指定された速度で終了します。

次の図は、3 次の遷移における時間経過に伴うアニメーション変数への効果を示しています。

Diagram showing a cubic transition
vtbl 13 HRESULT CreateSmoothStopTransition(DOUBLE maximumDuration, DOUBLE finalValue, IUIAnimationTransition** transition)

スムーズストップの遷移を作成します。

maximumDurationDOUBLEin遷移の最大継続時間。
finalValueDOUBLEin遷移の終了時におけるアニメーション変数の値。
transitionIUIAnimationTransition**out新しいスムーズストップの遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

スムーズストップの遷移では、指定された最終値に近づくにつれて減速し、速度ゼロで最終値に到達します。遷移の継続時間は、初期速度、初期値と最終値の差、および指定された最大継続時間によって決まります。単一の放物線の弧で構成される解が存在しない場合、このメソッドは 3 次の遷移を作成します。

次の図は、スムーズストップの遷移における時間経過に伴うアニメーション変数への効果を示しています。

Diagram showing a smooth stop transition
vtbl 14 HRESULT CreateParabolicTransitionFromAcceleration(DOUBLE finalValue, DOUBLE finalVelocity, DOUBLE acceleration, IUIAnimationTransition** transition)

放物線加速の遷移を作成します。

finalValueDOUBLEin遷移の終了時におけるアニメーション変数の値。
finalVelocityDOUBLEin遷移の終了時における速度。
accelerationDOUBLEin遷移中の加速度。
transitionIUIAnimationTransition**out新しい放物線加速の遷移。

戻り値

メソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

放物線加速の遷移では、アニメーション変数の値が初期値から最終値へ変化し、指定された速度で終了します。加速度を指定することで、変数が最終値に到達する速さを制御できます。

次の図は、放物線加速の遷移における時間経過に伴うアニメーション変数への効果を示しています。

Diagram showing a parabolic-acceleration transition
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

#define global IID_IUIAnimationTransitionLibrary "{CA5A14B1-D24F-48B8-8FE4-C78169BA954E}"
#usecom global IUIAnimationTransitionLibrary IID_IUIAnimationTransitionLibrary "{1D6322AD-AA85-4EF5-A828-86D71067D145}"
#comfunc global IUIAnimationTransitionLibrary_CreateInstantaneousTransition              3 double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateConstantTransition                   4 double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateDiscreteTransition                   5 double,double,double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateLinearTransition                     6 double,double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateLinearTransitionFromSpeed            7 double,double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateSinusoidalTransitionFromVelocity     8 double,double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateSinusoidalTransitionFromRange        9 double,double,double,double,int,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateAccelerateDecelerateTransition       10 double,double,double,double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateReversalTransition                   11 double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateCubicTransition                      12 double,double,double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateSmoothStopTransition                 13 double,double,sptr
#comfunc global IUIAnimationTransitionLibrary_CreateParabolicTransitionFromAcceleration  14 double,double,double,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。