CustomObjects Module
The CustomObjects module provides functionality for extending Carmenta Engine with user-written operators, datasets and more.
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)
Classes
| Class | Description |
|---|---|
| CustomDataSetAdapter | Adapter class that can be used as a base-class to simplify the implementation of a custom dataset. |
| CustomDataSetContext | Gives an ICustomDataSet instance access to its proxy object. |
| CustomDataSetProxy | A proxy for a custom dataset in map configurations. |
| CustomDataSetResult | Result class returned by Query or CustomDataSetAdapter.OnQuery implementations. |
| CustomOperatorAdapter | Adapter class that can be used as a base-class to simplify the implementation of a custom operator. |
| CustomOperatorContext | Gives an ICustomOperator instance access to its proxy object. |
| CustomOperatorProxy | A proxy for a custom operator in map configurations. |
| CustomOperatorResult | Result class returned by CustomOperatorAdapter.OnProcess implementations. |
| CustomPropagationContext | Gives an ICustomPropagation instance access to its proxy object. |
| CustomPropagationProxy | A proxy for a custom propagation in map configurations, representing a non-standard propagation model for line-of-sight, or for radio propagation etc. |
| CustomSymbolContext | Gives an ICustomSymbol or ICustomNativeSymbol instance access to its proxy object. |
| CustomSymbolProxy | A proxy for a custom symbol in map configurations. |
| CustomVisualizerContext | Gives an ICustomVisualizer or ICustomNativeVisualizer instance access to its proxy object. |
| CustomVisualizerProxy | A proxy for a custom visualizer in map configurations. |
| ScriptOperator | An operator that process features with source code specified in a property. |
| ViewInfo | Holds information about a view and drawable during an update cycle. |
Interfaces
| Interface | Description |
|---|---|
| ICustomDataSet | Interface for a custom dataset. |
| ICustomDataSetInfoProvider | An interface that may be implemented by a custom dataset to customize its DataSetInfo. |
| ICustomNativeSymbol | Interface for a custom symbol using native drawing. |
| ICustomNativeVisualizer | Interface for a custom visualizer using native drawing. |
| ICustomOperator | Interface for a custom operator. |
| ICustomPropagation | Interface for a custom propagation model that can be used by an instance of LineOfSightOperator or one of its derived classes. |
| ICustomRasterDataSet | An interface that should be implemented by custom datasets that returns raster features. |
| ICustomSearchableDataSet | An interface that can be implemented by custom datasets that want to provide ISearchable functionality through the CustomDataSetProxy class. |
| ICustomSymbol | Interface for a custom symbol. |
| ICustomSymbolHitTest | An interface for hit-testing of custom symbols. |
| ICustomVisualizer | Interface for a custom visualizer. |
| ICustomVisualizerHitTest | An interface for hit-testing of custom visualizers. |
| IMinimizeGarbageCollection | Indicates that Carmenta Engine should clean up temporary objects passed to and returned by a .NET or Java custom object. |
| IQueryResult | An interface for the result of a query to a custom dataset. |
| ISupportsDynamicCaching | Indicates that a custom dataset can be used in a layer with dynamic caching. |
Structures
Delegates
Enumerations
| Enumeration | Description |
|---|---|
| CustomApi | Specifies the API used for implementing a custom object. |
| CustomSymbolCacheHint | Specifies when the visualization generated by a custom symbol may be cached and reused. |
| CustomVisualizerCacheHint | Specifies when the visualization generated by a custom visualizer may be cached and reused. |
| ProcessingMode | Specifies the available processing modes for a ScriptOperator or a CustomOperatorAdapter. |
| ScriptLanguage | The supported script languages. |