Line (NDViewer image viewer 0.9.1 API)

java.lang.Object
- org.micromanager.ndviewer.overlay.Roi
- - org.micromanager.ndviewer.overlay.Line

All Implemented Interfaces:

Serializable, Cloneable
```
public class Line
extends Roi
```
This class represents a straight line selection.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`startxd`
`protected double`	`startyd`
`int`	`x1`
`double`	`x1d`
`protected double`	`x1R`
`int`	`x2`
`double`	`x2d`
`protected double`	`x2R`
`int`	`y1`
`double`	`y1d`
`protected double`	`y1R`
`int`	`y2`
`double`	`y2d`
`protected double`	`y2R`

Fields inherited from class org.micromanager.ndviewer.overlay.Roi
ANGLE, asp_bk, aspect, center, clipHeight, clipWidth, clipX, clipY, COMPOSITE, constrain, CONSTRUCTING, defaultFillColor, fillColor, FREELINE, FREEROI, HANDLE_SIZE, handleColor, ignoreClipRect, instanceColor, LINE, lineWidth, mag, MOVING, MOVING_HANDLE, nonScalable, NORMAL, NOT_PASTING, oldHeight, oldWidth, oldX, oldY, onePixelWide, OVAL, overlay, POINT, POLYGON, POLYLINE, previousRoi, RECTANGLE, RESIZING, ROIColor, stroke, strokeColor, TRACED_ROI, type, updateFullWindow, wideLine, xMax, yMax

Constructor Summary

Constructors
Constructor and Description
`Line(double ox1, double oy1, double ox2, double oy2)` Creates a new straight line selection using the specified starting and ending offscreen double coordinates.
`Line(int ox1, int oy1, int ox2, int oy2)` Creates a new straight line selection using the specified starting and ending offscreen integer coordinates.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`clipRectMargin()`
`boolean`	`contains(int x, int y)`
`void`	`draw(Graphics g)` Draws this line on the image.
`protected void`	`drawLine(int sx, int sy)`
`Rectangle`	`getBounds()` Return the bounding rectangle of this line.
`boolean`	`getDrawOffset()` Returns true if this is a PolygonRoi that supports sub-pixel resolution and polygons are drawn on zoomed images offset down and to the right by 0.5 pixels..
`Polygon`	`getPoints()` Returns, as a Polygon, the two points that define this line.
`double`	`getRawLength()` Returns the length of this line in pixels.
`static int`	`getWidth()`
`protected void`	`grow(int sx, int sy)`
`void`	`mouseMoved(MouseEvent e)`
`void`	`setDrawOffset(boolean drawOffset)`
`void`	`setLocation(int x, int y)` Set the location of the ROI in image coordinates.
`void`	`setStrokeWidth(float width)` Sets the width of the line used to draw this ROI.
`static void`	`setWidth(int w)`
`boolean`	`subPixelResolution()` Always returns true.

Methods inherited from class org.micromanager.ndviewer.overlay.Roi
copyAttributes, drawOverlay, enableSubPixelResolution, getAngle, getBoundingRect, getColor, getConvexHull, getCornerDiameter, getCPosition, getDebugInfo, getDefaultFillColor, getFillColor, getFloatBounds, getFloatHeight, getFloatWidth, getHashCode, getName, getPolygon, getPosition, getProperties, getProperty, getPropertyCount, getPrototypeOverlay, getRoundRectArcSize, getState, getStroke, getStrokeColor, getStrokeWidth, getTPosition, getType, getTypeAsString, getXBase, getYBase, getZPosition, isArea, isCursor, isDrawingTool, isLine, setColor, setCornerDiameter, setDefaultFillColor, setFillColor, setIgnoreClipRect, setIsCursor, setLocation, setName, setNonScalable, setPosition, setPosition, setProperty, setPrototypeOverlay, setRotationCenter, setRoundRectArcSize, setStroke, setStrokeColor, setStrokeWidth, temporarilyHide, toFloat, toInt, toInt, toIntR, toString

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

- Field Detail
  - x1
```
public int x1
```
  - y1
```
public int y1
```
  - x2
```
public int x2
```
  - y2
```
public int y2
```
  - x1d
```
public double x1d
```
  - y1d
```
public double y1d
```
  - x2d
```
public double x2d
```
  - y2d
```
public double y2d
```
  - x1R
```
protected double x1R
```
  - y1R
```
protected double y1R
```
  - x2R
```
protected double x2R
```
  - y2R
```
protected double y2R
```
  - startxd
```
protected double startxd
```
  - startyd
```
protected double startyd
```
- Constructor Detail
  - Line
```
public Line(int ox1,
            int oy1,
            int ox2,
            int oy2)
```
    Creates a new straight line selection using the specified starting and ending offscreen integer coordinates.
  - Line
```
public Line(double ox1,
            double oy1,
            double ox2,
            double oy2)
```
    Creates a new straight line selection using the specified starting and ending offscreen double coordinates.
- Method Detail
  - grow
```
protected void grow(int sx,
                    int sy)
```
  - mouseMoved
```
public void mouseMoved(MouseEvent e)
```
  - drawLine
```
protected void drawLine(int sx,
                        int sy)
```
  - draw
```
public void draw(Graphics g)
```
    Draws this line on the image.
    
    Overrides:
    
    draw in class Roi
  - getRawLength
```
public double getRawLength()
```
    Returns the length of this line in pixels.
  - getPoints
```
public Polygon getPoints()
```
    Returns, as a Polygon, the two points that define this line.
  - contains
```
public boolean contains(int x,
                        int y)
```
    Overrides:
    
    contains in class Roi
  - getWidth
```
public static int getWidth()
```
  - setWidth
```
public static void setWidth(int w)
```
  - setStrokeWidth
```
public void setStrokeWidth(float width)
```
    Description copied from class: Roi
    
    Sets the width of the line used to draw this ROI. Set the width to 0.0 and the ROI will be drawn using a a 1 pixel stroke width regardless of the magnification.
    
    Overrides:
    
    setStrokeWidth in class Roi
    
    See Also:
    
    Roi.setStrokeColor(Color)
  - getBounds
```
public Rectangle getBounds()
```
    Return the bounding rectangle of this line.
    
    Overrides:
    
    getBounds in class Roi
  - clipRectMargin
```
protected int clipRectMargin()
```
    Overrides:
    
    clipRectMargin in class Roi
  - getDrawOffset
```
public boolean getDrawOffset()
```
    Description copied from class: Roi
    
    Returns true if this is a PolygonRoi that supports sub-pixel resolution and polygons are drawn on zoomed images offset down and to the right by 0.5 pixels..
    
    Overrides:
    
    getDrawOffset in class Roi
  - setDrawOffset
```
public void setDrawOffset(boolean drawOffset)
```
    Overrides:
    
    setDrawOffset in class Roi
  - subPixelResolution
```
public boolean subPixelResolution()
```
    Always returns true.
    
    Overrides:
    
    subPixelResolution in class Roi
  - setLocation
```
public void setLocation(int x,
                        int y)
```
    Description copied from class: Roi
    
    Set the location of the ROI in image coordinates.
    
    Overrides:
    
    setLocation in class Roi

Class Line

Field Summary

Fields inherited from class org.micromanager.ndviewer.overlay.Roi

Constructor Summary

Method Summary

Methods inherited from class org.micromanager.ndviewer.overlay.Roi

Methods inherited from class java.lang.Object

Field Detail

x1

y1

x2

y2

x1d

y1d

x2d

y2d

x1R

y1R

x2R

y2R

startxd

startyd

Constructor Detail

Line

Line

Method Detail

grow

mouseMoved

drawLine

draw

getRawLength

getPoints

contains

getWidth

setWidth

setStrokeWidth

getBounds

clipRectMargin

getDrawOffset

setDrawOffset

subPixelResolution

setLocation