SymbolVisualizer Class
A visualizer that draws features as symbols.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class SymbolVisualizer : PointVisualizerRemarks
A SymbolVisualizer draws features as one or more symbol objects, in both 2D and 3D. It can be applied to point, line and polygon features, all other feature types are ignored. Like all PointVisualizer types, it can be repeated along lines and polygon edges, and can also be rotated with the features.
In 2D, the symbols may also be scaled and offset in X and Y. If applied to a line or polygon edge, the direction of the line or edge may be added to the rotation; a line that is directed up (north) rotates the symbol 0 degrees. A Symbol3D can not be presented in 2D.
In 3D, the following rules apply:
If 2D symbols are used, they will always face the viewer; any rotation from the feature is ignored.
The OffsetZ parameter is always applied to the original point, in view coordinates.
If the length unit is pixels, the scale, rotation, and X and Y offset parameters are then applied in pixel coordinates, i.e. they work just like in 2D. The size of the symbol will be independent of the distance to the object.
If the length unit is nominal meters or view length units, the X and Y offsets will be applied in view coordinates, and the scaling will depend on the distance to the object so that symbols far away are smaller than symbols near the viewer. Rotation still works as in 2D.
Symbols that are truly 3D symbols are those created by Symbol3D, BoxSymbol, ConeSymbol, CylinderSymbol, PyramidSymbol or SphereSymbol, including the predefined volume symbols (see VolumeSymbol). These symbols are rotated according to Rotation, Pitch and Roll and scaled according to Scale and distance from viewer. Azimuth rotation and length unit are not applicable. 3D symbols may be rotated around the Z axis when applied to line features.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
Visualizer
PointVisualizer
SymbolVisualizer
Platforms
Windows, Linux, Android
See Also
Reference
Core Module
VisualizationOperator
RasterSymbol
SvgSymbol
Symbol3D
BoxSymbol
ConeSymbol
CylinderSymbol
PyramidSymbol
SphereSymbol
SymbolVisualizer Members
The SymbolVisualizer type has the following members.
Constructors
| Name | Description |
|---|---|
| SymbolVisualizer | Initializes a new instance of the SymbolVisualizer class. |
Properties
| Name | Description |
|---|---|
| AntiAlias | Gets or sets a flag indicating if antialiasing should be used to remove aliasing artifacts by smoothing the pixels. Inherited from PointVisualizer |
| At | Gets or sets a value that determines the placement of an object along lines. Inherited from PointVisualizer |
| AtCenter | Gets or sets a value indicating if the SymbolVisualizer is applied to the center of a polygon feature, or along the edge. Inherited from PointVisualizer |
| AzimuthRotation | Gets or sets a value indicating whether the Rotation angle starts from true north. Inherited from PointVisualizer |
| ClipToViewArea | Gets or sets a value indicating if the feature should be clipped to the visible view area before the visualizer is applied. Inherited from PointVisualizer |
| Color | Gets or sets the color used to draw the features. Inherited from PointVisualizer |
| Condition | Gets or sets a condition that must evaluate to true if the visualizer shall be applied to a feature. Inherited from Visualizer |
| IsDisposed | Gets a value that tells whether the current SymbolVisualizer has been disposed. Inherited from EngineObject |
| LabelOrganizingSettings | Gets or sets the settings that control how the rendering will be affected by a LabelOrganizingLayer. Inherited from PointVisualizer |
| LeadLine | Gets or sets a value indicating if a lead line should be drawn for offset objects. Inherited from PointVisualizer |
| LeadLineSettings | Gets or sets properties controlling how lead lines are drawn. Inherited from PointVisualizer |
| LengthUnit | Gets or sets a value defining the length unit of some other properties. Inherited from PointVisualizer |
| Name | Gets or sets the name of the SymbolVisualizer. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current SymbolVisualizer represents. Inherited from EngineObject |
| OffsetX | Gets or sets a value offsetting the visualization of an object from its geographic position. Inherited from PointVisualizer |
| OffsetY | Gets or sets a value offsetting the visualization of an object from its geographic position. Inherited from PointVisualizer |
| OffsetZ | Gets or sets a value offsetting the visualization of an object from its geographic position. Inherited from PointVisualizer |
| Opacity | Gets or sets a value that specifies the opacity of the features. Inherited from PointVisualizer |
| PickingSupport | Gets or sets a value specifying how much information is maintained when the visualizer creates a PresentationObject for a feature. Inherited from Visualizer |
| Pitch | Gets or sets the pitch of a Symbol3D symbol. |
| RenderingPriority | Get or sets how the visualization is prioritized. Inherited from PointVisualizer |
| Repeat | Gets or sets a value determining the placement of an object along lines and polygon edges. Inherited from PointVisualizer |
| RingOrientation | Gets or sets the desired orientation of polygon rings and closed line features. Inherited from PointVisualizer |
| Roll | Gets or sets the roll of a Symbol3D symbol. |
| Rotation | Gets or sets a value specifying the direction of the object. Inherited from PointVisualizer |
| RotationMode | Gets or sets a value that indicates how a label or symbol is rotated. Inherited from PointVisualizer |
| Scale | Gets or sets a value controlling the size of the visualization. Inherited from PointVisualizer |
| Symbol | Gets or sets the symbol to draw. |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
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 |
| Draw | Draws a feature on a drawable. Inherited from Visualizer |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from Visualizer |
| GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from Visualizer |
| GetImage | Renders a feature onto a bitmap and returns it. Inherited from PointVisualizer |