KeyframedAnimationSet Class (Microsoft.DirectX.Direct3D)

Article
06/30/2006

Implements a keyframe animation set.

Definition

Visual Basic NotInheritable Public Class KeyframedAnimationSet
Inherits AnimationSet

C# public sealed class KeyframedAnimationSet : AnimationSet

C++ public ref class KeyframedAnimationSet sealed : AnimationSet

JScript public final class KeyframedAnimationSet extends AnimationSet

Members Table

The following table lists the members exposed by the object.

Events

Event Description

Disposing Occurs when the Dispose method is called or when the KeyframedAnimationSet object is finalized and collected by the garbage collector of the .NET common language runtime.

Methods

Method Description

Compress Transforms animations in an animation set into a compressed format and returns the compressed data.

Dispose Immediately releases the unmanaged resources used by the KeyframedAnimationSet object.

Equals Returns a value that indicates whether the current instance is equal to a specified object.

Finalize Allows the KeyframedAnimationSet object to free resources before it is destroyed by the garbage collector.

GetAnimationIndex Retrieves the index of an animation, given its name. Inherited from AnimationSet.

GetAnimationName Retrieves the name of an animation, given its index. Inherited from AnimationSet.

GetCallback Retrieves information about a specific callback in an animation set. Inherited from AnimationSet.

GetCallbackKey Retrieves information about a specific callback in the animation set.

GetCallbackKeys Fills an array with callback key data used for keyframe animation.

GetHashCode Returns the hash code for the current instance.

GetNumberRotationKeys Retrieves the number of rotation keys in the specified keyframe animation.

GetNumberScaleKeys Retrieves the number of scale keys in the specified keyframe animation.

GetNumberTranslationKeys Retrieves the number of translation keys in the specified keyframe animation.

GetObjectByValue This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code.

GetPeriodicPosition Returns the time position in the local timeframe of an animation set. Inherited from AnimationSet.

GetRotationKey Retrieves rotation information for a specific key frame in the animation set.

GetRotationKeys Fills an array with rotational key data used for keyframe animation.

GetScaleKey Retrieves scale information for a specific key frame in the animation set.

GetScaleKeys Fills an array with scale key data used for keyframe animation.

GetScaleRotateTranslate Retrieves the scale, rotate, and translate (SRT) values of an animation set. Inherited from AnimationSet.

GetTranslationKey Retrieves translation information for a specific key frame in the animation set.

GetTranslationKeys Fills an array with translational key data used for keyframe animation.

KeyframedAnimationSet Creates a KeyframedAnimationSet.

op_Equality Compares the current instance of a class to another instance to determine whether they are the same. Inherited from AnimationSet.

op_Equality Compares the current instance of a class to another instance to determine whether they are the same.

op_Inequality Compares the current instance of a class to another instance to determine whether they are different. Inherited from AnimationSet.

op_Inequality Compares the current instance of a class to another instance to determine whether they are different.

raise_Disposing Raises the Microsoft.DirectX.Direct3D.KeyframedAnimationSet.Disposing event when called from within a derived class.

RegisterAnimationKeys Registers all of the scale, rotate, and translate (SRT) keyframe data of an animation, and fills arrays with SRT key data used for keyframe animation.

SetCallbackKey Sets information about a specific callback in the animation set.

SetRotationKey Sets rotation information for a specific key frame in the animation set.

SetScaleKey Sets scale information for a specific key frame in the animation set.

SetTranslationKey Sets translation information for a specific key frame in the animation set.

UnregisterAnimation Removes the animation data from the animation set.

UnregisterRotationKey Removes the rotation data at the specified key frame.

UnregisterScaleKey Removes the scale data at the specified key frame.

UnregisterTranslationKey Removes the translation data at the specified key frame.

UpdateUnmanagedPointer Updates the unmanaged pointer for this AnimationSet object. This method supports the .NET Framework Infrastructure and is not intended to be used directly in your code. Inherited from AnimationSet.

UpdateUnmanagedPointer Updates the unmanaged pointer for this KeyframedAnimationSet object. This method supports the Microsoft .NET Framework infrastructure and is not intended to be used directly in your code.

Properties

Property Description

Disposed Gets a value that indicates whether the object is disposed.

Name Retrieves the name of an animation set. Inherited from AnimationSet.

NumberAnimations Retrieves a value that indicates the number of animations in the animation set. Inherited from AnimationSet.

NumberCallbackKeys Retrieves the number of callback keys in an animation set.

Period Retrieves the period of an animation set. Inherited from AnimationSet.

PlaybackType Retrieves the type of the animation set playback loop.

SourceTicksPerSecond Retrieves the number of animation keyframe ticks that occur per second.

UnmanagedComPointer Returns the unmanaged Component Object Model (COM) ID3DXKeyframedAnimationSet interface pointer.

UnmanagedComPointer Returns the unmanaged COM ID3DXAnimationSet interface pointer. Inherited from AnimationSet.

Event	Description
Disposing	Occurs when the Dispose method is called or when the KeyframedAnimationSet object is finalized and collected by the garbage collector of the .NET common language runtime.

Method	Description
Compress	Transforms animations in an animation set into a compressed format and returns the compressed data.
Dispose	Immediately releases the unmanaged resources used by the KeyframedAnimationSet object.
Equals	Returns a value that indicates whether the current instance is equal to a specified object.
Finalize	Allows the KeyframedAnimationSet object to free resources before it is destroyed by the garbage collector.
GetAnimationIndex	Retrieves the index of an animation, given its name. Inherited from AnimationSet.
GetAnimationName	Retrieves the name of an animation, given its index. Inherited from AnimationSet.
GetCallback	Retrieves information about a specific callback in an animation set. Inherited from AnimationSet.
GetCallbackKey	Retrieves information about a specific callback in the animation set.
GetCallbackKeys	Fills an array with callback key data used for keyframe animation.
GetHashCode	Returns the hash code for the current instance.
GetNumberRotationKeys	Retrieves the number of rotation keys in the specified keyframe animation.
GetNumberScaleKeys	Retrieves the number of scale keys in the specified keyframe animation.
GetNumberTranslationKeys	Retrieves the number of translation keys in the specified keyframe animation.
GetObjectByValue	This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code.
GetPeriodicPosition	Returns the time position in the local timeframe of an animation set. Inherited from AnimationSet.
GetRotationKey	Retrieves rotation information for a specific key frame in the animation set.
GetRotationKeys	Fills an array with rotational key data used for keyframe animation.
GetScaleKey	Retrieves scale information for a specific key frame in the animation set.
GetScaleKeys	Fills an array with scale key data used for keyframe animation.
GetScaleRotateTranslate	Retrieves the scale, rotate, and translate (SRT) values of an animation set. Inherited from AnimationSet.
GetTranslationKey	Retrieves translation information for a specific key frame in the animation set.
GetTranslationKeys	Fills an array with translational key data used for keyframe animation.
KeyframedAnimationSet	Creates a KeyframedAnimationSet.
op_Equality	Compares the current instance of a class to another instance to determine whether they are the same. Inherited from AnimationSet.
op_Equality	Compares the current instance of a class to another instance to determine whether they are the same.
op_Inequality	Compares the current instance of a class to another instance to determine whether they are different. Inherited from AnimationSet.
op_Inequality	Compares the current instance of a class to another instance to determine whether they are different.
raise_Disposing	Raises the Microsoft.DirectX.Direct3D.KeyframedAnimationSet.Disposing event when called from within a derived class.
RegisterAnimationKeys	Registers all of the scale, rotate, and translate (SRT) keyframe data of an animation, and fills arrays with SRT key data used for keyframe animation.
SetCallbackKey	Sets information about a specific callback in the animation set.
SetRotationKey	Sets rotation information for a specific key frame in the animation set.
SetScaleKey	Sets scale information for a specific key frame in the animation set.
SetTranslationKey	Sets translation information for a specific key frame in the animation set.
UnregisterAnimation	Removes the animation data from the animation set.
UnregisterRotationKey	Removes the rotation data at the specified key frame.
UnregisterScaleKey	Removes the scale data at the specified key frame.
UnregisterTranslationKey	Removes the translation data at the specified key frame.
UpdateUnmanagedPointer	Updates the unmanaged pointer for this AnimationSet object. This method supports the .NET Framework Infrastructure and is not intended to be used directly in your code. Inherited from AnimationSet.
UpdateUnmanagedPointer	Updates the unmanaged pointer for this KeyframedAnimationSet object. This method supports the Microsoft .NET Framework infrastructure and is not intended to be used directly in your code.

Property	Description
Disposed	Gets a value that indicates whether the object is disposed.
Name	Retrieves the name of an animation set. Inherited from AnimationSet.
NumberAnimations	Retrieves a value that indicates the number of animations in the animation set. Inherited from AnimationSet.
NumberCallbackKeys	Retrieves the number of callback keys in an animation set.
Period	Retrieves the period of an animation set. Inherited from AnimationSet.
PlaybackType	Retrieves the type of the animation set playback loop.
SourceTicksPerSecond	Retrieves the number of animation keyframe ticks that occur per second.
UnmanagedComPointer	Returns the unmanaged Component Object Model (COM) ID3DXKeyframedAnimationSet interface pointer.
UnmanagedComPointer	Returns the unmanaged COM ID3DXAnimationSet interface pointer. Inherited from AnimationSet.

Inheritance Hierarchy

Object

AnimationSet

KeyframedAnimationSet

Remarks

A KeyframedAnimationSet is a class that encapsulates a set of rotation, translation, and scale data over time. Typically, this class is used to manipulate a set of animations that represent the actions of a character, such as walking, running, or sitting. Multiple KeyframedAnimationSet classes can run animations in different tracks of an AnimationController class, which can blend the animations together to create a single seamless animation.

Class Information

Namespace Microsoft.DirectX.Direct3D

Assembly Microsoft.DirectX.Direct3DX (microsoft.directx.direct3dx.dll)

Strong Name Microsoft.DirectX.Direct3DX, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Visual Basic	NotInheritable Public Class KeyframedAnimationSet Inherits AnimationSet
C#	public sealed class KeyframedAnimationSet : AnimationSet
C++	public ref class KeyframedAnimationSet sealed : AnimationSet
JScript	public final class KeyframedAnimationSet extends AnimationSet

Namespace	Microsoft.DirectX.Direct3D
Assembly	Microsoft.DirectX.Direct3DX (microsoft.directx.direct3dx.dll)
Strong Name	Microsoft.DirectX.Direct3DX, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

KeyframedAnimationSet Class (Microsoft.DirectX.Direct3D)

Additional resources