RasterSymbol Class
Represents a bitmap symbol that can be partially transparent.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public class RasterSymbol : SymbolRemarks
A RasterSymbol is either a single-color bitmap with transparent background or a multi-color bitmap. Raster symbols are mainly used in SymbolVisualizer elements but they can also be used as fill patterns for polygons in a PolygonVisualizer.
A RasterSymbol can be created by reading a file in one of the basic Supported Image Formats, or by specifying the pixels in the constructor.
When 1-bit files are read the black pixels will be drawn opaque and the white pixels will be transparent.
Note that 1-bit raster symbols get their color from the PointVisualizer.Color property when they are visualized, while multi-color raster symbols read their colors from the image file. The advantage with the 1-bit symbols is that an attribute can control the color in the visualization.
In 3D some patterns work better than others. Raster symbols that are not 2, 4, 8, 16 or 32 pixels in width and height will be stretched to the next size above which might cause some artifacts. However, in the surface layers of a globe view, RasterSymbol is fully supported.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
Symbol
RasterSymbol
Platforms
Windows, Linux, Android
RasterSymbol Members
The RasterSymbol type has the following members.
Constructors
| Name | Description |
|---|---|
| RasterSymbol | Initializes a new instance of the RasterSymbol class. |
Properties
| Name | Description |
|---|---|
 Brick | Gets the predefined brick fill pattern. Inherited from Symbol |
| Bullseye | Gets the predefined bullseye symbol. Inherited from Symbol |
| Burst | Gets the predefined burst symbol. Inherited from Symbol |
| Circle | Gets the predefined circle symbol. Inherited from Symbol |
| CircleCross | Gets the predefined circleCross symbol. Inherited from Symbol |
| CircleX | Gets the predefined circleX symbol. Inherited from Symbol |
| Cross | Gets the predefined cross symbol. Inherited from Symbol |
| DeciduousTree | Gets the predefined deciduousTree fill pattern. Inherited from Symbol |
| Diamond | Gets the predefined diamond symbol. Inherited from Symbol |
| Dots1 | Gets the predefined dots1 fill pattern. Inherited from Symbol |
| Dots2 | Gets the predefined dots2 fill pattern. Inherited from Symbol |
| Empty | Gets an empty symbol or fill pattern. Inherited from Symbol |
| EvergreenTree | Gets the predefined evergreenTree fill pattern. Inherited from Symbol |
| FileName | Gets the name of the file that contains the raster symbol. |
| Floodable | Gets the predefined floodable fill pattern. Inherited from Symbol |
| Glacier | Gets the predefined glacier fill pattern. Inherited from Symbol |
| Grassland | Gets the predefined grassland fill pattern. Inherited from Symbol |
| Grid1 | Gets the predefined grid1 fill pattern. Inherited from Symbol |
| Grid2 | Gets the predefined grid2 fill pattern. Inherited from Symbol |
| Height | Gets the height of the raster symbol. |
| HollowCircle | Gets the predefined hollow circle symbol. Inherited from Symbol |
| HollowDiamond | Gets the predefined hollow diamond symbol. Inherited from Symbol |
| HollowRoundedSquare | Gets the predefined hollow rounded square symbol. Inherited from Symbol |
| HollowSquare | Gets the predefined hollow square symbol. Inherited from Symbol |
| HollowTriangle | Gets the predefined hollow triangle symbol. Inherited from Symbol |
| Image | Gets the image data of a 1-bit raster. |
| IsDisposed | Gets a value that tells whether the current RasterSymbol has been disposed. Inherited from EngineObject |
| Mangrove | Gets the predefined mangrove fill pattern. Inherited from Symbol |
| MixedTree | Gets the predefined mixedTree fill pattern. Inherited from Symbol |
| Name | Gets or sets the name of the RasterSymbol. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current RasterSymbol represents. Inherited from EngineObject |
| NorthArrow | Gets a predefined north arrow symbol: an arrowhead without an N label. Inherited from Symbol |
| NorthArrowN | Gets a predefined north arrow symbol: an arrowhead with an N label. Inherited from Symbol |
| OrchardPlantation | Gets the predefined orchard/plantation fill pattern. Inherited from Symbol |
| Path | Gets the path to the directory where the file containing the raster symbol is located. |
| Raster | Gets the Raster that contains the image of the RasterSymbol. |
| Rice | Gets the predefined rice fill pattern. Inherited from Symbol |
| RoundedSquare | Gets the predefined rounded square symbol. Inherited from Symbol |
| Sand | Gets the predefined sand fill pattern. Inherited from Symbol |
| SandAndGravel | Gets the predefined sandAndGravel fill pattern. Inherited from Symbol |
| ScrubThicket | Gets the predefined scrub/thicket fill pattern. Inherited from Symbol |
| SmallDot | Gets the predefined small dot symbol. Inherited from Symbol |
| SmallPlus | Gets the predefined small plus symbol. Inherited from Symbol |
| Solid | Gets the predefined solid fill pattern. Inherited from Symbol |
| Square | Gets the predefined square symbol. Inherited from Symbol |
| Star | Gets the predefined star symbol. Inherited from Symbol |
| Stripes1 | Gets the predefined stripes1 fill pattern. Inherited from Symbol |
| Stripes10 | Gets the predefined stripes10 fill pattern. Inherited from Symbol |
| Stripes11 | Gets the predefined stripes11 fill pattern. Inherited from Symbol |
| Stripes12 | Gets the predefined stripes12 fill pattern. Inherited from Symbol |
| Stripes2 | Gets the predefined stripes2 fill pattern. Inherited from Symbol |
| Stripes3 | Gets the predefined stripes3 fill pattern. Inherited from Symbol |
| Stripes4 | Gets the predefined stripes4 fill pattern. Inherited from Symbol |
| Stripes5 | Gets the predefined stripes5 fill pattern. Inherited from Symbol |
| Stripes6 | Gets the predefined stripes6 fill pattern. Inherited from Symbol |
| Stripes7 | Gets the predefined stripes7 fill pattern. Inherited from Symbol |
| Stripes8 | Gets the predefined stripes8 fill pattern. Inherited from Symbol |
| Stripes9 | Gets the predefined stripes9 fill pattern. Inherited from Symbol |
| Swamp | Gets the predefined swamp fill pattern. Inherited from Symbol |
| Triangle | Gets the predefined triangle symbol. Inherited from Symbol |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| VineyardHops | Gets the predefined vineyard/hops fill pattern. Inherited from Symbol |
| Width | Gets the width to the raster symbol. |
| X | Gets the predefined x symbol. Inherited from Symbol |
| XHot | Gets or sets the x-coordinate of the hot spot of the raster symbol. |
| YHot | Gets or sets the y-coordinate of the hot spot of the raster 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 |