CustomVisualizerCacheHint Enumeration
Specifies when the visualization generated by a custom visualizer may be cached and reused.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Syntax
public enum CustomVisualizerCacheHintValues
| Value name | Value | Description |
|---|---|---|
| Never | 0 | The visualization should never be cached. |
| Position | 1 | The visualization may be cached. If the position on screen changes, the cached visualization will be redrawn at the new position. If view scale or rotation changes, Carmenta Engine will call the custom symbol to redraw the feature. |
| Scale | 2 | The visualization may be cached. If the view scale changes, the cached visualization will be redrawn and scaled appropriately. If view position or rotation changes, Carmenta Engine will call the custom symbol to redraw the feature. |
| Rotation | 4 | The visualization may be cached. If the view rotation changes, the cached visualization will be redrawn and rotated appropriately. If view position or scale changes, Carmenta Engine will call the custom symbol to redraw the feature. |
| Always | 7 | A combination of Position, Scale and Rotation. The visualization will be cached and reused even if position, scale or rotation changes. |
Remarks
This is an enumeration type, used as return value from the ICustomVisualizer.Draw and ICustomNativeVisualizer.Draw methods of custom visualizers. It indicates if and how the visualization created by the visualizer may be cached and reused, if the position, scale or rotation of the view changes.
The enumeration is in fact a bit field, several values may be used together.
Platforms
Windows, Linux, Android