SymbolMetadata Class
Describes a symbol in a supported SymbolStandard.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CETactical assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CETactical assembly)
Thread safety: Members defined in this class are thread-safe. Show
Syntax
public class SymbolMetadata : EngineObjectInheritance Hierarchy
System.Object (not available in C#)
EngineObject
SymbolMetadata
Platforms
Windows, Linux, Android
SymbolMetadata Members
The SymbolMetadata type has the following members.
Properties
| Name | Description |
|---|---|
| Attributes | Gets the SymbolAttributeMetadata entries for all attributes in the symbol. |
| Category | Gets the category of the current symbol. |
| ChildSymbols | Gets the child symbols of the current symbol. |
| Composable | Tells whether the current symbol can be combined with other symbols. |
| Custom | Tells whether the current symbol is a custom symbol or not. |
| Description | Gets a description of the current symbol. |
| FrameOptional | Gets a value that tells whether the symbol is frame optional. |
| HasSupportedDescendants | Tells whether the current symbols has any supported descendant symbols. |
| Hierarchy | Gets the hierarchy code of the current symbol. |
| InteractionHint | Gets a value that provides additional information about the geometry of a symbol. |
| IsDisposed | Gets a value that tells whether the current SymbolMetadata has been disposed. Inherited from EngineObject |
| LocationType | Gets a value that specifies the LocationType of a symbol. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current SymbolMetadata represents. Inherited from EngineObject |
| Parent | Gets the parent entry of the current SymbolMetadata. |
| Sidc | Gets the SIDC of the current symbol. |
| Supported | Tells whether the current symbol is supported and can be displayed by Carmenta Engine. |
| Type | Gets the type of the current 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 |