Class ViseratorExtensions

Contains extensions methods to perform Viserator<TItem, TState, TNode, TComponent> actions on trees of scene nodes.

Inheritance

System.Object

ViseratorExtensions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Fusee.Xene

Assembly: Fusee.Xene.dll

Syntax

public static class ViseratorExtensions

Methods

Viserate<TViserator, TResult, TNode, TComponent>(TNode)

Performs a Viserator<TItem, TState, TNode, TComponent> action on the specified tree.

Declaration

public static IEnumerable<TResult> Viserate<TViserator, TResult, TNode, TComponent>(this TNode root)
    where TViserator : ViseratorBase<TResult, TNode, TComponent>, new()
    where TNode : class, INode where TComponent : class, IComponent

Parameters

Type	Name	Description
TNode	root	The root where to start the traversal.

Returns

Type	Description
System.Collections.Generic.IEnumerable<TResult>	All items yielded from within the traversal (YieldItem(TItem)).

Type Parameters

Name	Description
TViserator	The type of the viserator.
TResult	The type of the elements resulting from the Viserate traversal.
TNode	The root type of nodes the tree (given by root) is built from.
TComponent	The root type of components used in the given tree.

Viserate<TViserator, TResult, TNode, TComponent>(IEnumerable<TNode>)

Performs a Viserator<TItem, TState, TNode, TComponent> action on the specified list of trees.

Declaration

public static IEnumerable<TResult> Viserate<TViserator, TResult, TNode, TComponent>(this IEnumerable<TNode> rootList)
    where TViserator : ViseratorBase<TResult, TNode, TComponent>, new()
    where TNode : class, INode where TComponent : class, IComponent

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TNode>	rootList	The list of root items where to start the traversal with.

Returns

Type	Description
System.Collections.Generic.IEnumerable<TResult>	All items yielded from within the traversal (see YieldItem(TItem)).

Type Parameters

Name	Description
TViserator	The type of the viserator.
TResult	The type of the elements resulting from the Viserate traversal.
TNode	The root type of nodes the tree (given by root) is built from.
TComponent	The root type of components used in the given tree.