CAnimationVariable – třída

Představuje animační proměnnou.

Syntaxe

class CAnimationVariable;

Členové

Veřejné konstruktory

Jméno	popis
CAnimationVariable::CAnimationVariable	Vytvoří animační objekt proměnné.
CAnimationVariable::~CAnimationVariable	Destruktor. Volána při CAnimationVariable objektu je zničen.

Veřejné metody

Jméno	popis
CAnimationVariable::AddTransition	Přidá přechod.
CAnimationVariable::ApplyTransitions	Přidá přechody z interního seznamu do scénáře.
CAnimationVariable::ClearTransitions	Vymaže přechody.
CAnimationVariable::Create	Vytvoří základní animační proměnnou objekt COM.
CAnimationVariable::CreateTransitions	Vytvoří všechny přechody, které se použijí pro tuto animační proměnnou.
CAnimationVariable::EnableIntegerValueChangedEvent	Povolí nebo zakáže událost IntegerValueChanged.
CAnimationVariable::EnableValueChangedEvent	Povolí nebo zakáže událost ValueChanged.
CAnimationVariable::GetDefaultValue	Vrátí výchozí hodnotu.
CAnimationVariable::GetParentAnimationObject	Vrátí nadřazený animační objekt.
CAnimationVariable::GetValue	Přetíženo. Vrátí aktuální hodnotu proměnné animace.
CAnimationVariable::GetVariable	Vrátí ukazatel na objekt COM IUIAnimationVariable.
CAnimationVariable::SetDefaultValue	Nastaví výchozí hodnotu a vydání IUIAnimationVariable COM objektu.

Chráněné metody

Jméno	popis
CAnimationVariable::SetParentAnimationObject	Nastaví relaci mezi animační proměnnou a objektem animace.

Veřejné datové členy

Jméno	popis
CAnimationVariable::m_bAutodestroyTransitions	Určuje, jestli se mají odstranit související přechodové objekty.

Chráněné datové členy

Jméno	popis
CAnimationVariable::m_dblDefaultValue	Určuje výchozí hodnotu, která se rozšíří do IUIAnimationVariable.
CAnimationVariable::m_lstTransitions	Obsahuje seznam přechodů, které animují tuto animační proměnnou.
CAnimationVariable::m_pParentObject	Ukazatel na animační objekt, který zapouzdřuje tuto animační proměnnou.
CAnimationVariable::m_variable	Uloží ukazatel na objekt COM IUIAnimationVariable. NULL pokud objekt COM ještě nebyl vytvořen nebo pokud se vytvoření nezdařilo.

Poznámky

CAnimationVariable třída zapouzdřuje IUIAnimationVariable COM objektu. Obsahuje také seznam přechodů, které se mají použít na animační proměnnou ve scénáři. CAnimationVariable objekty jsou vloženy do animačních objektů, které mohou představovat v aplikaci animační hodnotu, bod, velikost, barvu a obdélník.

Hierarchie dědičnosti

CAnimationVariable

Požadavky

Hlavička: afxanimationcontroller.h

CAnimationVariable::~CAnimationVariable

Destruktor. Volána při CAnimationVariable objektu je zničen.

virtual ~CAnimationVariable();

CAnimationVariable::AddTransition

Přidá přechod.

void AddTransition(CBaseTransition* pTransition);

Parametry

PTransition
Ukazatel na přechod, který chcete přidat.

Poznámky

Tato metoda je volána pro přidání přechodu do interního seznamu přechodů, které se mají použít na animační proměnnou. Tento seznam by měl být při naplánování animace vymazán.

CAnimationVariable::ApplyTransitions

Přidá přechody z interního seznamu do scénáře.

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

Parametry

pController
Ukazatel na nadřazený animační kontroler.

pStoryboard
Ukazatel na scénář.

bDependOnKeyframes
TRUE, pokud by tato metoda měla přidat přechody, které závisí na klíčových rámcích.

Poznámky

Tato metoda přidá přechody z interního seznamu do scénáře. Volá se z kódu nejvyšší úrovně několikrát, aby se přidaly přechody, které nezávisí na klíčových rámcích, a přidávají přechody, které závisí na klíčových rámcích. Pokud nebyl vytvořen objekt COM podkladové proměnné animace, tato metoda ji vytvoří v této fázi.

CAnimationVariable::CAnimationVariable

Vytvoří animační objekt proměnné.

CAnimationVariable(DOUBLE dblDefaultValue = 0.0);

Parametry

dblDefaultValue
Určuje výchozí hodnotu.

Poznámky

Vytvoří objekt proměnné animace a nastaví jeho výchozí hodnotu. Výchozí hodnota se používá v případě, že proměnná není animovaná nebo nemůže být animovaná.

CAnimationVariable::ClearTransitions

Vymaže přechody.

void ClearTransitions(BOOL bAutodestroy);

Parametry

BAutodestroy
Určuje, zda má tato metoda odstranit přechodové objekty.

Poznámky

Tato metoda odebere všechny přechody z interního seznamu přechodů. Pokud je bAutodestroy PRAVDA nebo m_bAutodestroyTransitions je PRAVDA, odstraní se přechody. V opačném případě by volající měl uvolnit přechodové objekty.

CAnimationVariable::Create

Vytvoří základní animační proměnnou objekt COM.

virtual BOOL Create(IUIAnimationManager* pManager);

Parametry

pManager
Ukazatel na správce animací.

Vrácená hodnota

TRUE, pokud byla animační proměnná úspěšně vytvořena; jinak NEPRAVDA.

Poznámky

Tato metoda vytvoří základní animační proměnnou COM objekt a nastaví jeho výchozí hodnotu.

CAnimationVariable::CreateTransitions

Vytvoří všechny přechody, které se použijí pro tuto animační proměnnou.

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

Parametry

pLibrary
Ukazatel na rozhraní IUIAnimationTransitionLibrary, které definuje knihovnu standardních přechodů.

Vrácená hodnota

TRUE, pokud byly přechody úspěšně vytvořeny; jinak NEPRAVDA.

Poznámky

Tato metoda je volána architekturou, když potřebuje vytvořit přechody, které byly přidány do interního seznamu přechodů proměnné.

CAnimationVariable::EnableIntegerValueChangedEvent

Povolí nebo zakáže událost IntegerValueChanged.

void EnableIntegerValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parametry

pController
Ukazatel na nadřazený kontroler.

bEnable
TRUE – povolení události, NEPRAVDA – zakázání události.

Poznámky

Pokud je povolena ValueChanged událost, rozhraní volá virtuální metodu CAnimationController::OnAnimationIntegerValueChanged. Abyste mohli tuto událost zpracovat, musíte ji přepsat ve třídě odvozené z CAnimationController. Tato metoda se volá při každé změně celočíselné hodnoty proměnné animace.

CAnimationVariable::EnableValueChangedEvent

Povolí nebo zakáže událost ValueChanged.

void EnableValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parametry

pController
Ukazatel na nadřazený kontroler.

bEnable
TRUE – povolení události, NEPRAVDA – zakázání události.

Poznámky

Pokud je povolena ValueChanged událost, rozhraní volá virtuální metodu CAnimationController::OnAnimationValueChanged. Abyste mohli tuto událost zpracovat, musíte ji přepsat ve třídě odvozené z CAnimationController. Tato metoda se volá při každé změně hodnoty proměnné animace.

CAnimationVariable::GetDefaultValue

Vrátí výchozí hodnotu.

DOUBLE GetDefaultValue() const;

Vrácená hodnota

Výchozí hodnota

Poznámky

Tato funkce slouží k získání výchozí hodnoty proměnné animace. Výchozí hodnotu lze nastavit v konstruktoru nebo pomocí SetDefaultValue metoda.

CAnimationVariable::GetParentAnimationObject

Vrátí nadřazený animační objekt.

CAnimationBaseObject* GetParentAnimationObject();

Vrácená hodnota

Ukazatel na nadřazený animační objekt, pokud byl vytvořen vztah, jinak NULL.

Poznámky

Tuto metodu lze volat k načtení ukazatele na nadřazený animační objekt (kontejner).

CAnimationVariable::GetValue

Vrátí aktuální hodnotu proměnné animace.

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

Parametry

dblValue
Aktuální hodnota proměnné animace.

nValue
Aktuální hodnota proměnné animace.

Vrácená hodnota

S_OK, pokud byla hodnota úspěšně získána nebo nebyla vytvořena podkladová animační proměnná. Jinak kód chyby HRESULT.

Poznámky

Tuto metodu lze volat k načtení aktuální hodnoty proměnné animace. Pokud nebyl vytvořen základní objekt COM, dblValue bude obsahovat výchozí hodnotu, když funkce vrátí.

CAnimationVariable::GetVariable

Vrátí ukazatel na objekt COM IUIAnimationVariable.

IUIAnimationVariable* GetVariable();

Vrácená hodnota

Platný ukazatel na objekt COM IUIAnimationVariable nebo NULL, pokud nebyla vytvořená animační proměnná nebo nelze vytvořit.

Poznámky

Tato funkce slouží k přístupu k základnímu objektu MODELU COM IUIAnimationVariable a v případě potřeby volejte jeho metody přímo.

CAnimationVariable::m_bAutodestroyTransitions

Určuje, jestli se mají odstranit související přechodové objekty.

BOOL m_bAutodestroyTransitions;

Poznámky

Nastavte tuto hodnotu na TRUE, pokud chcete vynutit odstranění přechodových objektů při jejich odebrání z interního seznamu přechodů. Pokud je tato hodnota FALSE, přechody by měly být odstraněny voláním aplikace. Seznam přechodů se po naplánování animace vždy vymaže. Výchozí hodnota je FALSE.

CAnimationVariable::m_dblDefaultValue

Určuje výchozí hodnotu, která se rozšíří do IUIAnimationVariable.

DOUBLE m_dblDefaultValue;

CAnimationVariable::m_lstTransitions

Obsahuje seznam přechodů, které animují tuto animační proměnnou.

CObList m_lstTransitions;

CAnimationVariable::m_pParentObject

Ukazatel na animační objekt, který zapouzdřuje tuto animační proměnnou.

CAnimationBaseObject* m_pParentObject;

CAnimationVariable::m_variable

Uloží ukazatel na objekt COM IUIAnimationVariable. NULL pokud objekt COM ještě nebyl vytvořen nebo pokud se vytvoření nezdařilo.

ATL::CComPtr<IUIAnimationVariable> m_variable;

CAnimationVariable::SetDefaultValue

Nastaví výchozí hodnotu a vydání IUIAnimationVariable COM objektu.

void SetDefaultValue(DOUBLE dblDefaultValue);

Parametry

dblDefaultValue
Určuje novou výchozí hodnotu.

Poznámky

Tuto metodu použijte k resetování výchozí hodnoty. Tato metoda uvolní interní IUIAnimationVariable COM objektu, a proto při opětovném vytvoření animační proměnné získá základní objekt COM novou výchozí hodnotu. Výchozí hodnota je vrácena GetValue pokud objekt COM představující animační proměnnou není vytvořen nebo pokud proměnná nebyla animované.

CAnimationVariable::SetParentAnimationObject

Nastaví relaci mezi animační proměnnou a objektem animace.

void SetParentAnimationObject(CAnimationBaseObject* pParentObject);

Parametry

pParentObject
Ukazatel na animační objekt, který obsahuje tuto proměnnou.

Poznámky

Tato metoda se nazývá interně k vytvoření relace 1:1 mezi animační proměnnou a animačním objektem, který jej zapouzdřuje.

Viz také

Třídy