Symbol Class
Abstract base class for all types of symbol objects.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public abstract class Symbol : ResourceObjectRemarks
Symbol is the abstract base class for all symbols that can be rendered by Carmenta Engine. A feature are rendered as a symbol by attaching a SymbolVisualizer to it, using a VisualizationOperator.
Carmenta Engine provides a number of predefined symbols, available both in Carmenta Studio and as static properties of this class.
 |
The symbols above are all SVG symbols. Two additional predefined raster symbols exist for backward compatibility, smallPlus and smallDot. There are also some predefined symbols intended as polygon fill patterns, see PolygonVisualizer.Pattern for a list.
In a 3D map, two dimensional symbols are displayed as billboards facing the camera. To get a truly three-dimensional symbol, you can either construct a Symbol3D or a VolumeSymbol.
A VolumeSymbol is a simple 3D shape, like a box, sphere or cone, which can be assigned a color and a Material but not a texture. You can either use a subclass of VolumeSymbol to create your own instance, or you can use one of the predefined instances.
 |
A Symbol3D is constructed from a VRML file or a 3ds file and can have any shape or texture.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
Symbol
CustomSymbolProxy
RasterSymbol
SvgSymbol
Symbol3D
TacticalSymbol
VolumeSymbol
WindBarbSymbol
Platforms
Windows, Linux, Android
Symbol Members
The Symbol type has the following members.
Properties
| Name | Description |
|---|---|
 Brick | Gets the predefined brick fill pattern. |
| Bullseye | Gets the predefined bullseye symbol. |
| Burst | Gets the predefined burst symbol. |
| Circle | Gets the predefined circle symbol. |
| CircleCross | Gets the predefined circleCross symbol. |
| CircleX | Gets the predefined circleX symbol. |
| Cross | Gets the predefined cross symbol. |
| DeciduousTree | Gets the predefined deciduousTree fill pattern. |
| Diamond | Gets the predefined diamond symbol. |
| Dots1 | Gets the predefined dots1 fill pattern. |
| Dots2 | Gets the predefined dots2 fill pattern. |
| Empty | Gets an empty symbol or fill pattern. |
| EvergreenTree | Gets the predefined evergreenTree fill pattern. |
| Floodable | Gets the predefined floodable fill pattern. |
| Glacier | Gets the predefined glacier fill pattern. |
| Grassland | Gets the predefined grassland fill pattern. |
| Grid1 | Gets the predefined grid1 fill pattern. |
| Grid2 | Gets the predefined grid2 fill pattern. |
| HollowCircle | Gets the predefined hollow circle symbol. |
| HollowDiamond | Gets the predefined hollow diamond symbol. |
| HollowRoundedSquare | Gets the predefined hollow rounded square symbol. |
| HollowSquare | Gets the predefined hollow square symbol. |
| HollowTriangle | Gets the predefined hollow triangle symbol. |
| IsDisposed | Gets a value that tells whether the current Symbol has been disposed. Inherited from EngineObject |
| Mangrove | Gets the predefined mangrove fill pattern. |
| MixedTree | Gets the predefined mixedTree fill pattern. |
| Name | Gets or sets the name of the Symbol. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current Symbol represents. Inherited from EngineObject |
| NorthArrow | Gets a predefined north arrow symbol: an arrowhead without an N label. |
| NorthArrowN | Gets a predefined north arrow symbol: an arrowhead with an N label. |
| OrchardPlantation | Gets the predefined orchard/plantation fill pattern. |
| Rice | Gets the predefined rice fill pattern. |
| RoundedSquare | Gets the predefined rounded square symbol. |
| Sand | Gets the predefined sand fill pattern. |
| SandAndGravel | Gets the predefined sandAndGravel fill pattern. |
| ScrubThicket | Gets the predefined scrub/thicket fill pattern. |
| SmallDot | Gets the predefined small dot symbol. |
| SmallPlus | Gets the predefined small plus symbol. |
| Solid | Gets the predefined solid fill pattern. |
| Square | Gets the predefined square symbol. |
| Star | Gets the predefined star symbol. |
| Stripes1 | Gets the predefined stripes1 fill pattern. |
| Stripes10 | Gets the predefined stripes10 fill pattern. |
| Stripes11 | Gets the predefined stripes11 fill pattern. |
| Stripes12 | Gets the predefined stripes12 fill pattern. |
| Stripes2 | Gets the predefined stripes2 fill pattern. |
| Stripes3 | Gets the predefined stripes3 fill pattern. |
| Stripes4 | Gets the predefined stripes4 fill pattern. |
| Stripes5 | Gets the predefined stripes5 fill pattern. |
| Stripes6 | Gets the predefined stripes6 fill pattern. |
| Stripes7 | Gets the predefined stripes7 fill pattern. |
| Stripes8 | Gets the predefined stripes8 fill pattern. |
| Stripes9 | Gets the predefined stripes9 fill pattern. |
| Swamp | Gets the predefined swamp fill pattern. |
| Triangle | Gets the predefined triangle symbol. |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| VineyardHops | Gets the predefined vineyard/hops fill pattern. |
| X | Gets the predefined x symbol. |
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 |