Classe CAnimationVariable

Representa uma variável de animação.

Sintaxe

class CAnimationVariable;

Membros

Construtores Públicos

Métodos Públicos

Métodos Protegidos

Membros de Dados Públicos

Membros de Dados Protegidos

Observações

A classe CAnimationVariable encapsula o objeto IUIAnimationVariable COM. Também contém uma lista de transições a aplicar à variável de animação num storyboard. Os objetos CAnimationVariable são incorporados em objetos de animação, que podem representar numa aplicação um valor animado, ponto, tamanho, cor e retângulo.

Hierarquia de herança

CAnimationVariable

Requerimentos

Cabeçalho: afxanimationcontroller.h

CAnimationVariable::~CAnimationVariable

O destruidor. Chamada quando um objeto CAnimationVariable está a ser destruído.

virtual ~CAnimationVariable();

CAnimationVariable::AddTransition

Adiciona uma transição.

void AddTransition(CBaseTransition* pTransition);

Parâmetros

pTransition
Um indicador para uma transição a adicionar.

Observações

Este método é chamado para adicionar uma transição à lista interna de transições a serem aplicadas à variável animação. Esta lista deve ser apagada quando uma animação for agendada.

CAnimationVariable::ApplyTransitions

Adiciona transições da lista interna para o storyboard.

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

Parâmetros

pController
Um apontador para o controlador de animação principal.

pStoryboard
Uma dica para o storyboard.

bDependentOnKeyframes
VERDADE, se este método deve adicionar transições que dependem dos keyframes.

Observações

Este método adiciona transições da lista interna para o storyboard. É chamado várias vezes do código de topo para adicionar transições que não dependem de keyframes e transições que dependem de keyframes. Se o objeto COM da variável de animação subjacente não tiver sido criado, este método cria-o nesta fase.

CAnimationVariable::CAnimationVariable

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

CAnimationVariable(DOUBLE dblDefaultValue = 0.0);

Parâmetros

dblDefaultValue
Especifica o valor padrão.

Observações

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

CAnimationVariable::ClearTransitions

Limpa as transições.

void ClearTransitions(BOOL bAutodestroy);

Parâmetros

bAutodestruição
Especifica se este método deve eliminar objetos de transição.

Observações

Este método remove todas as transições da lista interna de transições. Se o bAutodestroy for VERDADEIRO, ou m_bAutodestroyTransitions for VERDADEIRO, então as transições são apagadas. Caso contrário, o chamador deve 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 apontador para o gestor de animação.

Valor de retorno

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

Observações

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

CAnimationVariable::CreateTransitions

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

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

Parâmetros

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

Valor de retorno

TRUE se as transições forem criadas com sucesso; caso contrário, FALSO.

Observações

Este método é chamado pelo framework quando precisa de criar transições que foram adicionadas à lista interna de transições da variável.

CAnimationVariable::EnableIntegerValueChangedEvent

Ativa ou desativa o evento IntegerValueChanged.

void EnableIntegerValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parâmetros

pController
Um apontamento para o comando principal.

bEnable
TRUE - ativar evento, FALSE - desativar evento.

Observações

Quando o evento ValueChanged está ativado, o framework chama o método virtual CAnimationController::OnAnimationIntegerValueChanged. É necessário sobreescrevê-lo numa classe derivada do CAnimationController para processar este evento. Este método é chamado sempre que o valor inteiro da variável de animação é alterado.

CAnimationVariable::EnableValueChangedEvent

Ativa ou desativa o evento ValueChanged.

void EnableValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parâmetros

pController
Um apontamento para o comando principal.

bEnable
TRUE - ativar evento, FALSE - desativar evento.

Observações

Quando o evento ValueChanged está ativado, o framework chama o método virtual CAnimationController::OnAnimationValueChanged. É necessário sobreescrevê-lo numa classe derivada do CAnimationController para processar este evento. Este método é chamado sempre que o valor da variável de animação é alterado.

CAnimationVariable::GetDefaultValue

Devolve o valor padrão.

DOUBLE GetDefaultValue() const;

Valor de retorno

O valor padrão.

Observações

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

CAnimationVariable::GetParentAnimationObject

Devolve o objeto de animação pai.

CAnimationBaseObject* GetParentAnimationObject();

Valor de retorno

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

Observações

Este método pode ser chamado para recuperar um ponteiro para um objeto de animação pai (um contentor).

CAnimationVariable::GetValue

Devolve o valor atual da variável animação.

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

Parâmetros

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

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

Valor de retorno

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

Observações

Este 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 retorna.

CAnimationVariable::GetVariable

Retorna um ponteiro para o objeto COM da Variável IUIAnimation.

IUIAnimationVariable* GetVariable();

Valor de retorno

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

Observações

Use esta função para aceder ao objeto COM subjacente IUIAnimationVariable e chamar diretamente os seus métodos se necessário.

CAnimationVariable::m_bAutodestroyTransitions

Especifica se os objetos de transição relacionados devem ser eliminados.

BOOL m_bAutodestroyTransitions;

Observações

Defina este valor para TRUE para forçar a eliminação de objetos de transição quando estes estão a ser removidos da lista interna de transições. Se este valor for FALSE, as transições devem ser eliminadas ao chamar a aplicação. A lista de transições é sempre apagada depois de uma animação ter sido agendada. 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 esta variável de animação.

CObList m_lstTransitions;

CAnimationVariable::m_pParentObject

Um apontador para um objeto de animação que encapsula esta variável de animação.

CAnimationBaseObject* m_pParentObject;

CAnimationVariable::m_variable

Armazena um ponteiro para o 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 liberta o objeto COM IUIAnimationVariable.

void SetDefaultValue(DOUBLE dblDefaultValue);

Parâmetros

dblDefaultValue
Especifica o novo valor predefinido.

Observações

Use este método para redefinir o valor padrão. Este método liberta o objeto COM interno IUIAnimationVariable, assim, quando a variável de animação é recriada, o objeto COM subjacente recebe o novo valor predefinido. O valor padrão é devolvido 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 apontador para um objeto de animação que contenha esta variável.

Observações

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

Consulte também

Classes