InteractionVisualizer Class
Creates extra visualization to aid in understanding and interacting with features.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class InteractionVisualizer : VisualizerRemarks
This is a multi-purpose visualizer that helps understanding and interacting with features. Used as a selection visualizer, it can be used to modify features. Some of the visualization may also be useful to use as a regular visualization to help indicate how objects relate to the ground.
 |
The screenshot above shows a line being drawn in the air. At first glance, it is not very obvious exactly how this line is located in 3D space. If the line is supposed to represent something on the ground, it is suitable to edit the nodes of the line by moving their relative ground position instead of the floating node visualization. Look at the second screenshot where this visualizer has used the GroundNodeVisualizer to create handles for this purpose. By dragging these points, is becomes easier to place the node where it should be relative ground. Lead lines have also been added with the LeadLineVisualizer.
 |
One of the usages of this visualizer is to allow editing the result of the BoxOperator. It takes a polygon geometry and creates a box using top and bottom elevation values. The polygon is then not used anymore. Editing MeshGeometries is not supported, but for the results of the BoxOperator this is a special case since it relates to a source polygon geometry that can be modified.
Editing features under a TileLayer of any form is not supported. Use a OrdinaryLayer with Dynamic instead.
The following tables show how the visualizers are used with the various geometry types.
PointGeometry
Visualizer | Visualization |
|---|---|
NodeVisualizer | None |
GroundNodeVisualizer | When using a GlobeView, draws a ground relative symbol at the location of the point. |
LeadLineVisualizer | When using a GlobeView, a line is drawn from the point down into the ground. |
EdgeVisualizer | None |
LineGeometry
Visualizer | Visualization |
|---|---|
NodeVisualizer | Draws a symbol for each node of the line. |
GroundNodeVisualizer | When using a GlobeView, draws a ground relative symbol at the location of each node. |
LeadLineVisualizer | When using a GlobeView, a line is drawn from each node down into the ground. |
EdgeVisualizer | None |
PolygonGeometry
Visualizer | Visualization |
|---|---|
NodeVisualizer | Draws a symbol for each node of the polygon. |
GroundNodeVisualizer | When using a GlobeView, draws a ground relative symbol at the location of each node. |
LeadLineVisualizer | When using a GlobeView, a line is drawn from each node down into the ground. |
EdgeVisualizer | A line is drawn along the outline and holes of the polygon. |
PolygonGeometry from EllipseOperator
The EllipseOperator takes a point geometry and creates a polygon representing an ellipse. This visualizer can generate handles for controlling properties in the operator. Read more about the setup of the operator and visualizer at Interacting with Ellipses.
The visualization will only show up if at least one of the properties it controls has been set up to be controlled by attributes on the feature.
Visualizer | Visualization |
|---|---|
NodeVisualizer | Draws a symbol for each of the handles that controls properties of the ellipse, including one for the center location. |
GroundNodeVisualizer | When using a GlobeView, draws a ground relative symbol at the location of each handle. |
LeadLineVisualizer | When using a GlobeView, a line is drawn from each handle down into the ground. |
EdgeVisualizer | None |
MeshGeometry from BoxOperator
The BoxOperator takes a PolygonGeometry and creates a MeshGeometry representing an box. This visualizer can generate handles for controlling the underlying polygon and the bottom and top elevations of the box. Read more about the setup of the operator at BoxOperator.
Visualizer | Visualization |
|---|---|
NodeVisualizer | For each node of the polygon that the box is generated from, draws a symbol at the top and bottom elevation. |
GroundNodeVisualizer | For each node of the polygon that the box is generated from, draws a ground relative symbol at the location of each node. |
LeadLineVisualizer | For each node of the polygon that the box is generated from, draws a line from the bottom elevation into the ground. |
EdgeVisualizer | For each node of the polygon that the box is generated from, draws a vertical line between the bottom and top elevation. Also draws a line along the bottom and top, taking holes into consideration. |
All generated handle symbols except for the center are tagged with the attribute interactionType that can be used to customize the visualizer properties like for example the symbol, color or scale. The following table shows the values and what properties that handle controls. In some cases the handle will not be created due to settings in either this visualizer or the EllipseOperator.
interactionType Values
Attribute Value | Type | Properties Controlled | Location | Condition |
|---|---|---|---|---|
Atom | Geometry position | Center of the ellipse | ||
circleRadius | Atom | Outer edge in the direction of the circle. | ||
circleRadiusAlongDirection | Atom | EllipseOperator.Radius, EllipseOperator.Direction, geometry position | Outer edge in the direction of the circle. | |
circleRadiusOppositeDirection | Atom | EllipseOperator.Radius, EllipseOperator.Direction, geometry position | Outer edge in the opposite direction of the circle. | |
circleInnerRadius | Atom | Inner edge in the direction of the circle. | ||
ellipseRadius | Atom | Outer edge in the direction of the ellipse. | ||
ellipseRadiusAlongDirection | Atom | EllipseOperator.Radius, EllipseOperator.Direction, geometry position | Outer edge in the direction of the ellipse. | |
ellipseRadiusOppositeDirection | Atom | EllipseOperator.Radius, EllipseOperator.Direction, geometry position | Outer edge in the opposite direction of the ellipse. | |
ellipseRatio | Atom | Outer edge 90 degrees from the direction. | ||
sectorStart | Atom | Outer edge in the direction of EllipseOperator.SectorStart. | EllipseOperator.SectorDefinition is StartClockwiseToFinish or StartClockwiseByWidth | |
sectorFinish | Atom | Inner edge in the direction of EllipseOperator.SectorFinish. | ||
sectorByWidth | Atom | Inner edge in the direction of EllipseOperator.SectorStart plus the offset angle of EllipseOperator.SectorWidth. | ||
sectorMiddle | Atom | Outer edge in the direction of EllipseOperator.SectorMiddle. | ||
sectorWidthLeft | Atom | Inner edge in the direction of EllipseOperator.SectorStart minus half the offset angle of EllipseOperator.SectorWidth. | ||
sectorWidthRight | Atom | Inner edge in the direction of EllipseOperator.SectorStart plus half the offset angle of EllipseOperator.SectorWidth. |
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
Visualizer
InteractionVisualizer
Platforms
Windows, Linux, Android
See Also
Reference
Core Module
MeshGeometry
LineGeometry
PolygonGeometry
PointGeometry
Interacting with Ellipses
InteractionVisualizer Members
The InteractionVisualizer type has the following members.
Constructors
| Name | Description |
|---|---|
| InteractionVisualizer | Initializes a new instance of the InteractionVisualizer class. |
Properties
| Name | Description |
|---|---|
| Condition | Gets or sets a condition that must evaluate to true if the visualizer shall be applied to a feature. Inherited from Visualizer |
| EdgeVisualizer | Gets or sets the visualizer used to visualize the edges. |
| EllipseInteractionMode | Get or sets a mode that affects what handles are visualized and in what way interacting with them will modify the ellipse. |
| GroundNodeVisualizer | Gets or sets the visualizer used to visualize the ground nodes. |
| IsDisposed | Gets a value that tells whether the current InteractionVisualizer has been disposed. Inherited from EngineObject |
| LeadLineVisualizer | Gets or sets the visualizer used to visualize the lead lines. |
| Name | Gets or sets the name of the InteractionVisualizer. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current InteractionVisualizer represents. Inherited from EngineObject |
| NodeVisualizer | Gets or sets the visualizer used to visualize the nodes. |
| PickingSupport | Gets or sets a value specifying how much information is maintained when the visualizer creates a PresentationObject for a feature. Inherited from Visualizer |
| RenderingPriority | Get or sets how the visualization is prioritized. |
| 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 |