PolylineTool (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.overlays.OverlayTool
- - loci.visbio.overlays.PolylineTool

```
public class PolylineTool
extends OverlayTool
```
FreeformTool is the tool for creating freeform objects.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`ADJUST`
`protected static int`	`ADJUST_TAIL`
`protected static int`	`BEGIN_EXTEND`
`protected static int`	`CLOSE_LOOP`
`protected static int`	`EXTEND`
`protected static int`	`EXTEND_ON_TAIL`
`protected OverlayPolyline`	`line` Curve currently being drawn or modified.
`protected int`	`mode` The current mode of the state machine represented in/by the mouse methods of this tool.
`protected static int`	`PLACE`
`protected static int`	`SELECT`
`protected static int`	`SELECTED_TAIL`
`protected int`	`selectedNode` Nearest node on selected PolyLine.
`protected static double`	`THRESH` Maximum distance (in pixels) mouse can be from a node to be considered pointing to it.
`protected static int`	`WAIT` The Different modes of this tool.

Fields inherited from class loci.visbio.overlays.OverlayTool
icon, name, overlay, tip

Constructor Summary

Constructors
Constructor and Description

PolylineTool(OverlayTransform overlay)
Constructs a creation tool.

Constructors
Constructor and Description
`PolylineTool(OverlayTransform overlay)` Constructs a creation tool.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`mouseDown(DisplayEvent e, int px, int py, float dx, float dy, int[] pos, int mods)` Instructs this tool to respond to a mouse press.
`void`	`mouseDrag(DisplayEvent e, int px, int py, float dx, float dy, int[] pos, int mods)` Instructs this tool to respond to a mouse drag.
`void`	`mouseMoved(DisplayEvent e, int px, int py, float dx, float dy, int[] pos, int mods)` Instructs this tool to respond to a mouse movement.
`void`	`mouseUp(DisplayEvent e, int px, int py, float dx, float dy, int[] pos, int mods)` Instructs this tool to respond to a mouse release.
`void`	`print(String methodName, String message)` Prints a message for debugging.

Methods inherited from class loci.visbio.overlays.OverlayTool
deselectAll, getIcon, getName, getTip, getTransform, keyPressed, keyReleased

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

- Field Detail
  - WAIT
```
protected static final int WAIT
```
    The Different modes of this tool.
    
    See Also:
    
    Constant Field Values
  - EXTEND
```
protected static final int EXTEND
```
    See Also:
    
    Constant Field Values
  - ADJUST
```
protected static final int ADJUST
```
    See Also:
    
    Constant Field Values
  - SELECT
```
protected static final int SELECT
```
    See Also:
    
    Constant Field Values
  - PLACE
```
protected static final int PLACE
```
    See Also:
    
    Constant Field Values
  - ADJUST_TAIL
```
protected static final int ADJUST_TAIL
```
    See Also:
    
    Constant Field Values
  - CLOSE_LOOP
```
protected static final int CLOSE_LOOP
```
    See Also:
    
    Constant Field Values
  - SELECTED_TAIL
```
protected static final int SELECTED_TAIL
```
    See Also:
    
    Constant Field Values
  - EXTEND_ON_TAIL
```
protected static final int EXTEND_ON_TAIL
```
    See Also:
    
    Constant Field Values
  - BEGIN_EXTEND
```
protected static final int BEGIN_EXTEND
```
    See Also:
    
    Constant Field Values
  - THRESH
```
protected static final double THRESH
```
    Maximum distance (in pixels) mouse can be from a node to be considered pointing to it.
  - line
```
protected OverlayPolyline line
```
    Curve currently being drawn or modified.
  - selectedNode
```
protected int selectedNode
```
    Nearest node on selected PolyLine.
  - mode
```
protected int mode
```
    The current mode of the state machine represented in/by the mouse methods of this tool.
- Constructor Detail
  - PolylineTool
```
public PolylineTool(OverlayTransform overlay)
```
    Constructs a creation tool.
- Method Detail
  - mouseDown
```
public void mouseDown(DisplayEvent e,
                      int px,
                      int py,
                      float dx,
                      float dy,
                      int[] pos,
                      int mods)
```
    Instructs this tool to respond to a mouse press.
    
    Overrides:
    
    mouseDown in class OverlayTool
    
    Parameters:
    
    e - DisplayEvent corresponding to this mouse press.
    
    px - X coordinate of mouse press in pixel coordinate system.
    
    py - Y coordinate of mouse press in pixel coordinate system.
    
    dx - X coordinate of mouse press in data coordinate system.
    
    dy - Y coordinate of mouse press in data coordinate system.
    
    pos - Dimensional position of mouse press.
    
    mods - Modifiers of mouse press.
  - mouseDrag
```
public void mouseDrag(DisplayEvent e,
                      int px,
                      int py,
                      float dx,
                      float dy,
                      int[] pos,
                      int mods)
```
    Instructs this tool to respond to a mouse drag.
    
    Overrides:
    
    mouseDrag in class OverlayTool
    
    Parameters:
    
    e - DisplayEvent corresponding to this mouse drag.
    
    px - X coordinate of mouse drag in pixel coordinate system.
    
    py - Y coordinate of mouse drag in pixel coordinate system.
    
    dx - X coordinate of mouse drag in data coordinate system.
    
    dy - Y coordinate of mouse drag in data coordinate system.
    
    pos - Dimensional position of mouse drag.
    
    mods - Modifiers of mouse drag.
  - mouseUp
```
public void mouseUp(DisplayEvent e,
                    int px,
                    int py,
                    float dx,
                    float dy,
                    int[] pos,
                    int mods)
```
    Instructs this tool to respond to a mouse release.
    
    Overrides:
    
    mouseUp in class OverlayTool
    
    Parameters:
    
    e - DisplayEvent corresponding to this mouse release.
    
    px - X coordinate of mouse release in pixel coordinate system.
    
    py - Y coordinate of mouse release in pixel coordinate system.
    
    dx - X coordinate of mouse release in data coordinate system.
    
    dy - Y coordinate of mouse release in data coordinate system.
    
    pos - Dimensional position of mouse release.
    
    mods - Modifiers of mouse release.
  - mouseMoved
```
public void mouseMoved(DisplayEvent e,
                       int px,
                       int py,
                       float dx,
                       float dy,
                       int[] pos,
                       int mods)
```
    Instructs this tool to respond to a mouse movement.
    
    Overrides:
    
    mouseMoved in class OverlayTool
    
    Parameters:
    
    e - DisplayEvent corresponding to this mouse movement.
    
    px - X coordinate of mouse movement in pixel coordinate system.
    
    py - Y coordinate of mouse movement in pixel coordinate system.
    
    dx - X coordinate of mouse movement in data coordinate system.
    
    dy - Y coordinate of mouse movement in data coordinate system.
    
    pos - Dimensional position of mouse movement.
    
    mods - Modifiers of mouse movement.
  - print
```
public void print(String methodName,
                  String message)
```
    Prints a message for debugging.

Class PolylineTool

Field Summary

Fields inherited from class loci.visbio.overlays.OverlayTool

Constructor Summary

Method Summary

Methods inherited from class loci.visbio.overlays.OverlayTool

Methods inherited from class java.lang.Object

Field Detail

WAIT

EXTEND

ADJUST

SELECT

PLACE

ADJUST_TAIL

CLOSE_LOOP

SELECTED_TAIL

EXTEND_ON_TAIL

BEGIN_EXTEND

THRESH

line

selectedNode

mode

Constructor Detail

PolylineTool

Method Detail

mouseDown

mouseDrag

mouseUp

mouseMoved

print