FreeformTool (LOCI Javadocs 0-SNAPSHOT API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class FreeformTool.DistanceQuery
Wraps information about the distance from a point to a freeform object.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`FreeformTool.DistanceQuery` Wraps information about the distance from a point to a freeform object.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`CHILL` Constant for "wait" mode.
`protected float`	`downX` Point at which mouseDown occurs.
`protected float`	`downY` Point at which mouseDown occurs.
`protected static int`	`DRAW` Consant for "draw" mode.
`protected static double`	`DRAW_THRESH` When drawing or editing, how far mouse must be dragged before new node is added.
`protected static int`	`EDIT` Constant for "edit" mode.
`protected static double`	`EDIT_THRESH` Threshhold within which click must occur to invoke edit mode.
`protected static int`	`ERASE` Constant for "erase" mode.
`protected static double`	`ERASE_THRESH` How close a mouseDrag event must be to a node in order to erase it.
`protected OverlayFreeform`	`freeform` Curve currently being drawn or modified.
`protected FreeformExtension`	`freeformExtension` FreeformExtension wraps info about an edit to a curve.
`protected static int`	`INIT` Constant for "init" mode.
`protected int`	`mode` Stores the current mode (INIT, ERASE, CHILL, DRAW, EDIT).
`protected Vector`	`otherFreefs` Other freeforms on the canvas.
`protected static double`	`RECONNECT_THRESH` Threshhold within which click must occur to invoke extend mode or reconnect a freeformExtension.
`protected static double`	`RESUME_THRESH` How close mouse must be to end node to resume drawing.
`protected static float`	`S` Smoothing factor for "single exponential smoothing".

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

Constructor Summary

Constructors
Constructor and Description

FreeformTool(OverlayTransform overlay)
Constructs a freeform creation tool.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`eraseNearestNodeWithin(float thresh, float x, float y)` Erases the nearest node of freeforms nearby.
`protected FreeformTool.DistanceQuery`	`getClosestFreeform(DisplayImpl display, double dpx, double dpy, double thresh)` Returns the closest (subject to a threshhold) OverlayFreeform object to the given point.
`protected Vector`	`getFreeforms(boolean includeThis)` Compiles a list of other freeforms at the current dimensional position.
`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`	`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.
`protected void`	`removeEmptyFreeforms(OverlayFreeform[] objs)` Removes any freeforms with one or fewer nodes.

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

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

- Field Detail
  - DRAW_THRESH
```
protected static final double DRAW_THRESH
```
    When drawing or editing, how far mouse must be dragged before new node is added.
  - ERASE_THRESH
```
protected static final double ERASE_THRESH
```
    How close a mouseDrag event must be to a node in order to erase it.
  - EDIT_THRESH
```
protected static final double EDIT_THRESH
```
    Threshhold within which click must occur to invoke edit mode.
  - RECONNECT_THRESH
```
protected static final double RECONNECT_THRESH
```
    Threshhold within which click must occur to invoke extend mode or reconnect a freeformExtension.
  - RESUME_THRESH
```
protected static final double RESUME_THRESH
```
    How close mouse must be to end node to resume drawing.
  - S
```
protected static final float S
```
    Smoothing factor for "single exponential smoothing".
  - ERASE
```
protected static final int ERASE
```
    Constant for "erase" mode.
    
    See Also:
    
    Constant Field Values
  - CHILL
```
protected static final int CHILL
```
    Constant for "wait" mode.
    
    See Also:
    
    Constant Field Values
  - DRAW
```
protected static final int DRAW
```
    Consant for "draw" mode.
    
    See Also:
    
    Constant Field Values
  - EDIT
```
protected static final int EDIT
```
    Constant for "edit" mode.
    
    See Also:
    
    Constant Field Values
  - INIT
```
protected static final int INIT
```
    Constant for "init" mode.
    
    See Also:
    
    Constant Field Values
  - freeform
```
protected OverlayFreeform freeform
```
    Curve currently being drawn or modified.
  - otherFreefs
```
protected Vector otherFreefs
```
    Other freeforms on the canvas.
  - freeformExtension
```
protected FreeformExtension freeformExtension
```
    FreeformExtension wraps info about an edit to a curve.
  - mode
```
protected int mode
```
    Stores the current mode (INIT, ERASE, CHILL, DRAW, EDIT).
  - downX
```
protected float downX
```
    Point at which mouseDown occurs.
  - downY
```
protected float downY
```
    Point at which mouseDown occurs.
- Constructor Detail
  - FreeformTool
```
public FreeformTool(OverlayTransform overlay)
```
    Constructs a freeform 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.
  - getFreeforms
```
protected Vector getFreeforms(boolean includeThis)
```
    Compiles a list of other freeforms at the current dimensional position.
  - eraseNearestNodeWithin
```
protected void eraseNearestNodeWithin(float thresh,
                                      float x,
                                      float y)
```
    Erases the nearest node of freeforms nearby.
  - removeEmptyFreeforms
```
protected void removeEmptyFreeforms(OverlayFreeform[] objs)
```
    Removes any freeforms with one or fewer nodes.
  - getClosestFreeform
```
protected FreeformTool.DistanceQuery getClosestFreeform(DisplayImpl display,
                                                        double dpx,
                                                        double dpy,
                                                        double thresh)
```
    Returns the closest (subject to a threshhold) OverlayFreeform object to the given point.
  - print
```
public void print(String methodName,
                  String message)
```
    Prints a message for debugging.

Class FreeformTool

Nested Class Summary

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

DRAW_THRESH

ERASE_THRESH

EDIT_THRESH

RECONNECT_THRESH

RESUME_THRESH

S

ERASE

CHILL

DRAW

EDIT

INIT

freeform

otherFreefs

freeformExtension

mode

downX

downY

Constructor Detail

FreeformTool

Method Detail

mouseDown

mouseDrag

mouseUp

getFreeforms

eraseNearestNodeWithin

removeEmptyFreeforms

getClosestFreeform

print