IUIAnimationInterpolator

カスタム補間器を作成するためのメソッドを定義します。

クライアントアプリケーションは、IUIAnimationTransitionLibrary やサードパーティ製ライブラリが提供する遷移(トランジション)を使用できます。ただし、独自の動作が必要な場合は、IUIAnimationInterpolator インターフェイスを実装して独自の遷移を作成できます。

Windows Animation がカスタム補間器を使用できるようにするには、IUIAnimationTransitionFactory::CreateTransition メソッドを呼び出してカスタム補間器を渡し、IUIAnimationTransition を実装するオブジェクトでラップする必要があります。ラップされた後は、クライアントアプリケーションは IUIAnimationTransition インターフェイスを介して補間器とやり取りします。

カスタム補間器は複数のアプリケーション間で再利用できますが、IUIAnimationTransition インターフェイスを返すファクトリインターフェイスを通じて公開することを推奨します。

例

例については、Custom Interpolator Sample を参照してください。

遷移の開始時における初期値と初速度を設定します。

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

エラーコードの一覧については、Windows Animation Error Codes を参照してください。

Windows Animation は、さまざまなオフセットで IUIAnimationInterpolator の他のメソッドを呼び出す前に、必ず SetInitialValueAndVelocity を呼び出します。ただし、異なるパラメーターで複数回呼び出されることがあります。補間器はパフォーマンス向上のために内部状態をキャッシュできますが、SetInitialValueAndVelocity が呼び出されるたびにキャッシュした状態を更新し、その後のメソッド呼び出しの結果が更新後の状態を反映するようにしなければなりません。

遷移の継続時間を設定します。

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

Windows Animation がこのメソッドを呼び出すのは、GetDependencies メソッドを呼び出した後で、かつその呼び出しが durationDependencies フラグの1つとして UI_ANIMATION_DEPENDENCY_DURATION を返した場合のみです。

通常、継続時間への依存を持つ補間器は、IUIAnimationTransitionFactory の対応する作成メソッドに duration パラメーターを持ちます。補間器は最初の初期化時に継続時間を保存し、SetDuration が呼び出されたときにそれを上書きする必要があります。

Windows Animation は SetDuration を呼び出す前に必ず SetInitialValueAndVelocity メソッドを呼び出して初期値と初速度を設定するため、カスタム補間器は初期値と初速度が設定済みかどうかを確認する必要はありません。

Windows Animation は、SetInitialValueAndVelocity と SetDuration を異なるパラメーターで複数回呼び出すことがあります。補間器はパフォーマンス向上のために内部状態をキャッシュできますが、SetInitialValueAndVelocity が呼び出されるたびにキャッシュした状態を更新し、その後の SetDuration 呼び出しの結果が更新後の状態を反映するようにしなければなりません。

遷移の継続時間を取得します。

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

Windows Animation は GetDuration を呼び出す前に必ず SetInitialValueAndVelocity メソッドを呼び出して初期値と初速度を設定するため、カスタム補間器は初期値と初速度が設定済みかどうかを確認する必要はありません。

Windows Animation は SetInitialValueAndVelocity を異なるパラメーターで複数回呼び出すことがあります。補間器はパフォーマンス向上のために内部状態をキャッシュできますが、SetInitialValueAndVelocity が呼び出されるたびにキャッシュした状態を更新し、その後の GetDuration 呼び出しの結果が更新後の状態を反映するようにしなければなりません。

遷移の終了時における最終値を取得します。

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

Windows Animation は GetFinalValue を呼び出す前に必ず SetInitialValueAndVelocity メソッドを呼び出して初期値と初速度を設定するため、カスタム補間器は初期値と初速度が設定済みかどうかを確認する必要はありません。

Windows Animation は SetInitialValueAndVelocity を異なるパラメーターで複数回呼び出すことがあります。補間器はパフォーマンス向上のために内部状態をキャッシュできますが、SetInitialValueAndVelocity が呼び出されるたびにキャッシュした状態を更新し、その後の GetFinalValue 呼び出しの結果が更新後の状態を反映するようにしなければなりません。

指定したオフセットにおけるアニメーション変数の値を補間します。

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

Windows Animation は InterpolateValue を呼び出す前に必ず SetInitialValueAndVelocity メソッドを呼び出して初期値と初速度を設定するため、カスタム補間器は初期値と初速度が設定済みかどうかを確認する必要はありません。

Windows Animation は SetInitialValueAndVelocity を異なるパラメーターで複数回呼び出すことがあります。補間器はパフォーマンス向上のために内部状態をキャッシュできますが、SetInitialValueAndVelocity が呼び出されるたびにキャッシュした状態を更新し、その後の InterpolateValue 呼び出しの結果が更新後の状態を反映するようにしなければなりません。

指定したオフセットにおける速度(変化率)を補間します。

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

Windows Animation は InterpolateVelocity を呼び出す前に必ず SetInitialValueAndVelocity メソッドを呼び出して初期値と初速度を設定するため、カスタム補間器は初期値と初速度が設定済みかどうかを確認する必要はありません。

Windows Animation は SetInitialValueAndVelocity を異なるパラメーターで複数回呼び出すことがあります。補間器はパフォーマンス向上のために内部状態をキャッシュできますが、SetInitialValueAndVelocity が呼び出されるたびにキャッシュした状態を更新し、その後の InterpolateVelocity 呼び出しの結果が更新後の状態を反映するようにしなければなりません。

SetInitialValueAndVelocity に渡される初期値や初速度、または SetDuration に渡される継続時間に依存する、補間器の各側面を取得します。

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

このメソッドは、カスタム補間器のどの側面が値・速度・継続時間という入力の影響を受けるかを特定するために呼び出されます。これらの各入力について、補間器は次のいずれかを返します。

• 該当する UI_ANIMATION_DEPENDENCIES のメンバーのビットごとの OR。
• その入力に依存するものが何もない場合は UI_ANIMATION_DEPENDENCY_NONE。

例として、(1) 最終値をパラメーターとして受け取り、(2) 常にその最終値で緩やかに停止し、(3) 継続時間が最終値と初期値の差によって決まる補間器を考えます。この補間器は initialValueDependencies に対して UI_ANIMATION_DEPENDENCY_INTERMEDIATE_VALUES|UI_ANIMATION_DURATION を返すべきです。最終値は補間器の作成時に設定され、初期値の影響を受けないため、UI_ANIMATION_DEPENDENCY_FINAL_VALUE を返すべきではありません。同様に、曲線の傾きは最終値に達したとき常に0になるよう定義されているため、UI_ANIMATION_DEPENDENCY_FINAL_VELOCITY も返すべきではありません。

補間器が正しいフラグのセットを返すことは重要です。ある出力にフラグが含まれていない場合、Windows Animation は対応するパラメーターがその補間器の結果の当該側面に影響しないと想定します。たとえば、カスタム補間器が initialVelocityDependencies に UI_ANIMATION_DEPENDENCY_FINAL_VALUE を含めない場合、Windows Animation は任意の velocity パラメーターで SetInitialValueAndVelocity を呼び出した後、GetFinalValue を呼び出して最終値を判定することがあります。この場合、補間器は遷移の最終値が初速度に依存しないと宣言しているため、GetFinalValue の実装は SetInitialValueAndVelocity にどのような velocity パラメーターが渡されても同じ結果を返さなければなりません。

#define global IID_IUIAnimationInterpolator "{7815CBBA-DDF7-478C-A46C-7B6C738B7978}"
#usecom global IUIAnimationInterpolator IID_IUIAnimationInterpolator "{}"
#comfunc global IUIAnimationInterpolator_SetInitialValueAndVelocity  3 double,double
#comfunc global IUIAnimationInterpolator_SetDuration                 4 double
#comfunc global IUIAnimationInterpolator_GetDuration                 5 var
#comfunc global IUIAnimationInterpolator_GetFinalValue               6 var
#comfunc global IUIAnimationInterpolator_InterpolateValue            7 double,var
#comfunc global IUIAnimationInterpolator_InterpolateVelocity         8 double,var
#comfunc global IUIAnimationInterpolator_GetDependencies             9 var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。