CAnimationVariable クラス

アニメーション変数を表します。

構文

class CAnimationVariable;

メンバー

パブリック コンストラクター

名前	説明
CAnimationVariable::CAnimationVariable	アニメーション変数オブジェクトを構築します。
CAnimationVariable::~CAnimationVariable	デストラクター。 CAnimationVariable オブジェクトが破棄されるときに呼び出されます。

パブリック メソッド

名前	説明
CAnimationVariable::AddTransition	遷移を追加します。
CAnimationVariable::ApplyTransitions	内部リストからストーリーボードへの遷移を追加します。
CAnimationVariable::ClearTransitions	画面切り替えをクリアします。
CAnimationVariable::Create	基になるアニメーション変数 COM オブジェクトを作成します。
CAnimationVariable::CreateTransitions	このアニメーション変数に適用されるすべての遷移を作成します。
CAnimationVariable::EnableIntegerValueChangedEvent	IntegerValueChanged イベントを有効または無効にします。
CAnimationVariable::EnableValueChangedEvent	ValueChanged イベントを有効または無効にします。
CAnimationVariable::GetDefaultValue	既定値を返します。
CAnimationVariable::GetParentAnimationObject	親アニメーション オブジェクトを返します。
CAnimationVariable::GetValue	過負荷です。 アニメーション変数の現在の値を返します。
CAnimationVariable::GetVariable	IUIAnimationVariable COM オブジェクトへのポインターを返します。
CAnimationVariable::SetDefaultValue	既定値を設定し、IUIAnimationVariable COM オブジェクトを解放します。

保護メソッド

名前	説明
CAnimationVariable::SetParentAnimationObject	アニメーション変数とアニメーション オブジェクトの関係を設定します。

パブリック データ メンバー

名前	説明
CAnimationVariable::m_bAutodestroyTransitions	関連する遷移オブジェクトを削除するかどうかを指定します。

プロテクト データ メンバー

名前	説明
CAnimationVariable::m_dblDefaultValue	IUIAnimationVariable に伝達される既定値を指定します。
CAnimationVariable::m_lstTransitions	このアニメーション変数をアニメーション化する画面切り替えの一覧が含まれています。
CAnimationVariable::m_pParentObject	このアニメーション変数をカプセル化するアニメーション オブジェクトへのポインター。
CAnimationVariable::m_variable	IUIAnimationVariable COM オブジェクトへのポインターを格納します。 COM オブジェクトがまだ作成されていない場合、または作成に失敗した場合は NULL。

解説

CAnimationVariable クラスは、IUIAnimationVariable COM オブジェクトをカプセル化します。 また、ストーリーボード内のアニメーション変数に適用する遷移の一覧も保持します。 CAnimationVariable オブジェクトはアニメーション オブジェクトに埋め込まれ、アプリケーションでアニメーション化された値、ポイント、サイズ、色、四角形を表すことができます。

継承階層

CAnimationVariable

要件

ヘッダー: afxanimationcontroller.h

CAnimationVariable::~CAnimationVariable

デストラクター。 CAnimationVariable オブジェクトが破棄されるときに呼び出されます。

virtual ~CAnimationVariable();

CAnimationVariable::AddTransition

遷移を追加します。

void AddTransition(CBaseTransition* pTransition);

パラメーター

pTransition
追加する遷移へのポインター。

解説

このメソッドは、アニメーション変数に適用する遷移の内部リストに遷移を追加するために呼び出されます。 アニメーションがスケジュールされている場合は、このリストをクリアする必要があります。

CAnimationVariable::ApplyTransitions

内部リストからストーリーボードへの遷移を追加します。

void ApplyTransitions(
    CAnimationController* pController,
    IUIAnimationStoryboard* pStoryboard,
    BOOL bDependOnKeyframes);

パラメーター

pController
親アニメーション コントローラーへのポインター。

pStoryboard
ストーリーボードへのポインター。

bDependOnKeyframes
TRUE の場合、このメソッドは、キーフレームに依存する遷移を追加する必要があります。

解説

このメソッドは、内部リストからストーリーボードへの遷移を追加します。 最上位のコードから何度か呼び出され、キーフレームに依存しない遷移を追加し、キーフレームに依存する遷移を追加します。 基になるアニメーション変数 COM オブジェクトが作成されていない場合、このメソッドはこの段階でそれを作成します。

CAnimationVariable::CAnimationVariable

アニメーション変数オブジェクトを構築します。

CAnimationVariable(DOUBLE dblDefaultValue = 0.0);

パラメーター

dblDefaultValue
既定値を指定します。

解説

アニメーション変数オブジェクトを構築し、その既定値を設定します。 既定値は、変数がアニメーション化されていない場合、またはアニメーション化できない場合に使用されます。

CAnimationVariable::ClearTransitions

画面切り替えをクリアします。

void ClearTransitions(BOOL bAutodestroy);

パラメーター

bAutodestroy
このメソッドで遷移オブジェクトを削除するかどうかを指定します。

解説

このメソッドは、遷移の内部リストからすべての遷移を削除します。 bAutodestroy が TRUE の場合、またはm_bAutodestroyTransitionsが TRUE の場合、遷移は削除されます。 それ以外の場合、呼び出し元は遷移オブジェクトの割り当てを解除する必要があります。

CAnimationVariable::Create

基になるアニメーション変数 COM オブジェクトを作成します。

virtual BOOL Create(IUIAnimationManager* pManager);

パラメーター

pManager
アニメーション マネージャーへのポインター。

戻り値

アニメーション変数が正常に作成された場合は TRUE。それ以外の場合は FALSE。

解説

このメソッドは、基になるアニメーション変数 COM オブジェクトを作成し、その既定値を設定します。

CAnimationVariable::CreateTransitions

このアニメーション変数に適用されるすべての遷移を作成します。

BOOL CreateTransitions(
    IUIAnimationTransitionLibrary* pLibrary,
    IUIAnimationTransitionFactory* \*not used*\);

パラメーター

pLibrary
標準遷移のライブラリを定義する IUIAnimationTransitionLibrary インターフェイスへのポインター。

戻り値

遷移が正常に作成された場合は TRUE。それ以外の場合は FALSE。

解説

このメソッドは、変数の遷移の内部リストに追加された遷移を作成する必要がある場合に、フレームワークによって呼び出されます。

CAnimationVariable::EnableIntegerValueChangedEvent

IntegerValueChanged イベントを有効または無効にします。

void EnableIntegerValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

パラメーター

pController
親コントローラーへのポインター。

bEnable
TRUE - イベントを有効にし、FALSE - イベントを無効にします。

解説

ValueChanged イベントが有効になっている場合、フレームワークは仮想メソッド CAnimationController::OnAnimationIntegerValueChanged を呼び出します。 このイベントを処理するには、CAnimationController から派生したクラスでオーバーライドする必要があります。 このメソッドは、アニメーション変数の整数値が変更されるたびに呼び出されます。

CAnimationVariable::EnableValueChangedEvent

ValueChanged イベントを有効または無効にします。

void EnableValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

パラメーター

pController
親コントローラーへのポインター。

bEnable
TRUE - イベントを有効にし、FALSE - イベントを無効にします。

解説

ValueChanged イベントが有効になっている場合、フレームワークは仮想メソッド CAnimationController::OnAnimationValueChanged を呼び出します。 このイベントを処理するには、CAnimationController から派生したクラスでオーバーライドする必要があります。 このメソッドは、アニメーション変数の値が変更されるたびに呼び出されます。

CAnimationVariable::GetDefaultValue

既定値を返します。

DOUBLE GetDefaultValue() const;

戻り値

既定値 。

解説

アニメーション変数の既定値を取得するには、この関数を使用します。 既定値は、コンストラクターまたは SetDefaultValue メソッドで設定できます。

CAnimationVariable::GetParentAnimationObject

親アニメーション オブジェクトを返します。

CAnimationBaseObject* GetParentAnimationObject();

戻り値

リレーションシップが確立された場合は親アニメーション オブジェクトへのポインター。それ以外の場合は NULL。

解説

このメソッドを呼び出して、親アニメーション オブジェクト (コンテナー) へのポインターを取得できます。

CAnimationVariable::GetValue

アニメーション変数の現在の値を返します。

HRESULT GetValue(DOUBLE& dblValue);
HRESULT GetValue(INT32& nValue);

パラメーター

dblValue
アニメーション変数の現在の値。

nValue
アニメーション変数の現在の値。

戻り値

値が正常に取得された場合、または基になるアニメーション変数が作成されていない場合にS_OKします。 それ以外の場合は、HRESULT エラー コード。

解説

このメソッドを呼び出して、アニメーション変数の現在の値を取得できます。 基になる COM オブジェクトが作成されていない場合、dblValue には、関数が戻るときに既定値が含まれます。

CAnimationVariable::GetVariable

IUIAnimationVariable COM オブジェクトへのポインターを返します。

IUIAnimationVariable* GetVariable();

戻り値

IUIAnimationVariable COM オブジェクトへの有効なポインター。アニメーション変数が作成されていない場合、または作成できない場合は NULL。

解説

この関数を使用して、基になる IUIAnimationVariable COM オブジェクトにアクセスし、必要に応じてそのメソッドを直接呼び出します。

CAnimationVariable::m_bAutodestroyTransitions

関連する遷移オブジェクトを削除するかどうかを指定します。

BOOL m_bAutodestroyTransitions;

解説

遷移オブジェクトが遷移の内部リストから削除されるときに強制的に削除されるようにするには、この値を TRUE に設定します。 この値が FALSE の場合は、アプリケーションを呼び出して遷移を削除する必要があります。 アニメーションがスケジュールされた後、画面切り替えの一覧は常にクリアされます。 既定値は FALSE です。

CAnimationVariable::m_dblDefaultValue

IUIAnimationVariable に伝達される既定値を指定します。

DOUBLE m_dblDefaultValue;

CAnimationVariable::m_lstTransitions

このアニメーション変数をアニメーション化する画面切り替えの一覧が含まれています。

CObList m_lstTransitions;

CAnimationVariable::m_pParentObject

このアニメーション変数をカプセル化するアニメーション オブジェクトへのポインター。

CAnimationBaseObject* m_pParentObject;

CAnimationVariable::m_variable

IUIAnimationVariable COM オブジェクトへのポインターを格納します。 COM オブジェクトがまだ作成されていない場合、または作成に失敗した場合は NULL。

ATL::CComPtr<IUIAnimationVariable> m_variable;

CAnimationVariable::SetDefaultValue

既定値を設定し、IUIAnimationVariable COM オブジェクトを解放します。

void SetDefaultValue(DOUBLE dblDefaultValue);

パラメーター

dblDefaultValue
新しい既定値を指定します。

解説

既定値をリセットするには、このメソッドを使用します。 このメソッドは、内部 IUIAnimationVariable COM オブジェクトを解放するため、アニメーション変数を再作成すると、基になる COM オブジェクトは新しい既定値を取得します。 アニメーション変数を表す COM オブジェクトが作成されていない場合、または変数がアニメーション化されていない場合、GetValue によって既定値が返されます。

CAnimationVariable::SetParentAnimationObject

アニメーション変数とアニメーション オブジェクトの関係を設定します。

void SetParentAnimationObject(CAnimationBaseObject* pParentObject);

パラメーター

pParentObject
この変数を含むアニメーション オブジェクトへのポインター。

解説

このメソッドは、アニメーション変数とそれをカプセル化するアニメーション オブジェクトの間に一対一のリレーションシップを確立するために内部的に呼び出されます。

関連項目

クラス