Click or drag to resize

SceneNodeWhereComponentFinderTNode, TComponent Class

Allows various searches over scene graphs. This class can be used directly but will be more commonly used by calling one of the Find extension methods declared in SceneFinderExtensions.
Inheritance Hierarchy
SystemObject
  Fusee.XeneSceneVisitor
    Fusee.XeneSceneFinderBaseTComponent
      Fusee.XeneSceneNodeWhereComponentFinderTNode, TComponent

Namespace:  Fusee.Xene
Assembly:  Fusee.Xene (in Fusee.Xene.dll) Version: 0.7.0.0 (0.7.0.0)
Syntax
C#
public class SceneNodeWhereComponentFinder<TNode, TComponent> : SceneFinderBase<TComponent>, 
	IEnumerator<TNode>, IEnumerator, IDisposable
where TNode : SceneNodeContainer
where TComponent : SceneComponentContainer

Type Parameters

TNode
The type of the node.
TComponent
The concrete type of the components to look for.

The SceneNodeWhereComponentFinderTNode, TComponent type exposes the following members.

Constructors
  NameDescription
Public methodSceneNodeWhereComponentFinderTNode, TComponent
Initializes a new instance of the SceneNodeWhereComponentFinderTNode, TComponent class.
Top
Properties
  NameDescription
Public propertyCurrent
Gets the element in the collection at the current position of the enumerator.
Protected propertyCurrentComponent
Returns the currently visited component during a traversal.
(Inherited from SceneVisitor.)
Protected propertyCurrentNode
Returns currently visited node during a traversal.
(Inherited from SceneVisitor.)
Protected propertyYieldEnumeration
Gets a value indicating whether the current enumeration should yield.
(Inherited from SceneVisitor.)
Protected propertyYieldOnCurrentComponent
Can be called in derived visitors. Set this property to true during traversals to make the visitor yield the current component when used as an enumerator.
(Inherited from SceneVisitor.)
Protected propertyYieldOnCurrentNode
Can be called in derived visitors. Set this property to true during traversals to make the visitor yield the current node when used as an enumerator.
(Inherited from SceneVisitor.)
Top
Methods
  NameDescription
Public methodDispose
Releases unmanaged and - optionally - managed resources.
(Inherited from SceneFinderBaseTSceneElementType.)
Protected methodEnumInit
Enumerator Building Block to be called in derived Visitors acting as enumerators. Use this to initialize the traversing enumeration on a list of (root) nodes.
(Inherited from SceneVisitor.)
Protected methodEnumMoveNext
This method implements a re-entrant (in terms of yield, not multi-threading) non-recursive traversal over combined node and component trees. Call this method in derived classes implementing enumerators, like in the various find extension methods or the ViseratorTItem, TState
(Inherited from SceneVisitor.)
Protected methodEnumMoveNextNoComponent
Continue a currently active enumeration. Call all registered Visit methods. Visitor methods may set YieldOnCurrentComponent or YieldOnCurrentNode to true to signal the enumration to yield.
(Inherited from SceneVisitor.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInitState
Method is called when traversal starts to initialize the traversal state. Override this method in derived classes to initialize any state.
(Inherited from SceneVisitor.)
Protected methodMatchComponent
Reflected Viserator Callback. Performs the match test on the specified component.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMoveNext
Advances the enumerator to the next element of the collection.
Protected methodPopState
Method is called when going up one hierarchy level while traversing. Override this method to perform pop on any self-defined state.
(Inherited from SceneVisitor.)
Protected methodPushState
Method is called when going down one hierarchy level while traversing. Override this method to push any self-defined state.
(Inherited from SceneVisitor.)
Public methodReset
Resets this instance.
(Inherited from SceneFinderBaseTSceneElementType.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTraverse(SceneNodeContainer)
Start traversing a scene graph starting with the given root node. Performs a recursive depth-first traversal from the speciefiedd root.
(Inherited from SceneVisitor.)
Public methodTraverse(IEnumerableSceneNodeContainer)
Start traversing a list of nodes. Performs a recursive depth-first traversal over the list starting with the first node in the list.
(Inherited from SceneVisitor.)
Top
Fields
Remarks
Search criteria can be passed as (lambda) predicates matching scene nodes. Results are returned as enumerator. Instead of directly using this class, users should use one of the FindNodes or FindComponents extension methods.
See Also