FreeformExtension (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.overlays.FreeformExtension

```
public class FreeformExtension
extends Object
```
The FreeformExtension class wraps information for the temporary section of a freeform, which appears like a tendril on screen, created during an edit of an existing freeform. The FreeformTool uses this information to modify the freeform if the edit is successful, or to remove the freeform extension if the edit is aborted. The section of the freeform represented by a freeform extension is actually a loop, but it's thin (both sides overlap exactly) so it appears like a single line. The loop has two parts, between start and tip and between tip and stop. If an edit is completed, half of the freeform extension is deleted along with the subtended section of the original freeform. As a result, the tendril appears to be spliced into the old freeform.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static double`	`DRAW_THRESH` When drawing or editing, how far mouse must be dragged before new node is added.
`protected OverlayFreeform`	`freeform` The freeform to which this extension is attached.
`protected boolean`	`nodal` Whether this freeform extension began on a node or in the middle of a segment.
`protected float[][]`	`post` Chunks of curve before and after the extension.
`protected float[][]`	`pre` Chunks of curve before and after the extension.
`protected static double`	`RECONNECT_THRESH` Threshhold within which click must occur to invoke extend mode or reconnect a freeformExtension.
`protected static float`	`SMOOTHING_FACTOR` Smoothing factor for "single exponential smoothing".
`protected int`	`start` The index of the last node of the freeform extension.
`protected int`	`stop` The index of the last node of the freeform extension.
`protected int`	`tip` The index of the tip node of the freeform extension.

Constructor Summary

Constructors
Constructor and Description
`FreeformExtension(OverlayFreeform freeform, int start, int stop, boolean nodal)` Constructs a new freeform extension.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`computeDragDist(DisplayImpl display, int px, int py)` Computes distance between mouse drag and tip of extension.
`void`	`extend(float[] c)` Extends the tip of the freeform extension by "one" node.
`boolean`	`extendOrReconnect(DisplayImpl display, float dx, float dy, int px, int py, boolean shift)` Extends the extension, reconnecting it with the curve proper if appropriate.
`double[]`	`getDistanceToSection(float[][] section, DisplayImpl display, double dpx, double dpy)` Computes distance between a point and a section of the freeform.
`float[]`	`getTipCoords()` Returns the coordinates of the extension's tip or start node.
`boolean`	`hasBegun()` Whether this extension has begun or remains in the initial state.
`void`	`incrementAll()` Simultaneously increments all extension pointers into node array, to adjust for the insertion of a node before the base of the extension.
`void`	`reconnect(int seg, double weight, boolean closerToPost)` Reconnects the extension with the freeform.

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

- Field Detail
  - SMOOTHING_FACTOR
```
protected static final float SMOOTHING_FACTOR
```
    Smoothing factor for "single exponential smoothing".
  - DRAW_THRESH
```
protected static final double DRAW_THRESH
```
    When drawing or editing, how far mouse must be dragged before new node is added.
  - RECONNECT_THRESH
```
protected static final double RECONNECT_THRESH
```
    Threshhold within which click must occur to invoke extend mode or reconnect a freeformExtension.
  - freeform
```
protected OverlayFreeform freeform
```
    The freeform to which this extension is attached.
  - start
```
protected int start
```
    The index of the last node of the freeform extension.
  - stop
```
protected int stop
```
    The index of the last node of the freeform extension.
  - tip
```
protected int tip
```
    The index of the tip node of the freeform extension.
  - pre
```
protected float[][] pre
```
    Chunks of curve before and after the extension.
  - post
```
protected float[][] post
```
    Chunks of curve before and after the extension.
  - nodal
```
protected boolean nodal
```
    Whether this freeform extension began on a node or in the middle of a segment.
- Constructor Detail
  - FreeformExtension
```
public FreeformExtension(OverlayFreeform freeform,
                         int start,
                         int stop,
                         boolean nodal)
```
    Constructs a new freeform extension.
- Method Detail
  - hasBegun
```
public boolean hasBegun()
```
    Whether this extension has begun or remains in the initial state.
  - extendOrReconnect
```
public boolean extendOrReconnect(DisplayImpl display,
                                 float dx,
                                 float dy,
                                 int px,
                                 int py,
                                 boolean shift)
```
    Extends the extension, reconnecting it with the curve proper if appropriate.
  - getDistanceToSection
```
public double[] getDistanceToSection(float[][] section,
                                     DisplayImpl display,
                                     double dpx,
                                     double dpy)
```
    Computes distance between a point and a section of the freeform.
  - computeDragDist
```
public double computeDragDist(DisplayImpl display,
                              int px,
                              int py)
```
    Computes distance between mouse drag and tip of extension.
  - extend
```
public void extend(float[] c)
```
    Extends the tip of the freeform extension by "one" node.
  - reconnect
```
public void reconnect(int seg,
                      double weight,
                      boolean closerToPost)
```
    Reconnects the extension with the freeform.
  - getTipCoords
```
public float[] getTipCoords()
```
    Returns the coordinates of the extension's tip or start node.
  - incrementAll
```
public void incrementAll()
```
    Simultaneously increments all extension pointers into node array, to adjust for the insertion of a node before the base of the extension.

Class FreeformExtension

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SMOOTHING_FACTOR

DRAW_THRESH

RECONNECT_THRESH

freeform

start

stop

tip

pre

post

nodal

Constructor Detail

FreeformExtension

Method Detail

hasBegun

extendOrReconnect

getDistanceToSection

computeDragDist

extend

reconnect

getTipCoords

incrementAll