FeatureInteraction Class
Represents interaction information related to a Feature.
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 FeatureInteraction : EngineObjectRemarks
A FeatureInteraction is defined by a readonly feature Id and holds a number of editable interaction flags. When available, it also holds references to the corresponding PresentationObjects.
A FeatureInteractionCollection is used in InteractingEventArgs to communicate application specific interaction logic to a more general tool. The StandardTool.Interacting event is an example of this.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
FeatureInteraction
Platforms
Windows, Linux, Android
FeatureInteraction Members
The FeatureInteraction type has the following members.
Properties
| Name | Description |
|---|---|
| AllowAddNode | Gets or sets the add node flag, indicating whether a new node may be added to the feature. |
| AllowHover | Gets or sets the hover flag, indicating whether the feature can be hovered. |
| AllowMove | Gets or sets the move flag, indicating whether the feature can be moved. |
| AllowMoveNode | Gets or sets the move node flag, indicating whether individual nodes of the feature can be moved. |
| AllowRemoveNode | Gets or sets the remove node flag, indicating whether a node may be deleted from the feature. |
| AllowSelect | Gets or sets the select flag, indicating whether the feature can be selected. |
| Id | Gets the identity of the feature. |
| IsDisposed | Gets a value that tells whether the current FeatureInteraction has been disposed. Inherited from EngineObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current FeatureInteraction represents. Inherited from EngineObject |
| PresentationObjects | Gets the list of PresentationObjects representing the feature, may be empty. |
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 |