OverlayMarker (LOCI Javadocs 0-SNAPSHOT API)

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

public class OverlayMarker
extends OverlayObject

OverlayMarker is a marker crosshairs 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[]`	`STAT_TYPES`
`protected float`	`width` The default width of the marker.

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
`OverlayMarker(OverlayTransform overlay)` Constructs an uninitialized measurement marker.
`OverlayMarker(OverlayTransform overlay, float x, float y)` Constructs a measurement marker.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataImpl`	`getData()` Gets VisAD data object representing this overlay.
`protected float`	`getDefaultWidth()` Returns the defualt width of this marker.
`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.
`protected float`	`getWidth()` Returns the width of this marker.
`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`	`isScalable()` OverlayMarker's are scalable--returns true.
`void`	`rescale(float multiplier)` Rescales an OverlayMarker.
`String`	`toString()` Gets a short string representation of this measurement marker.

Methods inherited from class loci.visbio.overlays.OverlayObject
areBoundsEditable, canBeFilled, getColor, getGroup, getNotes, getText, getX, getX2, getY, getY2, hasEndpoint2, hasText, isDrawing, isFilled, isSelected, 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
  - STAT_TYPES
```
protected static final String[] STAT_TYPES
```
  - width
```
protected float width
```
    The default width of the marker.
- Constructor Detail
  - OverlayMarker
```
public OverlayMarker(OverlayTransform overlay)
```
    Constructs an uninitialized measurement marker.
  - OverlayMarker
```
public OverlayMarker(OverlayTransform overlay,
                     float x,
                     float y)
```
    Constructs a measurement marker.
- 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
  - isScalable
```
public boolean isScalable()
```
    OverlayMarker's are scalable--returns true.
    
    Overrides:
    
    isScalable in class OverlayObject
  - rescale
```
public void rescale(float multiplier)
```
    Rescales an OverlayMarker.
    
    Overrides:
    
    rescale in class OverlayObject
  - getDefaultWidth
```
protected float getDefaultWidth()
```
    Returns the defualt width of this marker.
  - getWidth
```
protected float getWidth()
```
    Returns the width of this marker.
  - toString
```
public String toString()
```
    Gets a short string representation of this measurement marker.
    
    Overrides:
    
    toString in class Object

Class OverlayMarker

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

STAT_TYPES

width

Constructor Detail

OverlayMarker

OverlayMarker

Method Detail

getStatTypes

hasData

getData

getDistance

getStat

getStatistics

hasEndpoint

isScalable

rescale

getDefaultWidth

getWidth

toString