PlotSymbol Class
Specifies how plots in PlotLayer are visualized.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class PlotSymbol : EngineObjectRemarks
This class is used to specify the visualization of plots in a PlotLayer. Instances of this class is passed to PlotLayer.AddPlots and PlotLayer.UpdatePlots to specify the visualization for that plot batch.
If the Symbol property is not specified, plots will be rendered as simple squares, using the Size and Color properties.
If a Symbol is specified, the Size property will be ignored. The size of the plot will be the size of the raster symbol, multiplied by SymbolScale. If the symbol has color information it will be used; monochrome symbols will be rendered using Color.
In 3D, the actual plot size on the screen may be adjusted according to the distance from the camera, see PlotLayer.LengthUnit.
The hot spot of raster symbols will not be used, the symbols will always be centered over the plots.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
PlotSymbol
Platforms
Windows, Linux, Android
PlotSymbol Members
The PlotSymbol type has the following members.
Constructors
| Name | Description |
|---|---|
| PlotSymbol | Initializes a new instance of the PlotSymbol class. |
Properties
| Name | Description |
|---|---|
| Color | Gets or sets the color used to render the plots. |
| IsDisposed | Gets a value that tells whether the current PlotSymbol has been disposed. Inherited from EngineObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current PlotSymbol represents. Inherited from EngineObject |
| Size | Gets or sets the size of the squares used to render the plots. |
| Symbol | Gets or sets the raster symbol used the render the plots. |
| SymbolScale | Gets or sets an additional scale factor multiplied to the symbol size. |
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 |