CustomSymbolProxy Class
A proxy for a custom symbol in map configurations.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public class CustomSymbolProxy : SymbolRemarks
A custom symbol is a .NET, C++ or Java object that implements one of the ICustomSymbol or ICustomNativeSymbol interfaces. If you have written a custom symbol and want to use it in a map configuration, you need use a CustomSymbolProxy. The proxy works as regular Carmenta Engine symbol, but delegates most calls to the custom object.
There are two different ways to connect the custom symbol 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 symbol.
The application can itself create the custom symbol instance in application code, and pass it to the proxy by setting the CustomSymbol or CustomNativeSymbol property.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
Symbol
CustomSymbolProxy
Platforms
Windows, Linux, Android
CustomSymbolProxy Members
The CustomSymbolProxy type has the following members.
Constructors
| Name | Description |
|---|---|
| CustomSymbolProxy | Initializes a new instance of the CustomSymbolProxy class. |
Properties
| Name | Description |
|---|---|
| Api | Gets the API the custom symbol is implemented with. |
 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 |
| CacheSize | Gets or sets the maximum number of different instances of this symbol that may be cached. |
| 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 |
| ClassName | Gets the name of the class implementing the custom symbol. |
| Cross | Gets the predefined cross symbol. Inherited from Symbol |
| CustomNativeSymbol | Gets or sets the native custom symbol instance. |
| CustomSymbol | Gets or sets the custom symbol instance. |
| 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 |
| 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 |
| 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 |
| IsDisposed | Gets a value that tells whether the current CustomSymbolProxy has been disposed. Inherited from EngineObject |
| LibraryName | Gets the name of the library containing the custom symbol. |
| 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 CustomSymbolProxy. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current CustomSymbolProxy 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 |
| 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 |
| X | Gets the predefined x symbol. Inherited from 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 |
| FlushCache | Flushes all cached symbols. |