ProgrammaticReticleTool

Allows you to edit geometries in a GeometryEditor using a GeometryEditorReticle, ideal for precise editing with snapping on a touch screen with a fully customizable user experience. The ProgrammaticReticleTool provides precise, vertex-based geometry editing on touch devices using the GeometryEditor with a fully customizable user experience. Unlike the ReticleVertexTool, the ProgrammaticReticleTool has no ReticleInteractionConfiguration to define the effect of tap interactions. Tap interactions have no effect and are not handled by this tool. Instead, the programmatic methods can be called when required to give granular control for custom workflows such as those using buttons or other triggers. To provide the ability to programmatically move, resize, and rotate whole geometries, or parts of multipart geometries, you can use the programmatic calls on the GeometryEditor such as GeometryEditor.rotateSelectedElement, GeometryEditor.moveSelectedElement and GeometryEditor.scaleSelectedElement.

Since

200.8.0

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

True if the vertex feedback under reticle and snap feedback is visible when creating a new vertex, false otherwise. The default value is true. When false, vertex feedback under the reticle, visual snap feedback, snap haptics and GeometryEditor.snapChanged events will be disabled when GeometryEditor.pickedUpElement is null. Feedback will still occur when inserting a new vertex by picking up an existing mid-vertex.

Inherited properties

Link copied to clipboard

Specifies the reticle visual component to be used by the ReticleVertexTool. A default GeometryEditorReticle is provided if a new one is not assigned.

Link copied to clipboard

Defines the visual appearance of GeometryEditor geometries when this tool is in use. When a GeometryEditorTool is created, a consistent set of default symbology appropriate for that tool type is applied to its GeometryEditorTool.style property. For example, FreehandTool and ShapeTool define all vertex symbols as null by default because they use drag gestures to define entire parts of polyline and polygon geometries, whereas the VertexTool defines non-null vertex symbols because it is important to be able to see and interact with individual vertices when editing geometries with this tool.

Functions

Link copied to clipboard

Picks up the currently selected element if the element is a GeometryEditorVertex or GeometryEditorMidVertex. A picked up element can be moved by panning the map underneath the ReticleTool.reticle, with optional snapping, and placed using ProgrammaticReticleTool.placeElementAtReticle.

Link copied to clipboard

Inserts a new GeometryEditorVertex or drops the currently picked up element at the position of the reticle. When the GeometryEditor.pickedUpElement is not null, this will drop the picked up element at the reticle position. When the GeometryEditor.pickedUpElement is null, this will insert a new vertex at the reticle position.

Link copied to clipboard

Selects an element at the current position of the reticle. If called when the reticle is not over a vertex or mid-vertex this will return false even if a GeometryEditor.selectedElement already exists. Selection will not be cleared. If called when a GeometryEditor.pickedUpElement exists this will return false and the selection will not be changed. If called when the reticle is over a geometry segment or fill, this will return false and not select anything and existing selections will not be cleared.