SkeletonKeyFrameAnimation.GetWeight Method

SkeletonKeyFrameAnimationGetWeight Method

Gets the weight for a specific bone animation channel.

Namespace: DigitalRune.Animation.Character
Assembly: DigitalRune.Animation (in DigitalRune.Animation.dll) Version: 1.4.0.0 (1.4.1.14427)

Syntax

C++

Copy

public float GetWeight(
	int boneIndex
)

Public Function GetWeight ( 
	boneIndex As Integer
) As Single

public:
float GetWeight(
	int boneIndex
)

member GetWeight : 
        boneIndex : int -> float32

Parameters

boneIndex: Type: SystemInt32
The index of the bone.

Return Value

Type: Single
The weight. A value of 0 means that the channel is disabled. A value of 1 means that the channel is fully enabled. If the value is less than 1, then animation of the bone is mixed with preceding animations. If the animation does contain a bone animation channel for the given bone then 1 (default value) is returned.

Remarks

Call IsBoneAnimated(Int32) to check whether this animation contains a bone animation channel for the specified bone.

Reference

SkeletonKeyFrameAnimation Class

DigitalRune.Animation.Character Namespace