CAnimationVariable (clase)

Representa una variable de animación.

Sintaxis

class CAnimationVariable;

Miembros

Constructores públicos

Nombre	Descripción
CAnimationVariable::CAnimationVariable	Construye un objeto de variable de animación.
CAnimationVariable::~CAnimationVariable	El destructor . Se lo llama al destruir un objeto CAnimationVariable.

Métodos públicos

Nombre	Descripción
CAnimationVariable::AddTransition	Agrega una transición.
CAnimationVariable::ApplyTransitions	Agrega transiciones de la lista interna al guión gráfico.
CAnimationVariable::ClearTransitions	Borra las transiciones.
CAnimationVariable::Create	Crea el objeto COM de la variable de animación subyacente.
CAnimationVariable::CreateTransitions	Crea todas las transiciones que se van a aplicar a esta variable de animación.
CAnimationVariable::EnableIntegerValueChangedEvent	Habilita o deshabilita el evento IntegerValueChanged.
CAnimationVariable::EnableValueChangedEvent	Habilita o deshabilita el evento ValueChanged.
CAnimationVariable::GetDefaultValue	Devuelve el valor predeterminado.
CAnimationVariable::GetParentAnimationObject	Devuelve el objeto de animación primario.
CAnimationVariable::GetValue	Con sobrecarga. Devuelve el valor actual de la variable de animación.
CAnimationVariable::GetVariable	Devuelve un puntero al objeto COM IUIAnimationVariable.
CAnimationVariable::SetDefaultValue	Establece el valor predeterminado y libera el objeto COM IUIAnimationVariable.

Métodos protegidos

Nombre	Descripción
CAnimationVariable::SetParentAnimationObject	Establece la relación entre una variable de animación y un objeto de animación.

Miembros de datos públicos

Nombre	Descripción
CAnimationVariable::m_bAutodestroyTransitions	Especifica si se deben eliminar objetos de transición relacionados.

Miembros de datos protegidos

Nombre	Descripción
CAnimationVariable::m_dblDefaultValue	Especifica el valor predeterminado, que se propaga a IUIAnimationVariable.
CAnimationVariable::m_lstTransitions	Contiene una lista de transiciones que animan esta variable de animación.
CAnimationVariable::m_pParentObject	Puntero a un objeto de animación que encapsula esta variable de animación.
CAnimationVariable::m_variable	Almacena un puntero al objeto COM IUIAnimationVariable. NULL si todavía no se crea el objeto COM o si se produjo un error al crearlo.

Comentarios

La clase CAnimationVariable encapsula el objeto COM IUIAnimationVariable. También contiene una lista de transiciones que se van a aplicar a la variable de animación en un guión gráfico. Los objetos CAnimationVariable se insertan en objetos de animación, que pueden representar en una aplicación un rectángulo, color, tamaño, punto y valor animado.

Jerarquía de herencia

CAnimationVariable

Requisitos

Encabezado: afxanimationcontroller.h

CAnimationVariable::~CAnimationVariable

El destructor . Se lo llama al destruir un objeto CAnimationVariable.

virtual ~CAnimationVariable();

CAnimationVariable::AddTransition

Agrega una transición.

void AddTransition(CBaseTransition* pTransition);

Parámetros

pTransition
Puntero a la transición que se va a agregar.

Comentarios

Se llama a este método para agregar una transición a la lista interna de transiciones que se van a aplicar a la variable de animación. Se debe borrar esta lista cuando se ha programado una animación.

CAnimationVariable::ApplyTransitions

Agrega transiciones de la lista interna al guión gráfico.

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

Parámetros

pController
Puntero al controlador de animación primario.

pStoryboard
Puntero a un guion gráfico.

bDependOnKeyframes
TRUE si este método debe agregar transiciones que dependen de fotogramas clave.

Comentarios

Al usar este método, se agregan transiciones de la lista interna al guión gráfico. Se lo llama varias veces desde el código de nivel superior para agregar transiciones que no dependen de fotogramas clave y agregar transiciones que sí depende de este tipo de fotogramas. Si no se ha creado el objeto COM de la variable de animación subyacente, este método lo crea en esta fase.

CAnimationVariable::CAnimationVariable

Construye un objeto de variable de animación.

CAnimationVariable(DOUBLE dblDefaultValue = 0.0);

Parámetros

dblDefaultValue
Especifica el valor predeterminado.

Comentarios

Construye un objeto de variable de animación y establece su valor predeterminado. Se usa un valor predeterminado cuando una variable no es animada o no puede serlo.

CAnimationVariable::ClearTransitions

Borra las transiciones.

void ClearTransitions(BOOL bAutodestroy);

Parámetros

bAutodestroy
Especifica si este método debe eliminar objetos de transición.

Comentarios

Este método quita todas las transiciones de la lista interna de transiciones. Si bAutodestroy es TRUE o m_bAutodestroyTransitions es TRUE, se eliminan las transiciones. De lo contrario, el autor de llamada debe desasignar los objetos de transición.

CAnimationVariable::Create

Crea el objeto COM de la variable de animación subyacente.

virtual BOOL Create(IUIAnimationManager* pManager);

Parámetros

pManager
Puntero al administrador de animaciones.

Valor devuelto

TRUE si la variable de animación se creó correctamente; de lo contrario, FALSE.

Comentarios

Este método crea el objeto COM de la variable de animación subyacente y establece su valor predeterminado.

CAnimationVariable::CreateTransitions

Crea todas las transiciones que se van a aplicar a esta variable de animación.

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

Parámetros

pLibrary
Puntero a una interfaz IUIAnimationTransitionLibrary, que define una biblioteca de transiciones estándar.

Valor devuelto

TRUE si la transición se creó correctamente; de lo contrario, FALSE.

Comentarios

El marco llama a este método cuando necesita crear transiciones que se agregaron a la lista interna de transiciones de la variable.

CAnimationVariable::EnableIntegerValueChangedEvent

Habilita o deshabilita el evento IntegerValueChanged.

void EnableIntegerValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parámetros

pController
Puntero al controlador primario.

bEnable
TRUE: habilitar evento, FALSE: deshabilitar evento.

Comentarios

Cuando se habilita el evento ValueChanged, el marco llama al método virtual CAnimationController::OnAnimationIntegerValueChanged. Debe invalidarlo en una clase derivada de CAnimationController para procesar este evento. Se llama a este método cada vez que se modifica el valor entero de la variable de animación.

CAnimationVariable::EnableValueChangedEvent

Habilita o deshabilita el evento ValueChanged.

void EnableValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parámetros

pController
Puntero al controlador primario.

bEnable
TRUE: habilitar evento, FALSE: deshabilitar evento.

Comentarios

Cuando se habilita el evento ValueChanged, el marco llama al método virtual CAnimationController::OnAnimationValueChanged. Debe invalidarlo en una clase derivada de CAnimationController para procesar este evento. Se llama a este método cada vez que se modifica el valor de la variable de animación.

CAnimationVariable::GetDefaultValue

Devuelve el valor predeterminado.

DOUBLE GetDefaultValue() const;

Valor devuelto

El valor predeterminado.

Comentarios

Use esta función para obtener el valor predeterminado de la variable de animación. El valor predeterminado se puede establecer en el constructor o mediante el método SetDefaultValue.

CAnimationVariable::GetParentAnimationObject

Devuelve el objeto de animación primario.

CAnimationBaseObject* GetParentAnimationObject();

Valor devuelto

Puntero al objeto de animación primario, si se estableció la relación; de lo contrario, NULL.

Comentarios

Se puede llamar a este método para recuperar un puntero a un objeto de animación primario (un contenedor).

CAnimationVariable::GetValue

Devuelve el valor actual de la variable de animación.

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

Parámetros

dblValue
Valor actual de la variable de animación.

nValue
Valor actual de la variable de animación.

Valor devuelto

S_OK si el valor se obtuvo correctamente o no se ha creado la variable de animación subyacente. De lo contrario, el código de error HRESULT.

Comentarios

Se puede llamar a este método para recuperar el valor actual de la variable de animación. Si no se ha creado el objeto COM subyacente, dblValue contendrá un valor predeterminado cuando la función devuelva un resultado.

CAnimationVariable::GetVariable

Devuelve un puntero al objeto COM IUIAnimationVariable.

IUIAnimationVariable* GetVariable();

Valor devuelto

Puntero válido al objeto COM IUIAnimationVariable, o bien NULL si la variable de animación no se creó o no se puede crear.

Comentarios

Utilice esta función para acceder al objeto COM IUIAnimationVariable subyacente y llame a sus métodos directamente si es necesario.

CAnimationVariable::m_bAutodestroyTransitions

Especifica si se deben eliminar objetos de transición relacionados.

BOOL m_bAutodestroyTransitions;

Comentarios

Establezca este valor en TRUE para forzar la eliminación de objetos de transición cuando se quitan de la lista interna de transiciones. Si este valor es FALSE, las transiciones se deben eliminar mediante una llamada a la aplicación. La lista de transiciones siempre se borra una vez que se programa una animación. El valor predeterminado es FALSE.

CAnimationVariable::m_dblDefaultValue

Especifica el valor predeterminado, que se propaga a IUIAnimationVariable.

DOUBLE m_dblDefaultValue;

CAnimationVariable::m_lstTransitions

Contiene una lista de transiciones que animan esta variable de animación.

CObList m_lstTransitions;

CAnimationVariable::m_pParentObject

Puntero a un objeto de animación que encapsula esta variable de animación.

CAnimationBaseObject* m_pParentObject;

CAnimationVariable::m_variable

Almacena un puntero al objeto COM IUIAnimationVariable. NULL si todavía no se crea el objeto COM o si se produjo un error al crearlo.

ATL::CComPtr<IUIAnimationVariable> m_variable;

CAnimationVariable::SetDefaultValue

Establece el valor predeterminado y libera el objeto COM IUIAnimationVariable.

void SetDefaultValue(DOUBLE dblDefaultValue);

Parámetros

dblDefaultValue
Especifica el valor predeterminado nuevo.

Comentarios

Use este método para restablecer el valor predeterminado. Este método libera el objeto COM IUIAnimationVariable interno, por lo que, cuando se vuelve a crear la variable de animación, el objeto COM subyacente obtiene el valor predeterminado nuevo. GetValue devuelve el valor predeterminado si no se ha creado el objeto COM que representa la variable de animación o si la variable no se ha animado.

CAnimationVariable::SetParentAnimationObject

Establece la relación entre una variable de animación y un objeto de animación.

void SetParentAnimationObject(CAnimationBaseObject* pParentObject);

Parámetros

pParentObject
Puntero a un objeto de animación que contiene esta variable.

Comentarios

Este método se llama de manera interna para establecer una relación uno a uno entre una variable de animación y un objeto de animación que lo encapsula.

Consulte también

Clases