AnimationHelper.GetSubtree Method (AnimationInstance, Boolean)

AnimationHelperGetSubtree Method (AnimationInstance, Boolean)

Gets the subtree (the given AnimationInstance and all of its descendants in the animation tree) using either a depth-first or a breadth-first search.

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

Syntax

C++

Copy

public static IEnumerable<AnimationInstance> GetSubtree(
	this AnimationInstance animationInstance,
	bool depthFirst
)

<ExtensionAttribute>
Public Shared Function GetSubtree ( 
	animationInstance As AnimationInstance,
	depthFirst As Boolean
) As IEnumerable(Of AnimationInstance)

public:
[ExtensionAttribute]
static IEnumerable<AnimationInstance^>^ GetSubtree(
	AnimationInstance^ animationInstance, 
	bool depthFirst
)

[<ExtensionAttribute>]
static member GetSubtree : 
        animationInstance : AnimationInstance * 
        depthFirst : bool -> IEnumerable<AnimationInstance>

Parameters

animationInstance: Type: DigitalRune.AnimationAnimationInstance
The animation instance where to start the search.
depthFirst: Type: SystemBoolean
If set to then a depth-first search for descendants will be made; otherwise a breadth-first search will be made.

Return Value

Type: IEnumerableAnimationInstance
The animationInstance and all of its descendants in the animation tree.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type AnimationInstance. 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

Exception	Condition
ArgumentNullException	animationInstance is .

Reference

AnimationHelper Class

GetSubtree Overload

DigitalRune.Animation Namespace