OverlayNodedObject (LOCI Javadocs 0-SNAPSHOT API)

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

Direct Known Subclasses:

OverlayFreeform, OverlayPolyline
```
public abstract class OverlayNodedObject
extends OverlayObject
```
OverlayNodedObject is an overlay object built of nodes likely connected by lines.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static float[][]`	`ARC` Computed (X, Y) pairs for top 1/2 of a unit circle.
`protected static String`	`BOUNDS` The names of the statistics this object reports.
`protected double`	`curveLength` Length of curve of a noded object.
`protected int`	`highlightIndex` Index of the highlighted node.
`protected boolean`	`highlightNode` Whether there is a higlighted node.
`protected static float`	`HLT_ALPHA` Alpha value for highlighting.
`protected static String`	`LENGTH`
`protected int`	`maxNodes` Total number of nodes (real + buffer) nodes in the node array.
`protected float[][]`	`nodes` Node array and associated tracking variables.
`protected static String`	`NODES`
`protected Object`	`nodesSync` Synchronization object for nodes array.
`protected int`	`numNodes` Number of real nodes in the node array.
`protected static float`	`RADIUS` Radius in pixels of circle indicating a node is selected.
`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
`OverlayNodedObject(OverlayTransform overlay)` Constructs an uninitialized noded object.
`OverlayNodedObject(OverlayTransform overlay, float[][] nodes)` Constructs a noded object from an array of nodes.
`OverlayNodedObject(OverlayTransform overlay, float x1, float y1, float x2, float y2)` Constructs a noded object.

Method Summary

All Methods Static Methods Instance 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.
`void`	`computeLength()` Computes length of curve.
`OverlayFreeform`	`connectTo(OverlayFreeform f2)` Creates a new freeform by connecting the tail of this freeform to the head of the freeform supplied.
`void`	`deleteBetween(int i1, int i2)` Deletes a range of nodes from the node array.
`void`	`deleteNode(int index)` Deletes a node from the node array.
`double`	`getCurveLength()` Gets length of curve.
`DataImpl`	`getData()` Gets VisAD data object representing this overlay.
`double`	`getDistance(double x, double y)` Compute the shortest distance from this object to the given point.
`double`	`getDistanceToBoundingBox(double x, double y)` Computes the shortest distance from this object's bounding box to the given point.
`int`	`getHighlightedNodeIndex()` Returns index of highlighted node.
`float`	`getLastNodeX()` Gets most recent x-coordinate in node array.
`float`	`getLastNodeY()` Gets most recent y-coordinate in node array.
`double`	`getLastSegmentLength()` Determines length of last line segment in this curve.
`int`	`getMaxNodes()` Returns total number of nodes in array.
`protected double[]`	`getNearestNode(float x, float y)` Gets the nearest node to the given point.
`float[]`	`getNodeCoords(int index)` Returns coordinates of node at given index in the node array.
`float[][]`	`getNodes()` Returns a copy of the node array.
`int`	`getNumNodes()` Returns the number of real nodes in the array.
`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.
`void`	`insertNode(int index, float x, float y, boolean colocationalOK)` Inserts a node at coordinates provided before the node at the index provided.
`boolean`	`isHighlightNode()` True iff there is a highlighted node.
`void`	`printNodes()` Prints node array of current freeform.
`static void`	`printThread(String methodName)` Prints current thread plus method name if provided.
`OverlayFreeform[]`	`removeNode(int index)` Deletes a node from the freeform object, creating two new freeforms if the node deleted is an interior node.
`protected void`	`resizeNodeArray(int newLength)` Resizes the node array, truncating if necessary.
`void`	`reverseNodes()` Reverses the node array (and therefore its internal orientation).
`void`	`setCoords(float x1, float y1)` Changes coordinates of the overlay's first endpoint.
`void`	`setCurveLength(double len)` Sets length of curve.
`void`	`setHighlightNode(int i)` Highlight a node.
`void`	`setLastNode(float[] c)` Sets coordinates of last node.
`void`	`setLastNode(float x, float y)` Sets coordinates of last node.
`void`	`setNextNode(float[] c)` Sets next node coordinates.
`void`	`setNextNode(float x, float y)` Sets next node coordinates.
`void`	`setNodeCoords(int ndx, float x, float y)` Sets coordinates of an existing node.
`void`	`setNodes(float[][] nodes)` Sets the node array to that provided--for loading from saved.
`void`	`truncateNodeArray()` Deletes buffer nodes from the tail of the node array.
`void`	`turnOffHighlighting()` Turn off node highlighting.
`void`	`updateBoundingBox()` Updates the coordinates of the bounding box of a noded object by checking the entire node array.

Methods inherited from class loci.visbio.overlays.OverlayObject
getColor, getGroup, getNotes, getText, getX, getX2, getY, getY2, hasText, isDrawing, isFilled, isScalable, isSelected, rescale, setBoundaries, setColor, 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, toString, wait, wait, wait

- Field Detail
  - BOUNDS
```
protected static final String BOUNDS
```
    The names of the statistics this object reports.
    
    See Also:
    
    Constant Field Values
  - NODES
```
protected static final String NODES
```
    See Also:
    
    Constant Field Values
  - LENGTH
```
protected static final String LENGTH
```
    See Also:
    
    Constant Field Values
  - STAT_TYPES
```
protected static final String[] STAT_TYPES
```
  - ARC
```
protected static final float[][] ARC
```
    Computed (X, Y) pairs for top 1/2 of a unit circle.
  - HLT_ALPHA
```
protected static final float HLT_ALPHA
```
    Alpha value for highlighting.
    
    See Also:
    
    Constant Field Values
  - RADIUS
```
protected static final float RADIUS
```
    Radius in pixels of circle indicating a node is selected.
    
    See Also:
    
    Constant Field Values
  - nodesSync
```
protected Object nodesSync
```
    Synchronization object for nodes array.
  - nodes
```
protected float[][] nodes
```
    Node array and associated tracking variables.
  - numNodes
```
protected int numNodes
```
    Number of real nodes in the node array.
  - maxNodes
```
protected int maxNodes
```
    Total number of nodes (real + buffer) nodes in the node array.
  - curveLength
```
protected double curveLength
```
    Length of curve of a noded object.
  - highlightNode
```
protected boolean highlightNode
```
    Whether there is a higlighted node.
  - highlightIndex
```
protected int highlightIndex
```
    Index of the highlighted node.
- Constructor Detail
  - OverlayNodedObject
```
public OverlayNodedObject(OverlayTransform overlay)
```
    Constructs an uninitialized noded object.
  - OverlayNodedObject
```
public OverlayNodedObject(OverlayTransform overlay,
                          float x1,
                          float y1,
                          float x2,
                          float y2)
```
    Constructs a noded object.
  - OverlayNodedObject
```
public OverlayNodedObject(OverlayTransform overlay,
                          float[][] nodes)
```
    Constructs a noded object from an array of nodes.
- 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)
```
    Compute 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
  - canBeFilled
```
public boolean canBeFilled()
```
    True iff this overlay supports the filled parameter.
    
    Overrides:
    
    canBeFilled in class OverlayObject
  - areBoundsEditable
```
public boolean areBoundsEditable()
```
    True iff this overlay can be resized using X1, X2, Y1, Y2 entry boxes.
    
    Overrides:
    
    areBoundsEditable in class OverlayObject
  - isHighlightNode
```
public boolean isHighlightNode()
```
    True iff there is a highlighted node.
  - getHighlightedNodeIndex
```
public int getHighlightedNodeIndex()
```
    Returns index of highlighted node.
  - getNearestNode
```
protected double[] getNearestNode(float x,
                                  float y)
```
    Gets the nearest node to the given point.
  - getDistanceToBoundingBox
```
public double getDistanceToBoundingBox(double x,
                                       double y)
```
    Computes the shortest distance from this object's bounding box to the given point.
  - setHighlightNode
```
public void setHighlightNode(int i)
```
    Highlight a node.
  - turnOffHighlighting
```
public void turnOffHighlighting()
```
    Turn off node highlighting.
  - getNodeCoords
```
public float[] getNodeCoords(int index)
```
    Returns coordinates of node at given index in the node array.
  - getNodes
```
public float[][] getNodes()
```
    Returns a copy of the node array.
  - getNumNodes
```
public int getNumNodes()
```
    Returns the number of real nodes in the array.
  - getMaxNodes
```
public int getMaxNodes()
```
    Returns total number of nodes in array.
  - getLastNodeX
```
public float getLastNodeX()
```
    Gets most recent x-coordinate in node array.
  - getLastNodeY
```
public float getLastNodeY()
```
    Gets most recent y-coordinate in node array.
  - setCoords
```
public void setCoords(float x1,
                      float y1)
```
    Changes coordinates of the overlay's first endpoint.
    
    Overrides:
    
    setCoords in class OverlayObject
  - setNodes
```
public void setNodes(float[][] nodes)
```
    Sets the node array to that provided--for loading from saved.
  - updateBoundingBox
```
public void updateBoundingBox()
```
    Updates the coordinates of the bounding box of a noded object by checking the entire node array.
  - getCurveLength
```
public double getCurveLength()
```
    Gets length of curve.
  - getLastSegmentLength
```
public double getLastSegmentLength()
```
    Determines length of last line segment in this curve.
  - setCurveLength
```
public void setCurveLength(double len)
```
    Sets length of curve.
  - computeLength
```
public void computeLength()
```
    Computes length of curve.
  - setNodeCoords
```
public void setNodeCoords(int ndx,
                          float x,
                          float y)
```
    Sets coordinates of an existing node.
  - setLastNode
```
public void setLastNode(float x,
                        float y)
```
    Sets coordinates of last node.
  - setLastNode
```
public void setLastNode(float[] c)
```
    Sets coordinates of last node.
  - setNextNode
```
public void setNextNode(float x,
                        float y)
```
    Sets next node coordinates.
  - setNextNode
```
public void setNextNode(float[] c)
```
    Sets next node coordinates.
  - insertNode
```
public void insertNode(int index,
                       float x,
                       float y,
                       boolean colocationalOK)
```
    Inserts a node at coordinates provided before the node at the index provided.
  - deleteBetween
```
public void deleteBetween(int i1,
                          int i2)
```
    Deletes a range of nodes from the node array.
  - deleteNode
```
public void deleteNode(int index)
```
    Deletes a node from the node array.
  - removeNode
```
public OverlayFreeform[] removeNode(int index)
```
    Deletes a node from the freeform object, creating two new freeforms if the node deleted is an interior node. Returns resulting new freeforms if any.
  - connectTo
```
public OverlayFreeform connectTo(OverlayFreeform f2)
```
    Creates a new freeform by connecting the tail of this freeform to the head of the freeform supplied.
    
    Parameters:
    
    f2 - The freeform to connect to this freeform
  - reverseNodes
```
public void reverseNodes()
```
    Reverses the node array (and therefore its internal orientation).
  - truncateNodeArray
```
public void truncateNodeArray()
```
    Deletes buffer nodes from the tail of the node array.
  - resizeNodeArray
```
protected void resizeNodeArray(int newLength)
```
    Resizes the node array, truncating if necessary.
  - printNodes
```
public void printNodes()
```
    Prints node array of current freeform. For debugging.
  - printThread
```
public static void printThread(String methodName)
```
    Prints current thread plus method name if provided.

Class OverlayNodedObject

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

BOUNDS

NODES

LENGTH

STAT_TYPES

ARC

HLT_ALPHA

RADIUS

nodesSync

nodes

numNodes

maxNodes

curveLength

highlightNode

highlightIndex

Constructor Detail

OverlayNodedObject

OverlayNodedObject

OverlayNodedObject

Method Detail

getStatTypes

hasData

getData

getDistance

getStat

getStatistics

hasEndpoint

hasEndpoint2

canBeFilled

areBoundsEditable

isHighlightNode

getHighlightedNodeIndex

getNearestNode

getDistanceToBoundingBox

setHighlightNode

turnOffHighlighting

getNodeCoords

getNodes

getNumNodes

getMaxNodes

getLastNodeX

getLastNodeY

setCoords

setNodes

updateBoundingBox

getCurveLength

getLastSegmentLength

setCurveLength

computeLength

setNodeCoords

setLastNode

setLastNode

setNextNode

setNextNode

insertNode

deleteBetween

deleteNode

removeNode

connectTo

reverseNodes

truncateNodeArray

resizeNodeArray

printNodes

printThread