AnimationController.KeyTrackWeight Method

Language:

Sets an event key that changes the weight of an animation track.

Definition

Visual Basic Public Function KeyTrackWeight( _
    ByVal track As Integer, _
    ByVal newWeight As Single, _
    ByVal startTime As Double, _
    ByVal duration As Double, _
    ByVal method As TransitionType _
) As Integer

C# public int KeyTrackWeight(
    int track,
    float newWeight,
    double startTime,
    double duration,
    TransitionType method
);

C++ public:
int KeyTrackWeight(
    int track,
    float newWeight,
    double startTime,
    double duration,
    TransitionType method
);

JScript public function KeyTrackWeight(
    track : int,
    newWeight : float,
    startTime : double,
    duration : double,
    method : TransitionType
) : int;

Visual Basic	Public Function KeyTrackWeight( _ ByVal track As Integer, _ ByVal newWeight As Single, _ ByVal startTime As Double, _ ByVal duration As Double, _ ByVal method As TransitionType _ ) As Integer
C#	public int KeyTrackWeight( int track, float newWeight, double startTime, double duration, TransitionType method );
C++	public: int KeyTrackWeight( int track, float newWeight, double startTime, double duration, TransitionType method );
JScript	public function KeyTrackWeight( track : int, newWeight : float, startTime : double, duration : double, method : TransitionType ) : int;

Parameters

track System.Int32
Identifier of the track to modify.

newWeight System.Single
New weight of the track.

startTime System.Double
Global time key that specifies the global time at which the change will occur.

duration System.Double
Transition time, which specifies how long the smooth transition will take to complete.

method Microsoft.DirectX.Direct3D.TransitionType
Transition type used for transitioning between weights. For more information, see TransitionType.

Return Value

System.Int32
Event handle to the priority blend event. If one or more of the input parameters is invalid, or if no free event is available, a value of 0 is returned.

Remarks

The weight of an animation track is used as a multiplier to determine how much of the current track to blend with other tracks.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center

track	System.Int32 Identifier of the track to modify.
newWeight	System.Single New weight of the track.
startTime	System.Double Global time key that specifies the global time at which the change will occur.
duration	System.Double Transition time, which specifies how long the smooth transition will take to complete.
method	Microsoft.DirectX.Direct3D.TransitionType Transition type used for transitioning between weights. For more information, see TransitionType.