BufferedImageOverlayRenderer (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bdv.viewer.render.awt.BufferedImageOverlayRenderer

All Implemented Interfaces:

OverlayRenderer, RenderTarget<BufferedImageRenderResult>
```
public class BufferedImageOverlayRenderer
extends Object
implements OverlayRenderer, RenderTarget<BufferedImageRenderResult>
```
OverlayRenderer drawing a BufferedImage, scaled to fill the canvas. It can be used as a RenderTarget, such that the BufferedImageRenderResult to draw is set by a renderer.

Author:

Tobias Pietzsch

Constructor Summary

Constructors
Constructor and Description

BufferedImageOverlayRenderer()

Constructors
Constructor and Description
`BufferedImageOverlayRenderer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BufferedImageRenderResult`	`createRenderResult()` Returns a new `RenderResult`.
`void`	`drawOverlays(Graphics g)` Render overlays.
`int`	`getHeight()` Get the current canvas height.
`BufferedImageRenderResult`	`getReusableRenderResult()` Returns a `RenderResult` for rendering to.
`int`	`getWidth()` Get the current canvas width.
`void`	`kill()` DON'T USE THIS.
`void`	`setCanvasSize(int width, int height)` This is called, when the screen size of the canvas (the component displaying the image and generating mouse events) changes.
`void`	`setRenderResult(BufferedImageRenderResult result)` Set the `RenderResult` that is to be drawn on the canvas.
`org.scijava.listeners.Listeners<TransformListener<AffineTransform3D>>`	`transformListeners()` Add/remove `TransformListener`s to notify about viewer transformation changes.

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

- Constructor Detail
  - BufferedImageOverlayRenderer
```
public BufferedImageOverlayRenderer()
```
- Method Detail
  - getReusableRenderResult
```
public BufferedImageRenderResult getReusableRenderResult()
```
    Description copied from interface: RenderTarget
    
    Returns a RenderResult for rendering to. This may be a new RenderResult or a previously set RenderResult that is no longer needed for display. Note that consecutive getReusableRenderResult() calls without intermediate setRenderResult() may return the same RenderResult.
    
    Specified by:
    
    getReusableRenderResult in interface RenderTarget<BufferedImageRenderResult>
  - createRenderResult
```
public BufferedImageRenderResult createRenderResult()
```
    Description copied from interface: RenderTarget
    
    Returns a new RenderResult.
    
    Specified by:
    
    createRenderResult in interface RenderTarget<BufferedImageRenderResult>
  - setRenderResult
```
public void setRenderResult(BufferedImageRenderResult result)
```
    Set the RenderResult that is to be drawn on the canvas.
    
    Specified by:
    
    setRenderResult in interface RenderTarget<BufferedImageRenderResult>
    
    Parameters:
    
    result - image to draw (may be null).
  - getWidth
```
public int getWidth()
```
    Description copied from interface: RenderTarget
    
    Get the current canvas width.
    
    Specified by:
    
    getWidth in interface RenderTarget<BufferedImageRenderResult>
    
    Returns:
    
    canvas width.
  - getHeight
```
public int getHeight()
```
    Description copied from interface: RenderTarget
    
    Get the current canvas height.
    
    Specified by:
    
    getHeight in interface RenderTarget<BufferedImageRenderResult>
    
    Returns:
    
    canvas height.
  - drawOverlays
```
public void drawOverlays(Graphics g)
```
    Description copied from interface: OverlayRenderer
    
    Render overlays.
    
    Specified by:
    
    drawOverlays in interface OverlayRenderer
  - setCanvasSize
```
public void setCanvasSize(int width,
                          int height)
```
    Description copied from interface: OverlayRenderer
    
    This is called, when the screen size of the canvas (the component displaying the image and generating mouse events) changes. This can be used to determine scale of overlay or screen coordinates relative to the border.
    
    Specified by:
    
    setCanvasSize in interface OverlayRenderer
    
    Parameters:
    
    width - the new canvas width.
    
    height - the new canvas height.
  - transformListeners
```
public org.scijava.listeners.Listeners<TransformListener<AffineTransform3D>> transformListeners()
```
    Add/remove TransformListeners to notify about viewer transformation changes. Listeners will be notified when a new image has been rendered (immediately before that image is displayed) with the viewer transform used to render that image.
  - kill
```
public void kill()
```
    DON'T USE THIS.
    This is a work around for JDK bug https://bugs.openjdk.java.net/browse/JDK-8029147 which leads to ViewerPanel not being garbage-collected when ViewerFrame is closed. So instead we need to manually let go of resources...

Class BufferedImageOverlayRenderer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BufferedImageOverlayRenderer

Method Detail

getReusableRenderResult

createRenderResult

setRenderResult

getWidth

getHeight

drawOverlays

setCanvasSize

transformListeners

kill