Klasa CAnimationVariable

Reprezentuje zmienną animacji.

Składnia

class CAnimationVariable;

Członkowie

Konstruktory publiczne

Nazwa/nazwisko	opis
CAnimationVariable::CAnimationVariable	Tworzy obiekt zmiennej animacji.
CAnimationVariable::~CAnimationVariable	Destruktora. Wywoływana, gdy obiekt CAnimationVariable jest niszczony.

Metody publiczne

Nazwa/nazwisko	opis
CAnimationVariable::AddTransition	Dodaje przejście.
CAnimationVariable::ApplyTransitions	Dodaje przejścia z wewnętrznej listy do scenorysu.
CAnimationVariable::ClearTransitions	Czyści przejścia.
CAnimationVariable::Create	Tworzy obiekt COM podstawowej zmiennej animacji.
CAnimationVariable::CreateTransitions	Tworzy wszystkie przejścia, które mają zostać zastosowane do tej zmiennej animacji.
CAnimationVariable::EnableIntegerValueChangedEvent	Włącza lub wyłącza zdarzenie IntegerValueChanged.
CAnimationVariable::EnableValueChangedEvent	Włącza lub wyłącza zdarzenie ValueChanged.
CAnimationVariable::GetDefaultValue	Zwraca wartość domyślną.
CAnimationVariable::GetParentAnimationObject	Zwraca obiekt animacji nadrzędnej.
CAnimationVariable::GetValue	Przeciążone. Zwraca bieżącą wartość zmiennej animacji.
CAnimationVariable::GetVariable	Zwraca wskaźnik do obiektu IUIAnimationVariable COM.
CAnimationVariable::SetDefaultValue	Ustawia wartość domyślną i zwalnia obiekt IUIAnimationVariable COM.

Metody chronione

Nazwa/nazwisko	opis
CAnimationVariable::SetParentAnimationObject	Ustawia relację między zmienną animacji a obiektem animacji.

Publiczne elementy członkowskie danych

Nazwa/nazwisko	opis
CAnimationVariable::m_bAutodestroyTransitions	Określa, czy powiązane obiekty przejścia powinny zostać usunięte.

Chronione składowe danych

Nazwa/nazwisko	opis
CAnimationVariable::m_dblDefaultValue	Określa wartość domyślną, która jest propagowana do IUIIAnimationVariable.
CAnimationVariable::m_lstTransitions	Zawiera listę przejść, które animują tę zmienną animacji.
CAnimationVariable::m_pParentObject	Wskaźnik do obiektu animacji, który hermetyzuje tę zmienną animacji.
CAnimationVariable::m_variable	Przechowuje wskaźnik do obiektu IUIAnimationVariable COM. Wartość NULL, jeśli obiekt COM nie został jeszcze utworzony lub jeśli tworzenie nie powiodło się.

Uwagi

Klasa CAnimationVariable hermetyzuje obiekt IUIIAnimationVariable COM. Zawiera również listę przejść, które mają zostać zastosowane do zmiennej animacji w scenorysie. Obiekty CAnimationVariable są osadzone w obiektach animacji, które mogą reprezentować w aplikacji animowaną wartość, punkt, rozmiar, kolor i prostokąt.

Hierarchia dziedziczenia

CAnimationVariable

Wymagania

Nagłówek: afxanimationcontroller.h

CAnimationVariable::~CAnimationVariable

Destruktora. Wywoływana, gdy obiekt CAnimationVariable jest niszczony.

virtual ~CAnimationVariable();

CAnimationVariable::AddTransition

Dodaje przejście.

void AddTransition(CBaseTransition* pTransition);

Parametry

pTransition
Wskaźnik do przejścia do dodania.

Uwagi

Ta metoda jest wywoływana w celu dodania przejścia do wewnętrznej listy przejść, które mają zostać zastosowane do zmiennej animacji. Ta lista powinna zostać wyczyszczone po zaplanowaniu animacji.

CAnimationVariable::ApplyTransitions

Dodaje przejścia z wewnętrznej listy do scenorysu.

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

Parametry

pController
Wskaźnik do nadrzędnego kontrolera animacji.

pStoryboard
Wskaźnik do scenorysu.

bDependOnKeyframes
PRAWDA, jeśli ta metoda powinna dodać przejścia, które zależą od klatek kluczowych.

Uwagi

Ta metoda dodaje przejścia z wewnętrznej listy do scenorysu. Jest wywoływany z kodu najwyższego poziomu kilka razy, aby dodać przejścia, które nie zależą od klatek kluczowych i dodać przejścia zależne od ramek kluczowych. Jeśli podstawowy obiekt COM zmiennej animacji nie został utworzony, ta metoda tworzy go na tym etapie.

CAnimationVariable::CAnimationVariable

Tworzy obiekt zmiennej animacji.

CAnimationVariable(DOUBLE dblDefaultValue = 0.0);

Parametry

dblDefaultValue
Określa wartość domyślną.

Uwagi

Tworzy obiekt zmiennej animacji i ustawia jego wartość domyślną. Wartość domyślna jest używana, gdy zmienna nie jest animowana lub nie może być animowana.

CAnimationVariable::ClearTransitions

Czyści przejścia.

void ClearTransitions(BOOL bAutodestroy);

Parametry

bAutodestroy
Określa, czy ta metoda powinna usuwać obiekty przejściowe.

Uwagi

Ta metoda usuwa wszystkie przejścia z wewnętrznej listy przejść. Jeśli wartość bAutodestroy ma wartość TRUE lub m_bAutodestroyTransitions ma wartość TRUE, przejścia zostaną usunięte. W przeciwnym razie obiekt wywołujący powinien cofnąć przydział obiektów przejścia.

CAnimationVariable::Create

Tworzy obiekt COM podstawowej zmiennej animacji.

virtual BOOL Create(IUIAnimationManager* pManager);

Parametry

pManager
Wskaźnik do menedżera animacji.

Wartość zwracana

WARTOŚĆ TRUE, jeśli zmienna animacji została pomyślnie utworzona; w przeciwnym razie FAŁSZ.

Uwagi

Ta metoda tworzy obiekt COM podstawowej zmiennej animacji i ustawia jego wartość domyślną.

CAnimationVariable::CreateTransitions

Tworzy wszystkie przejścia, które mają zostać zastosowane do tej zmiennej animacji.

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

Parametry

pLibrary
Wskaźnik do interfejsu IUIAnimationTransitionLibrary, który definiuje bibliotekę standardowych przejść.

Wartość zwracana

Wartość TRUE, jeśli przejścia zostały utworzone pomyślnie; w przeciwnym razie FAŁSZ.

Uwagi

Ta metoda jest wywoływana przez platformę, gdy musi utworzyć przejścia, które zostały dodane do wewnętrznej listy przejść zmiennej.

CAnimationVariable::EnableIntegerValueChangedEvent

Włącza lub wyłącza zdarzenie IntegerValueChanged.

void EnableIntegerValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parametry

pController
Wskaźnik do kontrolera nadrzędnego.

bEnable
TRUE — włącz zdarzenie, FAŁSZ — wyłącz zdarzenie.

Uwagi

Po włączeniu zdarzenia ValueChanged struktura wywołuje metodę wirtualną CAnimationController::OnAnimationIntegerValueChanged. Aby przetworzyć to zdarzenie, należy zastąpić ją w klasie pochodzącej z klasy CAnimationController. Ta metoda jest wywoływana za każdym razem, gdy zmienia się wartość całkowita zmiennej animacji.

CAnimationVariable::EnableValueChangedEvent

Włącza lub wyłącza zdarzenie ValueChanged.

void EnableValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parametry

pController
Wskaźnik do kontrolera nadrzędnego.

bEnable
TRUE — włącz zdarzenie, FAŁSZ — wyłącz zdarzenie.

Uwagi

Po włączeniu zdarzenia ValueChanged struktura wywołuje metodę wirtualną CAnimationController::OnAnimationValueChanged. Aby przetworzyć to zdarzenie, należy zastąpić ją w klasie pochodzącej z klasy CAnimationController. Ta metoda jest wywoływana za każdym razem, gdy wartość zmiennej animacji zostanie zmieniona.

CAnimationVariable::GetDefaultValue

Zwraca wartość domyślną.

DOUBLE GetDefaultValue() const;

Wartość zwracana

Wartość domyślna.

Uwagi

Użyj tej funkcji, aby uzyskać wartość domyślną zmiennej animacji. Wartość domyślną można ustawić w konstruktorze lub metodzie SetDefaultValue.

CAnimationVariable::GetParentAnimationObject

Zwraca obiekt animacji nadrzędnej.

CAnimationBaseObject* GetParentAnimationObject();

Wartość zwracana

Wskaźnik do obiektu animacji nadrzędnej, jeśli została ustanowiona relacja, w przeciwnym razie wartość NULL.

Uwagi

Tę metodę można wywołać, aby pobrać wskaźnik do obiektu animacji nadrzędnej (kontenera).

CAnimationVariable::GetValue

Zwraca bieżącą wartość zmiennej animacji.

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

Parametry

dblValue
Bieżąca wartość zmiennej animacji.

nValue
Bieżąca wartość zmiennej animacji.

Wartość zwracana

S_OK, jeśli wartość została pomyślnie uzyskana lub nie utworzono bazowej zmiennej animacji. W przeciwnym razie kod błędu HRESULT.

Uwagi

Tę metodę można wywołać, aby pobrać bieżącą wartość zmiennej animacji. Jeśli podstawowy obiekt COM nie został utworzony, dblValue będzie zawierać wartość domyślną, gdy funkcja zwróci.

CAnimationVariable::GetVariable

Zwraca wskaźnik do obiektu IUIAnimationVariable COM.

IUIAnimationVariable* GetVariable();

Wartość zwracana

Prawidłowy wskaźnik do obiektu IUIAnimationVariable COM lub NULL, jeśli zmienna animacji nie została utworzona lub nie można jej utworzyć.

Uwagi

Użyj tej funkcji, aby uzyskać dostęp do bazowego obiektu IUIAnimationVariable COM i wywołać jego metody bezpośrednio w razie potrzeby.

CAnimationVariable::m_bAutodestroyTransitions

Określa, czy powiązane obiekty przejścia powinny zostać usunięte.

BOOL m_bAutodestroyTransitions;

Uwagi

Ustaw tę wartość na WARTOŚĆ TRUE, aby wymusić usunięcie obiektów przejściowych po usunięciu ich z wewnętrznej listy przejść. Jeśli ta wartość to FALSE, przejścia powinny zostać usunięte przez wywołanie aplikacji. Lista przejść jest zawsze czyszczone po zaplanowaniu animacji. Wartość domyślna to FALSE.

CAnimationVariable::m_dblDefaultValue

Określa wartość domyślną, która jest propagowana do IUIIAnimationVariable.

DOUBLE m_dblDefaultValue;

CAnimationVariable::m_lstTransitions

Zawiera listę przejść, które animują tę zmienną animacji.

CObList m_lstTransitions;

CAnimationVariable::m_pParentObject

Wskaźnik do obiektu animacji, który hermetyzuje tę zmienną animacji.

CAnimationBaseObject* m_pParentObject;

CAnimationVariable::m_variable

Przechowuje wskaźnik do obiektu IUIAnimationVariable COM. Wartość NULL, jeśli obiekt COM nie został jeszcze utworzony lub jeśli tworzenie nie powiodło się.

ATL::CComPtr<IUIAnimationVariable> m_variable;

CAnimationVariable::SetDefaultValue

Ustawia wartość domyślną i zwalnia obiekt IUIAnimationVariable COM.

void SetDefaultValue(DOUBLE dblDefaultValue);

Parametry

dblDefaultValue
Określa nową wartość domyślną.

Uwagi

Użyj tej metody, aby zresetować wartość domyślną. Ta metoda zwalnia wewnętrzny obiekt IUIAnimationVariable COM, dlatego po ponownym utworzeniu zmiennej animacji obiekt COM pobiera nową wartość domyślną. Wartość domyślna jest zwracana przez metodę GetValue, jeśli obiekt COM reprezentujący zmienną animacji nie został utworzony lub jeśli zmienna nie została animowana.

CAnimationVariable::SetParentAnimationObject

Ustawia relację między zmienną animacji a obiektem animacji.

void SetParentAnimationObject(CAnimationBaseObject* pParentObject);

Parametry

pParentObject
Wskaźnik do obiektu animacji zawierającego tę zmienną.

Uwagi

Ta metoda jest wywoływana wewnętrznie w celu ustanowienia relacji jeden do jednego między zmienną animacji a obiektem animacji, który hermetyzuje ją.

Zobacz też

Klasy