Symbol3D Class
Represents a 3D model that can be used as a symbol in a 3D view.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class Symbol3D : SymbolRemarks
A Symbol3D is a 3D model that can be used for visualization of points and other data in 3D. It can not be used in a 2D view. A Symbol3D object is created from a file or memory buffer in one of the of formats described in Supported Model Formats. The object can be rotated in three directions when drawn, see SymbolVisualizer. Symbol3D objects are drawn with the model space origin (0, 0, 0) at the drawing point.
The symbol will normally be displayed with the colors defined in the model file, possibly adjusted by the lighting settings of the view. However, it is possible to adjust the colors and a few other material properties, both for textured and non-textured symbols, by setting the Material property. This can be used to show the same symbol with different coloring, perhaps controlled by a feature attribute.
A 3D symbol is oriented using the rotation, roll and pitch properties on SymbolVisualizer. The default values are intended to orient the model's forward in the north direction and the model's up in the globe's upward directed, as illustrated by this image:
 |
It varies what axes models use to represent forward and upward. A Symbol3D uses the properties AheadVector and UpVector to compensate for this. These properties are two points that represent orthonormal vectors that should be aligned to up and forward in the model's coordinate system.
Due to a quirk in how Carmenta Engine reads models, AheadVector is the vector in model space that will be oriented upwards in Carmenta Engine while UpVector will be oriented forwards (north without Rotation).
If the model's coordinate system is unknown, create the symbol without rotation, roll or pitch and adjust AheadVector and UpVector until the symbol is oriented as desired.
Note that model files are read the first time that the object is displayed. Created objects that are not displayed will not use any resources.
 |
In addition to drawing the models in a 3D view with a SymbolVisualizer, it is also possible to load a 3D model and access the individual meshes and materials, using the LoadMeshes method.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
Symbol
Symbol3D
Platforms
Windows, Linux, Android
See Also
Reference
Core Module
BoxSymbol
ConeSymbol
CylinderSymbol
PyramidSymbol
SphereSymbol
SymbolVisualizer
Symbol3D Members
The Symbol3D type has the following members.
Constructors
| Name | Description |
|---|---|
| Symbol3D | Initializes a new instance of the Symbol3D class. |
Properties
| Name | Description |
|---|---|
| AheadVector | Gets the forward vector of the model. |
| AlphaThreshold | Gets or sets the alpha threshold value of the model. |
| Bounds | Gets the bounding box of the model. |
 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 filename of the model file that the Symbol3D is created from. |
| 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 Symbol3D has been disposed. Inherited from EngineObject |
| Mangrove | Gets the predefined mangrove fill pattern. Inherited from Symbol |
| Material | Gets or sets a material used to override some properties of the 3D symbol. |
| MixedTree | Gets the predefined mixedTree fill pattern. Inherited from Symbol |
| Name | Gets or sets the name of the Symbol3D. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current Symbol3D 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 directory of the model file that the Symbol3D is created from. |
| 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 |
| UpVector | Gets the up vector of the model. |
| 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 |
| LoadMeshes | Loads a 3D model from the specified file. |