CustomOperatorContext Class
Gives an ICustomOperator instance access to its proxy object.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Thread safety: Members defined in this class are not thread-safe. Show
Syntax
public class CustomOperatorContext : EngineObjectRemarks
An instance of this class is passed to a custom operator in the ICustomOperator.InitNew call. It gives the operator access to some properties of the proxy object, and is used for getting features and visualizer from the input operators of the proxy, and for passing these on to the next operator in the operator chain during an update cycle.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
CustomOperatorContext
Platforms
Windows, Linux, Android
CustomOperatorContext Members
The CustomOperatorContext type has the following members.
Properties
| Name | Description |
|---|---|
| ConfigurationPath | Gets the directory the configuration file was loaded from. |
| Inputs | Gets the list of input operators from the proxy. |
| IsDisposed | Gets a value that tells whether the current CustomOperatorContext has been disposed. Inherited from EngineObject |
| IsThreadSafe | Gets the thread-safe value set on the proxy that loaded the custom operator. |
| LibraryPath | Gets the directory the custom object was loaded from. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current CustomOperatorContext represents. Inherited from EngineObject |
| UserProperties | Gets the user-defined properties from the proxy. |
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 |
| GetFeature | Gets the current feature just read from an input operator. |
| GetFeatureHoverVisualizers | Gets the list of hover visualizers attached to the current feature. |
| GetFeatureSelectionVisualizers | Gets the list of selection visualizers attached to the current feature. |
| GetFeatureVisualizers | Gets the list of normal visualizers attached to the current feature. |
| PrepareAllInputs | Overloaded. Prepares all input operators. |
| PrepareInput | Overloaded. Prepares a single input operator. |
| ReadNext | Reads the next feature from any input operator. |
| ReadNextFromInput | Reads the next feature from a single operator. |
| SetFeature | Set the next feature to be passed to the next operator in the operator chain. |