TransformedBoxOverlay (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bdv.tools.boundingbox.TransformedBoxOverlay

All Implemented Interfaces:

OverlayRenderer, TransformListener<AffineTransform3D>
```
public class TransformedBoxOverlay
extends Object
implements OverlayRenderer, TransformListener<AffineTransform3D>
```
A BDV OverlayRenderer showing a TransformedBox. Displays a wireframe box and/or intersection with current viewer slice, with various adjustable parameters.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TransformedBoxOverlay.BoxDisplayMode` Specifies whether to show 3D wireframe box (`FULL`), or only intersection with viewer plane (`SECTION`).
`static interface`	`TransformedBoxOverlay.HighlightedCornerListener`

Constructor Summary

Constructors
Constructor and Description

TransformedBoxOverlay(Interval interval)

TransformedBoxOverlay(TransformedBox bbSource)

Constructors
Constructor and Description
`TransformedBoxOverlay(Interval interval)`
`TransformedBoxOverlay(TransformedBox bbSource)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.scijava.listeners.ListenableVar<TransformedBoxOverlay.BoxDisplayMode,org.scijava.listeners.ChangeListener>`	`boxDisplayMode()` Get/set `BoxDisplayMode`, which specifies whether to show 3D wireframe box (`FULL`), or only intersection with viewer plane (`SECTION`).
`void`	`drawOverlays(Graphics g)` Render overlays.
`void`	`fillIntersection(boolean fillIntersection)`
`void`	`getBoxToViewerTransform(AffineTransform3D t)` Get the transformation from the local coordinate frame of the `TransformedBox` to viewer coordinates.
`MouseMotionListener`	`getCornerHighlighter()` Returns a `MouseMotionListener` that can be installed into a bdv (see `ViewerPanel.getDisplay().addHandler(...)`).
`boolean`	`getFillIntersection()`
`int`	`getHighlightedCornerIndex()` Get the index of the highlighted corner (if any).
`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`	`setHighlightedCornerListener(TransformedBoxOverlay.HighlightedCornerListener highlightedCornerListener)`
`void`	`setIntersectionFillColor(Color intersectionFillColor)`
`void`	`setPerspective(double perspective)` Sets the perspective value.
`void`	`setSourceSize(double sourceSize)` Sets the source size (estimated maximum dimension) in global coordinates.
`void`	`showCornerHandles(boolean showCornerHandles)`
`void`	`transformChanged(AffineTransform3D t)`

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

- Constructor Detail
  - TransformedBoxOverlay
```
public TransformedBoxOverlay(Interval interval)
```
  - TransformedBoxOverlay
```
public TransformedBoxOverlay(TransformedBox bbSource)
```
- Method Detail
  - setPerspective
```
public void setPerspective(double perspective)
```
    Sets the perspective value. perspective < 0 means parallel projection.
    
    Parameters:
    
    perspective - the perspective value.
  - showCornerHandles
```
public void showCornerHandles(boolean showCornerHandles)
```
  - fillIntersection
```
public void fillIntersection(boolean fillIntersection)
```
  - getFillIntersection
```
public boolean getFillIntersection()
```
  - setIntersectionFillColor
```
public void setIntersectionFillColor(Color intersectionFillColor)
```
  - 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.
  - transformChanged
```
public void transformChanged(AffineTransform3D t)
```
    Specified by:
    
    transformChanged in interface TransformListener<AffineTransform3D>
  - boxDisplayMode
```
public org.scijava.listeners.ListenableVar<TransformedBoxOverlay.BoxDisplayMode,org.scijava.listeners.ChangeListener> boxDisplayMode()
```
    Get/set BoxDisplayMode, which specifies whether to show 3D wireframe box (FULL), or only intersection with viewer plane (SECTION).
  - getBoxToViewerTransform
```
public void getBoxToViewerTransform(AffineTransform3D t)
```
    Get the transformation from the local coordinate frame of the TransformedBox to viewer coordinates.
    
    Parameters:
    
    t - is set to the box-to-viewer transform.
  - getHighlightedCornerIndex
```
public int getHighlightedCornerIndex()
```
    Get the index of the highlighted corner (if any).
    
    Returns:
    
    corner index or -1 if no corner is highlighted
  - getCornerHighlighter
```
public MouseMotionListener getCornerHighlighter()
```
    Returns a MouseMotionListener that can be installed into a bdv (see ViewerPanel.getDisplay().addHandler(...)). If installed, it will notify a HighlightedCornerListener (see setHighlightedCornerListener(HighlightedCornerListener)) when the mouse is over a corner of the box (with some tolerance)/
    
    Returns:
    
    a MouseMotionListener implementing mouse-over for box corners
  - setHighlightedCornerListener
```
public void setHighlightedCornerListener(TransformedBoxOverlay.HighlightedCornerListener highlightedCornerListener)
```
  - setSourceSize
```
public void setSourceSize(double sourceSize)
```
    Sets the source size (estimated maximum dimension) in global coordinates. Used for setting up perspective projection.
    
    Parameters:
    
    sourceSize - estimated source size in global coordinates

Class TransformedBoxOverlay

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransformedBoxOverlay

TransformedBoxOverlay

Method Detail

setPerspective

showCornerHandles

fillIntersection

getFillIntersection

setIntersectionFillColor

drawOverlays

setCanvasSize

transformChanged

boxDisplayMode

getBoxToViewerTransform

getHighlightedCornerIndex

getCornerHighlighter

setHighlightedCornerListener

setSourceSize