RoiOverlay (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- siox.RoiOverlay

All Implemented Interfaces:

OverlayedImageCanvas.Overlay
```
public class RoiOverlay
extends Object
implements OverlayedImageCanvas.Overlay
```
This class implements an overlay based on the image ROI. The overlay paints the ROI with a specific color and composite mode.

Author:

Ignacio Arganda-Carreras, Johannes Schindelin, Stephan Saalfeld

Constructor Summary

Constructors
Constructor and Description
`RoiOverlay()` Empty constructor
`RoiOverlay(Roi roi, Composite composite, Color color)` Create a RoiOverlay based on a Roi and a specific color and composite mode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`paint(Graphics g, int x, int y, double magnification)` Paint this overlay on the given graphic device.
`void`	`setColor(Color color)`
`void`	`setComposite(Composite composite)` Set the composite that will be used to paint this overlay.
`void`	`setRoi(Roi roi)`
`String`	`toString()`

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

- Constructor Detail
  - RoiOverlay
```
public RoiOverlay()
```
    Empty constructor
  - RoiOverlay
```
public RoiOverlay(Roi roi,
                  Composite composite,
                  Color color)
```
    Create a RoiOverlay based on a Roi and a specific color and composite mode.
    
    Parameters:
    
    roi - original image region of interest
    
    composite - composite mode
    
    color - color to paint the RoiOverlay
- Method Detail
  - paint
```
public void paint(Graphics g,
                  int x,
                  int y,
                  double magnification)
```
    Description copied from interface: OverlayedImageCanvas.Overlay
    
    Paint this overlay on the given graphic device.
    
    Specified by:
    
    paint in interface OverlayedImageCanvas.Overlay
    
    Parameters:
    
    g - the graphic device provided by the OverlayedImageCanvas
    
    x - the top-left corner x-coordinate of the image rectangle currently displayed in the OverlayedImageCanvas
    
    y - the top-left corner y-coordinate
    
    magnification - the OverlayedImageCanvas current magnification
  - setRoi
```
public void setRoi(Roi roi)
```
  - setComposite
```
public void setComposite(Composite composite)
```
    Description copied from interface: OverlayedImageCanvas.Overlay
    
    Set the composite that will be used to paint this overlay.
    
    Specified by:
    
    setComposite in interface OverlayedImageCanvas.Overlay
  - setColor
```
public void setColor(Color color)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RoiOverlay

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoiOverlay

RoiOverlay

Method Detail

paint

setRoi

setComposite

setColor

toString