Classe CAnimationVariable

Representa uma variável de animação.

Sintaxe

class CAnimationVariable;

Membros

Construtores públicos

Nome	Descrição
CAnimationVariable::CAnimationVariable	Constrói um objeto de variável de animação.
CAnimationVariable::~CAnimationVariable	O destruidor. Chamado quando um objeto CAnimationVariable está sendo destruído.

Métodos públicos

Nome	Descrição
CAnimationVariable::AddTransition	Adiciona uma transição.
CAnimationVariable::ApplyTransitions	Adiciona transições da lista interna ao storyboard.
CAnimationVariable::ClearTransitions	Limpa transições.
CAnimationVariable::Create	Cria o objeto COM da variável de animação subjacente.
CAnimationVariable::CreateTransitions	Cria todas as transições a serem aplicadas a essa variável de animação.
CAnimationVariable::EnableIntegerValueChangedEvent	Habilita ou desabilita o evento IntegerValueChanged.
CAnimationVariable::EnableValueChangedEvent	Habilita ou desabilita o evento ValueChanged.
CAnimationVariable::GetDefaultValue	Retorna o valor padrão.
CAnimationVariable::GetParentAnimationObject	Retorna o objeto de animação pai.
CAnimationVariable::GetValue	Sobrecarregado. Retorna o valor atual da variável de animação.
CAnimationVariable::GetVariable	Retorna um ponteiro para o objeto COM IUIAnimationVariable.
CAnimationVariable::SetDefaultValue	Define o valor padrão e libera o objeto COM IUIAnimationVariable.

Métodos protegidos

Nome	Descrição
CAnimationVariable::SetParentAnimationObject	Define a relação entre uma variável de animação e um objeto de animação.

Membros de Dados Públicos

Nome	Descrição
CAnimationVariable::m_bAutodestroyTransitions	Especifica se os objetos de transição relacionados devem ser excluídos.

Membros de dados protegidos

Nome	Descrição
CAnimationVariable::m_dblDefaultValue	Especifica o valor padrão, que é propagado para IUIAnimationVariable.
CAnimationVariable::m_lstTransitions	Contém uma lista de transições que animam essa variável de animação.
CAnimationVariable::m_pParentObject	Um ponteiro para um objeto de animação que encapsula essa variável de animação.
CAnimationVariable::m_variable	Armazena um ponteiro no objeto COM IUIAnimationVariable. NULL se o objeto COM ainda não foi criado ou se a criação falhou.

Comentários

A classe CAnimationVariable encapsula o objeto COM IUIAnimationVariable. Ela também contém uma lista de transições a serem aplicadas à variável de animação em um storyboard. Objetos CAnimationVariable são inseridos em objetos de animação, que podem representar um valor animado, ponto, tamanho, cor e retângulo em um aplicativo.

Hierarquia de herança

CAnimationVariable

Requisitos

Cabeçalho: afxanimationcontroller.h

CAnimationVariable::~CAnimationVariable

O destruidor. Chamado quando um objeto CAnimationVariable está sendo destruído.

virtual ~CAnimationVariable();

CAnimationVariable::AddTransition

Adiciona uma transição.

void AddTransition(CBaseTransition* pTransition);

Parâmetros

pTransition
Um ponteiro para uma transição a ser adicionada.

Comentários

Esse método é chamado para adicionar uma transição à lista interna de transições a serem aplicadas à variável de animação. Essa lista deve ser desmarcada quando uma animação tiver sido agendada.

CAnimationVariable::ApplyTransitions

Adiciona transições da lista interna ao storyboard.

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

Parâmetros

pController
Um ponteiro para o controlador de animação pai.

pStoryboard
Um ponteiro para o storyboard.

bDependOnKeyframes
TRUE, se esse método deve adicionar transições que dependem de quadros-chave.

Comentários

Esse método adiciona transições da lista interna ao storyboard. Ele é chamado do código de nível superior várias vezes para adicionar transições que dependam e que não dependam de quadros-chave. Se o objeto COM da variável de animação subjacente não tiver sido criado, esse método o criará nesta fase.

CAnimationVariable::CAnimationVariable

Constrói um objeto de variável de animação.

CAnimationVariable(DOUBLE dblDefaultValue = 0.0);

Parâmetros

dblDefaultValue
Especifica o valor padrão.

Comentários

Constrói um objeto de variável de animação e define seu valor padrão. Um valor padrão é usado quando uma variável não é animada ou não pode ser animada.

CAnimationVariable::ClearTransitions

Limpa transições.

void ClearTransitions(BOOL bAutodestroy);

Parâmetros

bAutodestroy
Especifica se esse método deve excluir objetos de transição.

Comentários

Esse método remove todas as transições da lista interna de transições. Se bAutodestroy ou m_bAutodestroyTransitions for TRUE, as transições serão excluídas. Caso contrário, o chamador deverá desalocar os objetos de transição.

CAnimationVariable::Create

Cria o objeto COM da variável de animação subjacente.

virtual BOOL Create(IUIAnimationManager* pManager);

Parâmetros

pManager
Um ponteiro para o gerenciador de animação.

Valor de retorno

TRUE se a variável de animação foi criada com êxito; caso contrário, FALSE.

Comentários

Esse método cria o objeto COM da variável de animação subjacente e define seu valor padrão.

CAnimationVariable::CreateTransitions

Cria todas as transições a serem aplicadas a essa variável de animação.

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

Parâmetros

pLibrary
Um ponteiro para uma interface IUIAnimationTransitionLibrary, que define uma biblioteca de transições padrão.

Valor de retorno

TRUE se a transição foi criada com êxito; caso contrário, FALSE.

Comentários

Esse método é chamado pela estrutura quando precisa criar transições que foram adicionadas à lista interna de transições da variável.

CAnimationVariable::EnableIntegerValueChangedEvent

Habilita ou desabilita o evento IntegerValueChanged.

void EnableIntegerValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parâmetros

pController
Um ponteiro para o controlador pai.

bEnable
TRUE – habilitar evento, FALSE – desabilitar evento.

Comentários

Quando o evento ValueChanged está habilitado, a estrutura chama o método virtual CAnimationController::OnAnimationIntegerValueChanged. Você precisa substituí-lo em uma classe derivada de CAnimationController para processar esse evento. Esse método é chamado sempre que o valor inteiro da variável de animação é alterado.

CAnimationVariable::EnableValueChangedEvent

Habilita ou desabilita o evento ValueChanged.

void EnableValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parâmetros

pController
Um ponteiro para o controlador pai.

bEnable
TRUE – habilitar evento, FALSE – desabilitar evento.

Comentários

Quando o evento ValueChanged está habilitado, a estrutura chama o método virtual CAnimationController::OnAnimationValueChanged. Você precisa substituí-lo em uma classe derivada de CAnimationController para processar esse evento. Esse método é chamado sempre que o valor da variável de animação é alterado.

CAnimationVariable::GetDefaultValue

Retorna o valor padrão.

DOUBLE GetDefaultValue() const;

Valor de retorno

O valor padrão.

Comentários

Use essa função para obter o valor padrão da variável de animação. O valor padrão pode ser definido no construtor ou pelo método SetDefaultValue.

CAnimationVariable::GetParentAnimationObject

Retorna o objeto de animação pai.

CAnimationBaseObject* GetParentAnimationObject();

Valor de retorno

Um ponteiro para o objeto de animação pai se a relação foi estabelecida; caso contrário, NULL.

Comentários

Esse método pode ser chamado para recuperar um ponteiro para um objeto de animação pai (um contêiner).

CAnimationVariable::GetValue

Retorna o valor atual da variável de animação.

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

Parâmetros

dblValue
O valor atual da variável de animação.

nValue
O valor atual da variável de animação.

Valor de retorno

S_OK se o valor foi obtido com êxito ou a variável de animação subjacente não foi criada. Caso contrário, apresentará o código de erro HRESULT.

Comentários

Esse método pode ser chamado para recuperar o valor atual da variável de animação. Se o objeto COM subjacente não tiver sido criado, dblValue conterá um valor padrão quando a função retornar.

CAnimationVariable::GetVariable

Retorna um ponteiro para o objeto COM IUIAnimationVariable.

IUIAnimationVariable* GetVariable();

Valor de retorno

Um ponteiro válido para o objeto COM IUIAnimationVariable ou NULL se a variável de animação não foi criada ou não pode ser criada.

Comentários

Use essa função para acessar o objeto COM IUIAnimationVariable subjacente e chamar seus métodos diretamente, se necessário.

CAnimationVariable::m_bAutodestroyTransitions

Especifica se os objetos de transição relacionados devem ser excluídos.

BOOL m_bAutodestroyTransitions;

Comentários

Defina esse valor como TRUE para forçar a exclusão de objetos de transição quando eles estiverem sendo removidos da lista interna de transições. Se esse valor for FALSE, as transições deverão ser excluídas chamando o aplicativo. A lista de transições é sempre desmarcada após o agendamento de uma animação. O valor padrão é FALSE.

CAnimationVariable::m_dblDefaultValue

Especifica o valor padrão, que é propagado para IUIAnimationVariable.

DOUBLE m_dblDefaultValue;

CAnimationVariable::m_lstTransitions

Contém uma lista de transições que animam essa variável de animação.

CObList m_lstTransitions;

CAnimationVariable::m_pParentObject

Um ponteiro para um objeto de animação que encapsula essa variável de animação.

CAnimationBaseObject* m_pParentObject;

CAnimationVariable::m_variable

Armazena um ponteiro no objeto COM IUIAnimationVariable. NULL se o objeto COM ainda não foi criado ou se a criação falhou.

ATL::CComPtr<IUIAnimationVariable> m_variable;

CAnimationVariable::SetDefaultValue

Define o valor padrão e libera o objeto COM IUIAnimationVariable.

void SetDefaultValue(DOUBLE dblDefaultValue);

Parâmetros

dblDefaultValue
Especifica o novo valor padrão.

Comentários

Use esse método para redefinir o valor padrão. Esse método libera o objeto COM IUIAnimationVariable interno, portanto, quando a variável de animação é recriada, o objeto COM subjacente obtém o novo valor padrão. O valor padrão será retornado por GetValue se o objeto COM que representa a variável de animação não for criado ou se a variável não tiver sido animada.

CAnimationVariable::SetParentAnimationObject

Define a relação entre uma variável de animação e um objeto de animação.

void SetParentAnimationObject(CAnimationBaseObject* pParentObject);

Parâmetros

pParentObject
Um ponteiro para um objeto de animação que contém essa variável.

Comentários

Esse método é chamado internamente para estabelecer uma relação de um para um entre uma variável de animação e um objeto de animação que o encapsula.

Confira também

Classes