Класс 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	Возвращает указатель на объект COM IUIAnimationVariable.
CAnimationVariable::SetDefaultValue	Задает значение по умолчанию и освобождает объект COM IUIAnimationVariable.

Защищенные методы

Имя	Описание
CAnimationVariable::SetParentAnimationObject	Задает связь между переменной анимации и объектом анимации.

Открытые члены данных

Имя	Описание
CAnimationVariable::m_bAutodestroyTransitions	Указывает, следует ли удалять связанные объекты перехода.

Защищенные члены данных

Имя	Описание
CAnimationVariable::m_dblDefaultValue	Указывает значение по умолчанию, которое распространяется на IUIAnimationVariable.
CAnimationVariable::m_lstTransitions	Содержит список переходов, которые анимирует эту переменную анимации.
CAnimationVariable::m_pParentObject	Указатель на объект анимации, инкапсулирующий эту переменную анимации.
CAnimationVariable::m_variable	Сохраняет указатель на объект COM IUIAnimationVariable. ЗНАЧЕНИЕ NULL, если com-объект еще не создан или если создание завершилось сбоем.

Замечания

Класс CAnimationVariable инкапсулирует объект COM IUIAnimationVariable. Он также содержит список переходов, применяемых к переменной анимации в раскадровке. Объекты 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);

Параметры

bAutodeode
Указывает, должен ли этот метод удалять объекты перехода.

Замечания

Этот метод удаляет все переходы из внутреннего списка переходов. Если значение bAutodest имеет значение 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

Возвращает указатель на объект COM IUIAnimationVariable.

IUIAnimationVariable* GetVariable();

Возвращаемое значение

Допустимый указатель на объект COM IUIAnimationVariable или NULL, если переменная анимации не создана или не может быть создана.

Замечания

Используйте эту функцию для доступа к базовому объекту COM IUIAnimationVariable и вызовите его методы напрямую при необходимости.

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

Сохраняет указатель на объект COM IUIAnimationVariable. ЗНАЧЕНИЕ NULL, если com-объект еще не создан или если создание завершилось сбоем.

ATL::CComPtr<IUIAnimationVariable> m_variable;

CAnimationVariable::SetDefaultValue

Задает значение по умолчанию и освобождает объект COM IUIAnimationVariable.

void SetDefaultValue(DOUBLE dblDefaultValue);

Параметры

dblDefaultValue
Задает новое значение по умолчанию.

Замечания

Используйте этот метод для сброса значения по умолчанию. Этот метод освобождает внутренний com-объект IUIAnimationVariable COM, поэтому при повторном создании переменной анимации базовый COM-объект получает новое значение по умолчанию. Значение по умолчанию возвращается GetValue, если com-объект, представляющий переменную анимации, не создается или если переменная не была анимирована.

CAnimationVariable::SetParentAnimationObject

Задает связь между переменной анимации и объектом анимации.

void SetParentAnimationObject(CAnimationBaseObject* pParentObject);

Параметры

pParentObject
Указатель на объект анимации, содержащий эту переменную.

Замечания

Этот метод вызывается внутренне для установления связи между переменной анимации и объектом анимации, который инкапсулирует его.

См. также

Классы