FeatureEnumerator Class
Represents an object used to iterate over a collection of Feature elements.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this type are, in general, not thread-safe.
Syntax
public class FeatureEnumerator : EngineObjectRemarks
A FeatureEnumerator is initially positioned before the first element in the collection and you must call MoveNext to advance the enumerator to the first element before you can retrieve it through the Current property.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
FeatureEnumerator
Platforms
Windows, Linux, Android
FeatureEnumerator Members
The FeatureEnumerator type has the following members.
Properties
| Name | Description |
|---|---|
| Current | Gets the Feature at the current position in the collection. |
| CurrentHoverVisualizers | Gets a collection that contains all hover Visualizer elements associated with the Feature at the current position in the collection. |
| CurrentSelectionVisualizers | Gets a collection that contains all selection Visualizer elements associated with the Feature at the current position in the collection. |
| CurrentVisualizers | Gets a collection that contains all ordinary Visualizer elements associated with the Feature at the current position in the collection. |
| IsDisposed | Gets a value that tells whether the current FeatureEnumerator has been disposed. Inherited from EngineObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current FeatureEnumerator represents. Inherited from EngineObject |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| MoveNext | Advances the FeatureEnumerator to the next element in the collection. |
| Reset | Resets the FeatureEnumerator to its initial position, one before the first element in the collection. |