DrawAction (JOSM)

java.lang.Object
- javax.swing.AbstractAction
- - org.openstreetmap.josm.actions.JosmAction
  - - org.openstreetmap.josm.actions.mapmode.MapMode
    - - org.openstreetmap.josm.actions.mapmode.DrawAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, Preferences.PreferenceChangedListener, SelectionChangedListener, MapViewPaintable, KeyPressReleaseListener, ModifierListener, Destroyable
```
public class DrawAction
extends MapMode
implements MapViewPaintable, SelectionChangedListener, KeyPressReleaseListener, ModifierListener
```
Mapmode to add nodes, create and extend ways.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class DrawAction.BackSpaceAction

private class DrawAction.SnapChangeAction

private class DrawAction.SnapHelper
- Nested classes/interfaces inherited from class org.openstreetmap.josm.actions.JosmAction
  JosmAction.ActiveLayerChangeAdapter, JosmAction.LayerChangeAdapter, JosmAction.SelectionChangeAdapter
- Nested classes/interfaces inherited from interface org.openstreetmap.josm.gui.layer.MapViewPaintable
  MapViewPaintable.LayerPainter, MapViewPaintable.MapViewEvent, MapViewPaintable.PaintableInvalidationEvent, MapViewPaintable.PaintableInvalidationListener

Nested Classes
Modifier and Type	Class and Description
`class`	`DrawAction.BackSpaceAction`
`private class`	`DrawAction.SnapChangeAction`
`private class`	`DrawAction.SnapHelper`

Field Summary

Fields
Modifier and Type	Field and Description
`private DrawAction.BackSpaceAction`	`backspaceAction`
`private Shortcut`	`backspaceShortcut`
`private static java.awt.BasicStroke`	`BASIC_STROKE`
`private Node`	`currentBaseNode`
`private EastNorth`	`currentMouseEastNorth`
`private java.awt.Cursor`	`cursorJoinNode`
`private java.awt.Cursor`	`cursorJoinWay`
`private boolean`	`drawHelperLine`
`private boolean`	`drawTargetHighlight`
`private boolean`	`ignoreNextKeyRelease`
`private Node`	`lastUsedNode`
`private Node`	`mouseOnExistingNode`
`private java.util.Set<Way>`	`mouseOnExistingWays`
`private java.awt.Point`	`mousePos`
`private java.util.Set<OsmPrimitive>`	`newHighlights`
`private java.util.Set<OsmPrimitive>`	`oldHighlights`
`private java.awt.Point`	`oldMousePos`
`private static java.awt.Color`	`ORANGE_TRANSPARENT`
`private static double`	`PHI`
`private Node`	`previousNode`
`private java.awt.Point`	`rightClickPressPos`
`private java.awt.Color`	`rubberLineColor`
`private java.awt.Stroke`	`rubberLineStroke`
`private DrawAction.SnapChangeAction`	`snapChangeAction`
`private javax.swing.JCheckBoxMenuItem`	`snapCheckboxMenuItem`
`private DrawAction.SnapHelper`	`snapHelper`
`private Shortcut`	`snappingShortcut`
`private static int`	`snapToIntersectionThreshold`
`private double`	`toleranceMultiplier`
`private boolean`	`useRepeatedShortcut`
`private boolean`	`wayIsFinished`

Fields inherited from class org.openstreetmap.josm.actions.mapmode.MapMode
alt, ctrl, cursor, shift

Fields inherited from class org.openstreetmap.josm.actions.JosmAction
sc

Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled

Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors
Constructor and Description

DrawAction(MapFrame mapFrame)
Constructs a new DrawAction.

Constructors
Constructor and Description
`DrawAction(MapFrame mapFrame)` Constructs a new `DrawAction`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addHighlighting()` Takes the data from computeHelperLine to determine which ways/nodes should be highlighted (if feature enabled).
`private javax.swing.JCheckBoxMenuItem`	`addMenuItem()`
`private static void`	`addRemoveSelection(DataSet ds, OsmPrimitive toAdd, OsmPrimitive toRemove)`
`private static void`	`adjustNode(java.util.Collection<Pair<Node,Node>> segs, Node n)` Adjusts the position of a node to lie on a segment (or a segment intersection).
`private void`	`computeHelperLine()` This method prepares data required for painting the "helper line" from the last used position to the mouse cursor.
`private void`	`continueWayFromNode(Way way, Node node)` if one of the ends of `way` is given `node`, then set currentBaseNode = node and previousNode = adjacent node of way
`void`	`destroy()` Called when the object has been destroyed.
`(package private) static double`	`det(double a, double b, double c, double d)`
`private void`	`determineCurrentBaseNodeAndPreviousNode(java.util.Collection<OsmPrimitive> selection)` Helper function that sets fields currentBaseNode and previousNode
`void`	`doKeyPressed(java.awt.event.KeyEvent e)` This is called when key press event is actually pressed (no fake events while holding key)
`void`	`doKeyReleased(java.awt.event.KeyEvent e)` This is called when key press event is actually released (no fake events while holding key)
`void`	`enterMode()` Makes this map mode active.
`void`	`exitMode()` Makes this map mode inactive.
`private Node`	`findNodeToContinueFrom(Node selectedNode, Way selectedWay)` Finds a node to continue drawing from.
`private void`	`finishDrawing()` This function should be called when the user wishes to finish his current draw action.
`Node`	`getCurrentBaseNode()` Replies the current base node, after having checked it is still usable (see #11105).
`java.util.Collection<OsmPrimitive>`	`getInProgressSelection()` Get selected primitives, while draw action is in progress.
`java.lang.String`	`getModeHelpText()`
`static Way`	`getWayForNode(Node n)`
`private void`	`insertNodeIntoAllNearbySegments(java.util.List<WaySegment> wss, Node n, java.util.Collection<OsmPrimitive> newSelection, java.util.Collection<Command> cmds, java.util.List<Way> replacedWays, java.util.List<Way> reuseWays)`
`private boolean`	`isSelfContainedWay(Way selectedWay, Node currentNode, Node targetNode)` Prevent creation of ways that look like this: <----> This happens if users want to draw a no-exit-sideway from the main way like this: ^ \|<----> \| The solution isn't ideal because the main way will end in the side way, which is bad for navigation software ("drive straight on") but at least easier to fix.
`boolean`	`layerIsSupported(Layer l)` Determines if layer `l` is supported by this map mode.
`void`	`modifiersChanged(int modifiers)` redraw to (possibly) get rid of helper line if selection changes.
`void`	`mouseDragged(java.awt.event.MouseEvent e)`
`void`	`mouseExited(java.awt.event.MouseEvent e)` Repaint on mouse exit so that the helper line goes away.
`void`	`mouseMoved(java.awt.event.MouseEvent e)`
`void`	`mousePressed(java.awt.event.MouseEvent e)`
`void`	`mouseReleased(java.awt.event.MouseEvent e)` If user clicked with the left button, add a node at the current mouse position.
`void`	`paint(java.awt.Graphics2D g, MapView mv, Bounds box)` Paint the dataset using the engine set.
`private static void`	`pruneSuccsAndReverse(java.util.List<java.lang.Integer> is)`
`protected void`	`readPreferences()`
`private boolean`	`redrawIfRequired()` Checks if a map redraw is required and does so if needed.
`private boolean`	`removeHighlighting()` Removes target highlighting from primitives.
`void`	`selectionChanged(java.util.Collection<? extends OsmPrimitive> newSelection)` redraw to (possibly) get rid of helper line if selection changes.
`private static void`	`showStatusInfo(double angle, double hdg, double distance, boolean activeFlag)`
`private void`	`tryAgain(java.awt.event.MouseEvent e)`
`private void`	`tryToMoveNodeOnIntersection(java.util.List<WaySegment> wss, Node n)`
`private void`	`tryToSetBaseSegmentForAngleSnap()` This method is used to detect segment under mouse and use it as reference for angle snapping
`protected void`	`updateEnabledState()` Override in subclasses to update the enabled state of the action when something in the JOSM state changes, i.e.

Methods inherited from class org.openstreetmap.josm.actions.mapmode.MapMode
actionPerformed, mouseClicked, mouseEntered, preferenceChanged, requestFocusInMapView, updateKeyModifiers, updateKeyModifiers, updateKeyModifiers, updateStatusLine

Methods inherited from class org.openstreetmap.josm.actions.JosmAction
getCurrentDataSet, getEditLayer, getLayerManager, getShortcut, initEnabledState, installAdapters, listenToLayerChange, listenToSelectionChange, setTooltip, updateEnabledState, updateEnabledStateOnCurrentSelection, waitFuture

Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ORANGE_TRANSPARENT
```
private static final java.awt.Color ORANGE_TRANSPARENT
```
  - PHI
```
private static final double PHI
```
  - cursorJoinNode
```
private final java.awt.Cursor cursorJoinNode
```
  - cursorJoinWay
```
private final java.awt.Cursor cursorJoinWay
```
  - lastUsedNode
```
private transient Node lastUsedNode
```
  - toleranceMultiplier
```
private double toleranceMultiplier
```
  - mouseOnExistingNode
```
private transient Node mouseOnExistingNode
```
  - mouseOnExistingWays
```
private transient java.util.Set<Way> mouseOnExistingWays
```
  - oldHighlights
```
private transient java.util.Set<OsmPrimitive> oldHighlights
```
  - newHighlights
```
private transient java.util.Set<OsmPrimitive> newHighlights
```
  - drawHelperLine
```
private boolean drawHelperLine
```
  - wayIsFinished
```
private boolean wayIsFinished
```
  - drawTargetHighlight
```
private boolean drawTargetHighlight
```
  - mousePos
```
private java.awt.Point mousePos
```
  - oldMousePos
```
private java.awt.Point oldMousePos
```
  - rubberLineColor
```
private java.awt.Color rubberLineColor
```
  - currentBaseNode
```
private transient Node currentBaseNode
```
  - previousNode
```
private transient Node previousNode
```
  - currentMouseEastNorth
```
private EastNorth currentMouseEastNorth
```
  - snapHelper
```
private final transient DrawAction.SnapHelper snapHelper
```
  - backspaceShortcut
```
private final transient Shortcut backspaceShortcut
```
  - backspaceAction
```
private final DrawAction.BackSpaceAction backspaceAction
```
  - snappingShortcut
```
private final transient Shortcut snappingShortcut
```
  - ignoreNextKeyRelease
```
private boolean ignoreNextKeyRelease
```
  - snapChangeAction
```
private final DrawAction.SnapChangeAction snapChangeAction
```
  - snapCheckboxMenuItem
```
private final javax.swing.JCheckBoxMenuItem snapCheckboxMenuItem
```
  - useRepeatedShortcut
```
private boolean useRepeatedShortcut
```
  - rubberLineStroke
```
private transient java.awt.Stroke rubberLineStroke
```
  - BASIC_STROKE
```
private static final java.awt.BasicStroke BASIC_STROKE
```
  - snapToIntersectionThreshold
```
private static int snapToIntersectionThreshold
```
  - rightClickPressPos
```
private java.awt.Point rightClickPressPos
```
- Constructor Detail
  - DrawAction
```
public DrawAction(MapFrame mapFrame)
```
    Constructs a new DrawAction.
    
    Parameters:
    
    mapFrame - Map frame
- Method Detail
  - addMenuItem
```
private javax.swing.JCheckBoxMenuItem addMenuItem()
```
  - redrawIfRequired
```
private boolean redrawIfRequired()
```
    Checks if a map redraw is required and does so if needed. Also updates the status bar.
    
    Returns:
    
    true if a repaint is needed
  - addRemoveSelection
```
private static void addRemoveSelection(DataSet ds,
                                       OsmPrimitive toAdd,
                                       OsmPrimitive toRemove)
```
  - enterMode
```
public void enterMode()
```
    Description copied from class: MapMode
    
    Makes this map mode active.
    
    Overrides:
    
    enterMode in class MapMode
  - readPreferences
```
protected void readPreferences()
```
    Overrides:
    
    readPreferences in class MapMode
  - exitMode
```
public void exitMode()
```
    Description copied from class: MapMode
    
    Makes this map mode inactive.
    
    Overrides:
    
    exitMode in class MapMode
  - modifiersChanged
```
public void modifiersChanged(int modifiers)
```
    redraw to (possibly) get rid of helper line if selection changes.
    
    Specified by:
    
    modifiersChanged in interface ModifierListener
  - doKeyPressed
```
public void doKeyPressed(java.awt.event.KeyEvent e)
```
    Description copied from interface: KeyPressReleaseListener
    
    This is called when key press event is actually pressed (no fake events while holding key)
    
    Specified by:
    
    doKeyPressed in interface KeyPressReleaseListener
    
    Parameters:
    
    e - key event
  - doKeyReleased
```
public void doKeyReleased(java.awt.event.KeyEvent e)
```
    Description copied from interface: KeyPressReleaseListener
    
    This is called when key press event is actually released (no fake events while holding key)
    
    Specified by:
    
    doKeyReleased in interface KeyPressReleaseListener
    
    Parameters:
    
    e - key event
  - selectionChanged
```
public void selectionChanged(java.util.Collection<? extends OsmPrimitive> newSelection)
```
    redraw to (possibly) get rid of helper line if selection changes.
    
    Specified by:
    
    selectionChanged in interface SelectionChangedListener
    
    Parameters:
    
    newSelection - The new selection.
  - tryAgain
```
private void tryAgain(java.awt.event.MouseEvent e)
```
  - finishDrawing
```
private void finishDrawing()
```
    This function should be called when the user wishes to finish his current draw action. If Potlatch Style is enabled, it will switch to select tool, otherwise simply disable the helper line until the user chooses to draw something else.
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
    
    Overrides:
    
    mousePressed in class MapMode
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e)
```
    If user clicked with the left button, add a node at the current mouse position. If in nodeway mode, insert the node into the way.
    
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
    
    Overrides:
    
    mouseReleased in class MapMode
  - insertNodeIntoAllNearbySegments
```
private void insertNodeIntoAllNearbySegments(java.util.List<WaySegment> wss,
                                             Node n,
                                             java.util.Collection<OsmPrimitive> newSelection,
                                             java.util.Collection<Command> cmds,
                                             java.util.List<Way> replacedWays,
                                             java.util.List<Way> reuseWays)
```
  - isSelfContainedWay
```
private boolean isSelfContainedWay(Way selectedWay,
                                   Node currentNode,
                                   Node targetNode)
```
    Prevent creation of ways that look like this: <----> This happens if users want to draw a no-exit-sideway from the main way like this: ^ |<----> | The solution isn't ideal because the main way will end in the side way, which is bad for navigation software ("drive straight on") but at least easier to fix. Maybe users will fix it on their own, too. At least it's better than producing an error.
    
    Parameters:
    
    selectedWay - the way to check
    
    currentNode - the current node (i.e. the one the connection will be made from)
    
    targetNode - the target node (i.e. the one the connection will be made to)
    
    Returns:
    
    true if this would create a selfcontaining way, false otherwise.
  - findNodeToContinueFrom
```
private Node findNodeToContinueFrom(Node selectedNode,
                                    Way selectedWay)
```
    Finds a node to continue drawing from. Decision is based upon given node and way.
    
    Parameters:
    
    selectedNode - Currently selected node, may be null
    
    selectedWay - Currently selected way, may be null
    
    Returns:
    
    Node if a suitable node is found, null otherwise
  - mouseDragged
```
public void mouseDragged(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseDragged in interface java.awt.event.MouseMotionListener
    
    Overrides:
    
    mouseDragged in class MapMode
  - mouseMoved
```
public void mouseMoved(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseMoved in interface java.awt.event.MouseMotionListener
    
    Overrides:
    
    mouseMoved in class MapMode
  - tryToSetBaseSegmentForAngleSnap
```
private void tryToSetBaseSegmentForAngleSnap()
```
    This method is used to detect segment under mouse and use it as reference for angle snapping
  - computeHelperLine
```
private void computeHelperLine()
```
    This method prepares data required for painting the "helper line" from the last used position to the mouse cursor. It duplicates some code from mouseReleased() (FIXME).
  - showStatusInfo
```
private static void showStatusInfo(double angle,
                                   double hdg,
                                   double distance,
                                   boolean activeFlag)
```
  - determineCurrentBaseNodeAndPreviousNode
```
private void determineCurrentBaseNodeAndPreviousNode(java.util.Collection<OsmPrimitive> selection)
```
    Helper function that sets fields currentBaseNode and previousNode
    
    Parameters:
    
    selection - uses also lastUsedNode field
  - continueWayFromNode
```
private void continueWayFromNode(Way way,
                                 Node node)
```
    if one of the ends of way is given node, then set currentBaseNode = node and previousNode = adjacent node of way
    
    Parameters:
    
    way - way to continue
    
    node - starting node
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent e)
```
    Repaint on mouse exit so that the helper line goes away.
    
    Specified by:
    
    mouseExited in interface java.awt.event.MouseListener
    
    Overrides:
    
    mouseExited in class MapMode
  - getWayForNode
```
public static Way getWayForNode(Node n)
```
    Parameters:
    
    n - node
    
    Returns:
    
    If the node is the end of exactly one way, return this. null otherwise.
  - getCurrentBaseNode
```
public Node getCurrentBaseNode()
```
    Replies the current base node, after having checked it is still usable (see #11105).
    
    Returns:
    
    the current base node (can be null). If not-null, it's guaranteed the node is usable
  - pruneSuccsAndReverse
```
private static void pruneSuccsAndReverse(java.util.List<java.lang.Integer> is)
```
  - adjustNode
```
private static void adjustNode(java.util.Collection<Pair<Node,Node>> segs,
                               Node n)
```
    Adjusts the position of a node to lie on a segment (or a segment intersection). If one or more than two segments are passed, the node is adjusted to lie on the first segment that is passed. If two segments are passed, the node is adjusted to be at their intersection. No action is taken if no segments are passed.
    
    Parameters:
    
    segs - the segments to use as a reference when adjusting
    
    n - the node to adjust
  - det
```
static double det(double a,
                  double b,
                  double c,
                  double d)
```
  - tryToMoveNodeOnIntersection
```
private void tryToMoveNodeOnIntersection(java.util.List<WaySegment> wss,
                                         Node n)
```
  - addHighlighting
```
private void addHighlighting()
```
    Takes the data from computeHelperLine to determine which ways/nodes should be highlighted (if feature enabled). Also sets the target cursor if appropriate. It adds the to-be- highlighted primitives to newHighlights but does not actually highlight them. This work is done in redrawIfRequired. This means, calling addHighlighting() without redrawIfRequired() will leave the data in an inconsistent state. The status bar derives its information from oldHighlights, so in order to update the status bar both addHighlighting() and repaintIfRequired() are needed, since former fills newHighlights and latter processes them into oldHighlights.
  - removeHighlighting
```
private boolean removeHighlighting()
```
    Removes target highlighting from primitives. Issues repaint if required.
    
    Returns:
    
    true if a repaint has been issued.
  - paint
```
public void paint(java.awt.Graphics2D g,
                  MapView mv,
                  Bounds box)
```
    Description copied from interface: MapViewPaintable
    
    Paint the dataset using the engine set.
    
    Specified by:
    
    paint in interface MapViewPaintable
    
    Parameters:
    
    g - Graphics
    
    mv - The object that can translate GeoPoints to screen coordinates.
    
    box - Bounding box
  - getModeHelpText
```
public java.lang.String getModeHelpText()
```
    Overrides:
    
    getModeHelpText in class MapMode
  - getInProgressSelection
```
public java.util.Collection<OsmPrimitive> getInProgressSelection()
```
    Get selected primitives, while draw action is in progress. While drawing a way, technically the last node is selected. This is inconvenient when the user tries to add/edit tags to the way. For this case, this method returns the current way as selection, to work around this issue. Otherwise the normal selection of the current data layer is returned.
    
    Returns:
    
    selected primitives, while draw action is in progress
  - layerIsSupported
```
public boolean layerIsSupported(Layer l)
```
    Description copied from class: MapMode
    
    Determines if layer l is supported by this map mode. By default, all tools will work with all layers. Can be overwritten to require a special type of layer
    
    Overrides:
    
    layerIsSupported in class MapMode
    
    Parameters:
    
    l - layer
    
    Returns:
    
    true if the layer is supported by this map mode
  - updateEnabledState
```
protected void updateEnabledState()
```
    Description copied from class: JosmAction
    
    Override in subclasses to update the enabled state of the action when something in the JOSM state changes, i.e. when a layer is removed or added. See JosmAction.updateEnabledState(Collection) to respond to changes in the collection of selected primitives. Default behavior is empty.
    
    Overrides:
    
    updateEnabledState in class JosmAction
    
    See Also:
    
    JosmAction.updateEnabledState(Collection), JosmAction.initEnabledState(), JosmAction.listenToLayerChange()
  - destroy
```
public void destroy()
```
    Description copied from interface: Destroyable
    
    Called when the object has been destroyed.
    
    Specified by:
    
    destroy in interface Destroyable
    
    Overrides:
    
    destroy in class JosmAction

Class DrawAction

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.actions.JosmAction

Nested classes/interfaces inherited from interface org.openstreetmap.josm.gui.layer.MapViewPaintable

Field Summary

Fields inherited from class org.openstreetmap.josm.actions.mapmode.MapMode

Fields inherited from class org.openstreetmap.josm.actions.JosmAction

Fields inherited from class javax.swing.AbstractAction

Fields inherited from interface javax.swing.Action

Constructor Summary

Method Summary

Methods inherited from class org.openstreetmap.josm.actions.mapmode.MapMode

Methods inherited from class org.openstreetmap.josm.actions.JosmAction

Methods inherited from class javax.swing.AbstractAction

Methods inherited from class java.lang.Object

Field Detail

ORANGE_TRANSPARENT

PHI

cursorJoinNode

cursorJoinWay

lastUsedNode

toleranceMultiplier

mouseOnExistingNode

mouseOnExistingWays

oldHighlights

newHighlights

drawHelperLine

wayIsFinished

drawTargetHighlight

mousePos

oldMousePos

rubberLineColor

currentBaseNode

previousNode

currentMouseEastNorth

snapHelper

backspaceShortcut

backspaceAction

snappingShortcut

ignoreNextKeyRelease

snapChangeAction

snapCheckboxMenuItem

useRepeatedShortcut

rubberLineStroke

BASIC_STROKE

snapToIntersectionThreshold

rightClickPressPos

Constructor Detail

DrawAction

Method Detail

addMenuItem

redrawIfRequired

addRemoveSelection

enterMode

readPreferences

exitMode

modifiersChanged

doKeyPressed

doKeyReleased

selectionChanged

tryAgain

finishDrawing

mousePressed

mouseReleased

insertNodeIntoAllNearbySegments

isSelfContainedWay

findNodeToContinueFrom

mouseDragged

mouseMoved

tryToSetBaseSegmentForAngleSnap

computeHelperLine

showStatusInfo

determineCurrentBaseNodeAndPreviousNode

continueWayFromNode

mouseExited

getWayForNode

getCurrentBaseNode

pruneSuccsAndReverse

adjustNode

det