| SkeletonHelperIsAncestorOrSelf Method |
Determines whether the given bone indices form a valid bone chain.
Namespace: DigitalRune.Animation.CharacterAssembly: DigitalRune.Animation (in DigitalRune.Animation.dll) Version: 1.4.0.0 (1.4.1.14427)
Syntax public static bool IsAncestorOrSelf(
this SkeletonPose skeletonPose,
int ancestorBoneIndex,
int childBoneIndex
)
<ExtensionAttribute>
Public Shared Function IsAncestorOrSelf (
skeletonPose As SkeletonPose,
ancestorBoneIndex As Integer,
childBoneIndex As Integer
) As Boolean
public:
[ExtensionAttribute]
static bool IsAncestorOrSelf(
SkeletonPose^ skeletonPose,
int ancestorBoneIndex,
int childBoneIndex
)
[<ExtensionAttribute>]
static member IsAncestorOrSelf :
skeletonPose : SkeletonPose *
ancestorBoneIndex : int *
childBoneIndex : int -> bool
Parameters
- skeletonPose
- Type: DigitalRune.Animation.CharacterSkeletonPose
The skeleton pose. - ancestorBoneIndex
- Type: SystemInt32
Index of the start bone (root of the chain). Can be -1. - childBoneIndex
- Type: SystemInt32
Index of the end bone (tip of the chain). Must not be -1.
Return Value
Type:
Boolean if bone indices describe a valid chain; otherwise,
.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
SkeletonPose. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
Exceptions Remarks
This method checks it the start bone is an ancestor of the end bone.
See Also