OverlayLine (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.overlays.OverlayObject
- - loci.visbio.overlays.OverlayLine

public class OverlayLine
extends OverlayObject

OverlayLine is a measurement line overlay.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`COORDS` The names of the statistics this object reports.
`protected static String`	`LENGTH`
`protected static String[]`	`STAT_TYPES`

Fields inherited from class loci.visbio.overlays.OverlayObject
color, drawing, filled, GLOW_ALPHA, GLOW_COLOR, GLOW_WIDTH, group, horizGridCount, notes, overlay, selected, text, vertGridCount, x1, x2, xGrid1, xGrid2, xGrid3, xGrid4, y1, y2, yGrid1, yGrid2, yGrid3, yGrid4

Constructor Summary

Constructors
Constructor and Description
`OverlayLine(OverlayTransform overlay)` Constructs an uninitialized measurement line.
`OverlayLine(OverlayTransform overlay, float x1, float y1, float x2, float y2)` Constructs a measurement line.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static float[]`	`computeCorners(float x1, float y1, float x2, float y2, float padding, float multiplier)` Helper method for computing coordinates of two corner points of the rectangular selection grid for a line or arrow overlay.
`DataImpl`	`getData()` Gets VisAD data object representing this overlay.
`double`	`getDistance(double x, double y)` Computes the shortest distance from this object to the given point.
`String`	`getStat(String name)` Returns a specific statistic of this object.
`String`	`getStatistics()` Retrieves useful statistics about this overlay.
`static String[]`	`getStatTypes()` Returns the names of the statistics this object reports.
`boolean`	`hasData()` Returns whether this object is drawable, i.e., is of nonzero size, area, length, etc.
`boolean`	`hasEndpoint()` True iff this overlay has an endpoint coordinate pair.
`boolean`	`hasEndpoint2()` True iff this overlay has a second endpoint coordinate pair.
`String`	`toString()` Gets a short string representation of this measurement line.

Methods inherited from class loci.visbio.overlays.OverlayObject
areBoundsEditable, canBeFilled, getColor, getGroup, getNotes, getText, getX, getX2, getY, getY2, hasText, isDrawing, isFilled, isScalable, isSelected, rescale, setBoundaries, setColor, setCoords, setCoords2, setDrawing, setFilled, setGroup, setNotes, setSelected, setText, setX, setX2, setY, setY2

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

- Field Detail
  - COORDS
```
protected static final String COORDS
```
    The names of the statistics this object reports.
    
    See Also:
    
    Constant Field Values
  - LENGTH
```
protected static final String LENGTH
```
    See Also:
    
    Constant Field Values
  - STAT_TYPES
```
protected static final String[] STAT_TYPES
```
- Constructor Detail
  - OverlayLine
```
public OverlayLine(OverlayTransform overlay)
```
    Constructs an uninitialized measurement line.
  - OverlayLine
```
public OverlayLine(OverlayTransform overlay,
                   float x1,
                   float y1,
                   float x2,
                   float y2)
```
    Constructs a measurement line.
- Method Detail
  - getStatTypes
```
public static String[] getStatTypes()
```
    Returns the names of the statistics this object reports.
  - hasData
```
public boolean hasData()
```
    Returns whether this object is drawable, i.e., is of nonzero size, area, length, etc.
    
    Specified by:
    
    hasData in class OverlayObject
  - getData
```
public DataImpl getData()
```
    Gets VisAD data object representing this overlay.
    
    Specified by:
    
    getData in class OverlayObject
  - getDistance
```
public double getDistance(double x,
                          double y)
```
    Computes the shortest distance from this object to the given point.
    
    Specified by:
    
    getDistance in class OverlayObject
  - getStat
```
public String getStat(String name)
```
    Returns a specific statistic of this object.
    
    Specified by:
    
    getStat in class OverlayObject
  - getStatistics
```
public String getStatistics()
```
    Retrieves useful statistics about this overlay.
    
    Overrides:
    
    getStatistics in class OverlayObject
  - hasEndpoint
```
public boolean hasEndpoint()
```
    True iff this overlay has an endpoint coordinate pair.
    
    Overrides:
    
    hasEndpoint in class OverlayObject
  - hasEndpoint2
```
public boolean hasEndpoint2()
```
    True iff this overlay has a second endpoint coordinate pair.
    
    Overrides:
    
    hasEndpoint2 in class OverlayObject
  - toString
```
public String toString()
```
    Gets a short string representation of this measurement line.
    
    Overrides:
    
    toString in class Object
  - computeCorners
```
protected static float[] computeCorners(float x1,
                                        float y1,
                                        float x2,
                                        float y2,
                                        float padding,
                                        float multiplier)
```
    Helper method for computing coordinates of two corner points of the rectangular selection grid for a line or arrow overlay.

Class OverlayLine

Field Summary

Fields inherited from class loci.visbio.overlays.OverlayObject

Constructor Summary

Method Summary

Methods inherited from class loci.visbio.overlays.OverlayObject

Methods inherited from class java.lang.Object

Field Detail

COORDS

LENGTH

STAT_TYPES

Constructor Detail

OverlayLine

OverlayLine

Method Detail

getStatTypes

hasData

getData

getDistance

getStat

getStatistics

hasEndpoint

hasEndpoint2

toString

computeCorners