Constructs a new PointListHelperHandle
OptionalhelperStyle: ShapeStyle | nullProtectedeventedThe EventedSupport used to emit events.
Typically, handles use emitEditShapeEvent to emit "EditShape" events. This is only used in advanced cases, for example when compositing multiple handles.
ProtectedemitEmits an "EditProperty" event.
Typically, a handle emits this right after changing one or more properties.
The list of changes to emit an edit event for. A handle can change multiple related properties at the same time, for example a handle in a corner could change the width and height of a rectangle-like feature together. Each property should only appear once in the list.
The status of the edit. Typically, this is EditPropertyStatus.IN_PROGRESS while the handle is being dragged / changed, and EditPropertyStatus.FINISHED when the drag ends.
ProtectedemitEmits an "EditShape" event.
Typically, a handle emits this right after changing the shape.
The shape to emit an edit event for
The status of the edit. Typically, this is EditShapeStatus.IN_PROGRESS while the handle is being dragged / changed, and EditShapeStatus.FINISHED when the drag ends.
Returns the mouse cursor to show.
CreateController will check the active handle's cursor on every map's cursor when the returned cursor string changes.
The default implementation always returns null.
the gesture event to determine a cursor for.
the edit context.
a cursor, or null if no mouse cursor should be shown for this handle.
Returns the default helper style.
This is the helper style that is used if no helperStyle was passed into the constructor.
The edit context
The context's helper style
Returns the drape target for a shape drawn by this helper handle.
This will make sure "flat" helper shapes are draped on meshes, if there is a mesh layer on the map. 3D helper shapes are not draped.
In detail, this uses the following heuristics to determine a DrapeTarget: By default, this uses the drapeTarget of getHelperStyle. If that is not defined, this looks at the shape's Z bounds (depth). If the shape has depth, this returns DrapeTarget.NOT_DRAPED. Otherwise, DrapeTarget.ALL is returned.
The edit context
the shape being drawn
Returns the helper style, to be used for visualizing helper shapes in onDraw.
This returns the helper style that was passed into the constructor. If no helper style was passed into the constructor, this returns the context's helper style.
The edit context
Invalidates this edit handle.
This will cause onDraw and onDrawLabel to be called again.
Use this if you need to update the visualization of the handle. For example, the handle has changed style and onDraw needs to be re-evaluated.
Populates a context menu with entries.
For example, a handle for a point in a polyline might add a "Delete point" context menu entry.
the input event that triggered opening the context menu.
the edit context
the context menu to add entries to.
a callback that needs to be called when a menu action is performed. Call this at the end of the ContextMenuItem.action implementation.
On 3D maps, this draws a helper line for 3D polylines. The helper line is a projection of the 3D polyline onto terrain.
This method allows the handle to draw labels on the map.
For example, you can use this to show coordinates of points, or the current radius of a circle on top of an edit handle.
The default implementation draws nothing.
The label canvas to draw labels on
The editing context.
Handles the given context.
The editing handle can modify the feature (or its shape) based on the type and state of the input event. For example, a drag event that moves a circle.
The default implementation ignores the event.
the gesture event.
the edit context.
Indicates whether the feature being created or edited, should be painted by the controller. The feature is painted using the layer's painter.
For handles used in editing, this is typically always true.
For handles used in creation, this typically returns false in the early steps of the creation process.
For example, when the user is still choosing a location for a point (before the first click).
The editing context.
Called when (another) handle changes the feature or shape, as indicated by the "EditShape" event.
This handle can update its own state, based on the changed shape.
For example, a PointListInsertHandle just inserted a point in a polyline. The PointListTranslateHandle uses the update to recalculate new sub-handles, based on the new polyline (with the extra point).
The default implementation does nothing.
An event that is emitted whenever this handle changes the shape of a feature.
EditShape
An event that is emitted whenever this handle changes a property of a feature.
EditProperty
An event that is emitted whenever this handle is invalidated.
Invalidated
An EditHandle that draws helper lines for a point list.
On 3D maps, it draws a helper line for 3D polylines. The helper line is a projection of the 3D polyline onto terrain.
Since
2022.1