CustomVisualizerProxy Class
A proxy for a custom visualizer in map configurations.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Syntax
public class CustomVisualizerProxy : VisualizerRemarks
A custom visualizer is a .NET, C++ or Java object that implements one of the ICustomVisualizer or ICustomNativeVisualizer interfaces. If you have written a custom visualizer and want to use it in a map configuration, you need use a CustomVisualizerProxy. The proxy works as regular Carmenta Engine visualizer, but delegates most calls to the custom object.
There are two different ways to connect the custom visualizer to the proxy:
If the Api, LibraryName and ClassName properties are set, the proxy will automatically load the specified library and create an instance of the custom visualizer.
The application can itself create the custom visualizer instance in application code, and pass it to the proxy by setting the CustomVisualizer or CustomNativeVisualizer property.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
Visualizer
CustomVisualizerProxy
Platforms
Windows, Linux, Android
CustomVisualizerProxy Members
The CustomVisualizerProxy type has the following members.
Constructors
| Name | Description |
|---|---|
| CustomVisualizerProxy | Initializes a new instance of the CustomVisualizerProxy class. |
Properties
| Name | Description |
|---|---|
| Api | Gets the API the custom symbol is implemented with. |
| ClassName | Gets the name of the class implementing the custom visualizer. |
| Condition | Gets or sets a condition that must evaluate to true if the visualizer shall be applied to a feature. Inherited from Visualizer |
| CustomNativeVisualizer | Gets or sets the native custom visualizer instance. |
| CustomVisualizer | Gets or sets the custom visualizer instance. |
| IsDisposed | Gets a value that tells whether the current CustomVisualizerProxy has been disposed. Inherited from EngineObject |
| LibraryName | Gets the name of the library containing the custom visualizer. |
| Name | Gets or sets the name of the CustomVisualizerProxy. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current CustomVisualizerProxy represents. Inherited from EngineObject |
| PickingSupport | Gets or sets a value specifying how much information is maintained when the visualizer creates a PresentationObject for a feature. Inherited from Visualizer |
| RenderingPriority | Get or sets how the visualization is prioritized. |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| Visualizers | Gets a list of sub-visualizers that the custom visualizer may use for some of the drawing. |
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 |
| Draw | Draws a feature on a drawable. Inherited from Visualizer |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from Visualizer |
| GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from Visualizer |