IUIAnimationInterpolator2

カスタム補間器を作成するためのメソッドを定義する IUIAnimationInterpolator インターフェイスを拡張します。IUIAnimationInterpolator2 は、指定された次元での補間をサポートします。

クライアントアプリケーションは、IUIAnimationTransitionLibrary または IUIAnimationTransitionLibrary2 インターフェイスが提供する遷移(トランジション)や、サードパーティ提供のライブラリの遷移を使用できます。ただし、IUIAnimationInterpolator または IUIAnimationInterpolator2 インターフェイスを実装することで、カスタム遷移を作成することもできます。

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

カスタム補間器はアプリケーション間で再利用できますが、IUIAnimationTransition インターフェイスまたは IUIAnimationTransition2 インターフェイスを返すファクトリインターフェイスを使用して公開することをお勧めします。

補間が必要な次元の数を取得します。

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

指定された次元における遷移の初期値と初速度を設定します。

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

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

指定された次元における遷移の継続時間を設定します。

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

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

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

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

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

指定された次元における遷移の継続時間を取得します。

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

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

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

指定された次元における遷移終了時の最終値を取得します。

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

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

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

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

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

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

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

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

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

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

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

指定されたアニメーションカーブのプリミティブ補間を生成します。

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

指定された次元について、GetDependencies は、IUIAnimationInterpolator2::SetInitialValueAndVelocity メソッドに渡される初期値や初速度、または IUIAnimationInterpolator2::SetDuration メソッドに渡される継続時間に依存する補間器の側面を取得します。

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

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

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

例として、次のような補間器を考えます。

• 最終値をパラメーターとして受け取る。
• 常にその最終値で緩やかに停止する。
• 継続時間が最終値と初期値の差によって決まる。

この場合、補間器は 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 は任意の速度パラメーターで SetInitialValueAndVelocity を呼び出した後、GetFinalValue を呼び出して最終値を判定する場合があります。この補間器は遷移の最終値が初速度に依存しないと宣言しているため、その GetFinalValue の実装は、SetInitialValueAndVelocity にどの速度パラメーターが渡されたかに関係なく、同じ結果を返さなければなりません。

#define global IID_IUIAnimationInterpolator2 "{EA76AFF8-EA22-4A23-A0EF-A6A966703518}"
#usecom global IUIAnimationInterpolator2 IID_IUIAnimationInterpolator2 "{}"
#comfunc global IUIAnimationInterpolator2_GetDimension                3 var
#comfunc global IUIAnimationInterpolator2_SetInitialValueAndVelocity  4 var,var,int
#comfunc global IUIAnimationInterpolator2_SetDuration                 5 double
#comfunc global IUIAnimationInterpolator2_GetDuration                 6 var
#comfunc global IUIAnimationInterpolator2_GetFinalValue               7 var,int
#comfunc global IUIAnimationInterpolator2_InterpolateValue            8 double,var,int
#comfunc global IUIAnimationInterpolator2_InterpolateVelocity         9 double,var,int
#comfunc global IUIAnimationInterpolator2_GetPrimitiveInterpolation   10 sptr,int
#comfunc global IUIAnimationInterpolator2_GetDependencies             11 var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。