OverlayObject (LOCI Javadocs 0-SNAPSHOT API)

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

Direct Known Subclasses:

OverlayArrow, OverlayBox, OverlayLine, OverlayMarker, OverlayNodedObject, OverlayOval, OverlayText
```
public abstract class OverlayObject
extends Object
```
OverlayObject is the superclass of all overlay objects.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Color`	`color` Color of this overlay.
`protected boolean`	`drawing` Flag indicating this overlay is still being initially drawn.
`protected boolean`	`filled` Flag indicating overlay is solid.
`protected static float`	`GLOW_ALPHA`
`protected static Color`	`GLOW_COLOR`
`protected static float`	`GLOW_WIDTH`
`protected String`	`group` Group to which this overlay belongs.
`protected int`	`horizGridCount` Number of horizontal and vertical dividing lines for selection grid.
`protected String`	`notes` Notes associated with this overlay.
`protected OverlayTransform`	`overlay` Associated overlay transform.
`protected boolean`	`selected` Flag indicating this overlay is currently selected.
`protected String`	`text` Text string to render.
`protected int`	`vertGridCount` Number of horizontal and vertical dividing lines for selection grid.
`protected float`	`x1` Endpoint coordinates.
`protected float`	`x2` Endpoint coordinates.
`protected float`	`xGrid1` Top-left endpoint of selection grid rectangle.
`protected float`	`xGrid2` Top-right endpoint of selection grid rectangle.
`protected float`	`xGrid3` Bottom-left endpoint of selection grid rectangle.
`protected float`	`xGrid4` Bottom-right endpoint of selection grid rectangle.
`protected float`	`y1` Endpoint coordinates.
`protected float`	`y2` Endpoint coordinates.
`protected float`	`yGrid1` Top-left endpoint of selection grid rectangle.
`protected float`	`yGrid2` Top-right endpoint of selection grid rectangle.
`protected float`	`yGrid3` Bottom-left endpoint of selection grid rectangle.
`protected float`	`yGrid4` Bottom-right endpoint of selection grid rectangle.

Constructor Summary

Constructors
Constructor and Description

OverlayObject(OverlayTransform overlay)
Constructs an overlay.

Constructors
Constructor and Description
`OverlayObject(OverlayTransform overlay)` Constructs an overlay.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`areBoundsEditable()` True iff this overlay can be resized using X1, X2, Y1, Y2 entry boxes.
`boolean`	`canBeFilled()` True iff this overlay supports the filled parameter.
`Color`	`getColor()` Gets color of this overlay.
`abstract DataImpl`	`getData()` Gets VisAD data object representing this overlay.
`abstract double`	`getDistance(double x, double y)` Computes the shortest distance from this overlay to the given point.
`String`	`getGroup()` Gets group to which this overlay belongs.
`String`	`getNotes()` Gets notes for this overlay.
`abstract String`	`getStat(String name)` Gets a specific overlay statistic.
`String`	`getStatistics()` Retrieves useful statistics about this overlay.
`String`	`getText()` Gets text to render.
`float`	`getX()` Gets X coordinate of the overlay's first endpoint.
`float`	`getX2()` Gets X coordinate of the overlay's second endpoint.
`float`	`getY()` Gets Y coordinate of the overlay's first endpoint.
`float`	`getY2()` Gets Y coordinate of the overlay's second endpoint.
`abstract 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.
`boolean`	`hasText()` True iff this overlay returns text to render.
`boolean`	`isDrawing()` Gets whether this overlay is still being initially drawn.
`boolean`	`isFilled()` Gets whether overlay is solid.
`boolean`	`isScalable()` Gets whether overlay is scalable.
`boolean`	`isSelected()` Gets whether this overlay is currently selected.
`void`	`rescale(float multiplier)` Rescales this overlay object.
`protected void`	`setBoundaries(float x, float y)` Sets value of largest and smallest x, y values.
`void`	`setColor(Color c)` Sets color of this overlay.
`void`	`setCoords(float x1, float y1)` Changes coordinates of the overlay's first endpoint.
`void`	`setCoords2(float x2, float y2)` Changes coordinates of the overlay's second endpoint.
`void`	`setDrawing(boolean drawing)` Sets whether this overlay is still being initially drawn.
`void`	`setFilled(boolean filled)` Sets whether overlay is solid.
`void`	`setGroup(String group)` Sets group to which this overlay belongs.
`void`	`setNotes(String text)` Sets notes for this overlay.
`void`	`setSelected(boolean selected)` Sets whether this overlay is currently selected.
`void`	`setText(String text)` Changes text to render.
`void`	`setX(float x1)` Changes X coordinate of the overlay's first endpoint.
`void`	`setX2(float x2)` Changes X coordinate of the overlay's second endpoint.
`void`	`setY(float y1)` Changes Y coordinate of the overlay's first endpoint.
`void`	`setY2(float y2)` Changes Y coordinate of the overlay's second endpoint.

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

- Field Detail
  - GLOW_WIDTH
```
protected static final float GLOW_WIDTH
```
    See Also:
    
    Constant Field Values
  - GLOW_ALPHA
```
protected static final float GLOW_ALPHA
```
    See Also:
    
    Constant Field Values
  - GLOW_COLOR
```
protected static final Color GLOW_COLOR
```
  - overlay
```
protected OverlayTransform overlay
```
    Associated overlay transform.
  - x1
```
protected float x1
```
    Endpoint coordinates.
  - y1
```
protected float y1
```
    Endpoint coordinates.
  - x2
```
protected float x2
```
    Endpoint coordinates.
  - y2
```
protected float y2
```
    Endpoint coordinates.
  - text
```
protected String text
```
    Text string to render.
  - color
```
protected Color color
```
    Color of this overlay.
  - filled
```
protected boolean filled
```
    Flag indicating overlay is solid.
  - group
```
protected String group
```
    Group to which this overlay belongs.
  - notes
```
protected String notes
```
    Notes associated with this overlay.
  - selected
```
protected boolean selected
```
    Flag indicating this overlay is currently selected.
  - drawing
```
protected boolean drawing
```
    Flag indicating this overlay is still being initially drawn.
  - xGrid1
```
protected float xGrid1
```
    Top-left endpoint of selection grid rectangle.
  - yGrid1
```
protected float yGrid1
```
    Top-left endpoint of selection grid rectangle.
  - xGrid2
```
protected float xGrid2
```
    Top-right endpoint of selection grid rectangle.
  - yGrid2
```
protected float yGrid2
```
    Top-right endpoint of selection grid rectangle.
  - xGrid3
```
protected float xGrid3
```
    Bottom-left endpoint of selection grid rectangle.
  - yGrid3
```
protected float yGrid3
```
    Bottom-left endpoint of selection grid rectangle.
  - xGrid4
```
protected float xGrid4
```
    Bottom-right endpoint of selection grid rectangle.
  - yGrid4
```
protected float yGrid4
```
    Bottom-right endpoint of selection grid rectangle.
  - horizGridCount
```
protected int horizGridCount
```
    Number of horizontal and vertical dividing lines for selection grid.
  - vertGridCount
```
protected int vertGridCount
```
    Number of horizontal and vertical dividing lines for selection grid.
- Constructor Detail
  - OverlayObject
```
public OverlayObject(OverlayTransform overlay)
```
    Constructs an overlay.
- Method Detail
  - hasData
```
public abstract boolean hasData()
```
    Returns whether this object is drawable, i.e., is of nonzero size, area, length, etc.
  - getData
```
public abstract DataImpl getData()
```
    Gets VisAD data object representing this overlay.
  - getDistance
```
public abstract double getDistance(double x,
                                   double y)
```
    Computes the shortest distance from this overlay to the given point.
  - getStat
```
public abstract String getStat(String name)
```
    Gets a specific overlay statistic.
  - getStatistics
```
public String getStatistics()
```
    Retrieves useful statistics about this overlay.
  - hasEndpoint
```
public boolean hasEndpoint()
```
    True iff this overlay has an endpoint coordinate pair.
  - hasEndpoint2
```
public boolean hasEndpoint2()
```
    True iff this overlay has a second endpoint coordinate pair.
  - canBeFilled
```
public boolean canBeFilled()
```
    True iff this overlay supports the filled parameter.
  - areBoundsEditable
```
public boolean areBoundsEditable()
```
    True iff this overlay can be resized using X1, X2, Y1, Y2 entry boxes.
  - hasText
```
public boolean hasText()
```
    True iff this overlay returns text to render.
  - setX
```
public void setX(float x1)
```
    Changes X coordinate of the overlay's first endpoint.
  - setY
```
public void setY(float y1)
```
    Changes Y coordinate of the overlay's first endpoint.
  - setCoords
```
public void setCoords(float x1,
                      float y1)
```
    Changes coordinates of the overlay's first endpoint.
  - getX
```
public float getX()
```
    Gets X coordinate of the overlay's first endpoint.
  - getY
```
public float getY()
```
    Gets Y coordinate of the overlay's first endpoint.
  - setX2
```
public void setX2(float x2)
```
    Changes X coordinate of the overlay's second endpoint.
  - setY2
```
public void setY2(float y2)
```
    Changes Y coordinate of the overlay's second endpoint.
  - setCoords2
```
public void setCoords2(float x2,
                       float y2)
```
    Changes coordinates of the overlay's second endpoint.
  - getX2
```
public float getX2()
```
    Gets X coordinate of the overlay's second endpoint.
  - getY2
```
public float getY2()
```
    Gets Y coordinate of the overlay's second endpoint.
  - setText
```
public void setText(String text)
```
    Changes text to render.
  - getText
```
public String getText()
```
    Gets text to render.
  - setColor
```
public void setColor(Color c)
```
    Sets color of this overlay.
  - getColor
```
public Color getColor()
```
    Gets color of this overlay.
  - setFilled
```
public void setFilled(boolean filled)
```
    Sets whether overlay is solid.
  - isFilled
```
public boolean isFilled()
```
    Gets whether overlay is solid.
  - isScalable
```
public boolean isScalable()
```
    Gets whether overlay is scalable.
  - rescale
```
public void rescale(float multiplier)
```
    Rescales this overlay object.
  - setGroup
```
public void setGroup(String group)
```
    Sets group to which this overlay belongs.
  - getGroup
```
public String getGroup()
```
    Gets group to which this overlay belongs.
  - setNotes
```
public void setNotes(String text)
```
    Sets notes for this overlay.
  - getNotes
```
public String getNotes()
```
    Gets notes for this overlay.
  - setSelected
```
public void setSelected(boolean selected)
```
    Sets whether this overlay is currently selected.
  - isSelected
```
public boolean isSelected()
```
    Gets whether this overlay is currently selected.
  - setDrawing
```
public void setDrawing(boolean drawing)
```
    Sets whether this overlay is still being initially drawn.
  - isDrawing
```
public boolean isDrawing()
```
    Gets whether this overlay is still being initially drawn.
  - setBoundaries
```
protected void setBoundaries(float x,
                             float y)
```
    Sets value of largest and smallest x, y values.

Class OverlayObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GLOW_WIDTH

GLOW_ALPHA

GLOW_COLOR

overlay

x1

y1

x2

y2

text

color

filled

group

notes

selected

drawing

xGrid1

yGrid1

xGrid2

yGrid2

xGrid3

yGrid3

xGrid4

yGrid4

horizGridCount

vertGridCount

Constructor Detail

OverlayObject

Method Detail

hasData

getData

getDistance

getStat

getStatistics

hasEndpoint

hasEndpoint2

canBeFilled

areBoundsEditable

hasText

setX

setY

setCoords

getX

getY

setX2

setY2

setCoords2

getX2

getY2

setText

getText

setColor

getColor

setFilled

isFilled

isScalable

rescale

setGroup

getGroup

setNotes

getNotes

setSelected

isSelected

setDrawing

isDrawing

setBoundaries