CaptureHandler (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.view.CaptureHandler

All Implemented Interfaces:

Saveable
```
public class CaptureHandler
extends Object
implements Saveable
```
Provides logic for capturing display screenshots and movies.

Field Summary

Fields
Modifier and Type	Field and Description
`protected JFileChooser`	`imageBox` File chooser for snapshot output.
`protected JFileChooser`	`movieBox` File chooser for movie output.
`protected int`	`movieFPS` Movie frames per second.
`protected boolean`	`movieSmooth` Whether transitions use a smoothing sine function.
`protected int`	`movieSpeed` Movie speed.
`protected CapturePanel`	`panel` GUI controls for capture handler.
`protected Vector`	`positions` List of positions.
`protected DisplayWindow`	`window` Associated display window.

Constructor Summary

Constructors
Constructor and Description

CaptureHandler(DisplayWindow dw)
Creates a display capture handler.

Constructors
Constructor and Description
`CaptureHandler(DisplayWindow dw)` Creates a display capture handler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected BufferedImage`	`captureImage(ProjectionControl pc, double[] mx, DisplayImpl d)` Takes a snapshot of the given display with the specified projection matrix.
`void`	`captureMovie(Vector matrices, double secPerTrans, int framesPerSec, boolean sine, boolean movie)` Creates a movie of the given transformation sequence.
`int`	`getFPS()` Gets movie frames per second.
`CapturePanel`	`getPanel()` Gets GUI controls for this capture handler.
`Vector`	`getPositions()` Gets positions on the list.
`BufferedImage`	`getSnapshot()` Gets a snapshot of the display.
`int`	`getSpeed()` Gets movie speed.
`DisplayWindow`	`getWindow()` Gets associated display window.
`void`	`initState(CaptureHandler handler)` Modifies this object's state to match that of the given object.
`boolean`	`isSmooth()` Gets whether transitions use a smoothing sine function.
`boolean`	`matches(CaptureHandler handler)` Tests whether two objects are in equivalent states.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("Display").
`void`	`saveSnapshot()` Saves a snapshot of the display to a file specified by the user.
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("Display").
`void`	`sendToImageJ()` Sends a snapshot of the display to ImageJ.
`protected void`	`setProgress(int percent, String message)` Sets capture panel's progress bar percentage value and message.
`protected static double`	`sine(double x)` Evaluates a smooth sine function at the given value.

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

- Field Detail
  - window
```
protected DisplayWindow window
```
    Associated display window.
  - panel
```
protected CapturePanel panel
```
    GUI controls for capture handler.
  - imageBox
```
protected JFileChooser imageBox
```
    File chooser for snapshot output.
  - movieBox
```
protected JFileChooser movieBox
```
    File chooser for movie output.
  - positions
```
protected Vector positions
```
    List of positions.
  - movieSpeed
```
protected int movieSpeed
```
    Movie speed.
  - movieFPS
```
protected int movieFPS
```
    Movie frames per second.
  - movieSmooth
```
protected boolean movieSmooth
```
    Whether transitions use a smoothing sine function.
- Constructor Detail
  - CaptureHandler
```
public CaptureHandler(DisplayWindow dw)
```
    Creates a display capture handler.
- Method Detail
  - getPositions
```
public Vector getPositions()
```
    Gets positions on the list.
  - getSpeed
```
public int getSpeed()
```
    Gets movie speed.
  - getFPS
```
public int getFPS()
```
    Gets movie frames per second.
  - isSmooth
```
public boolean isSmooth()
```
    Gets whether transitions use a smoothing sine function.
  - getWindow
```
public DisplayWindow getWindow()
```
    Gets associated display window.
  - getPanel
```
public CapturePanel getPanel()
```
    Gets GUI controls for this capture handler.
  - getSnapshot
```
public BufferedImage getSnapshot()
```
    Gets a snapshot of the display.
  - saveSnapshot
```
public void saveSnapshot()
```
    Saves a snapshot of the display to a file specified by the user.
  - sendToImageJ
```
public void sendToImageJ()
```
    Sends a snapshot of the display to ImageJ.
  - captureMovie
```
public void captureMovie(Vector matrices,
                         double secPerTrans,
                         int framesPerSec,
                         boolean sine,
                         boolean movie)
```
    Creates a movie of the given transformation sequence.
  - matches
```
public boolean matches(CaptureHandler handler)
```
    Tests whether two objects are in equivalent states.
  - initState
```
public void initState(CaptureHandler handler)
```
    Modifies this object's state to match that of the given object. If the argument is null, the object is initialized according to its current state instead.
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("Display").
    
    Specified by:
    
    saveState in interface Saveable
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("Display").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Throws:
    
    SaveException
  - captureImage
```
protected BufferedImage captureImage(ProjectionControl pc,
                                     double[] mx,
                                     DisplayImpl d)
```
    Takes a snapshot of the given display with the specified projection matrix.
  - setProgress
```
protected void setProgress(int percent,
                           String message)
```
    Sets capture panel's progress bar percentage value and message.
  - sine
```
protected static double sine(double x)
```
    Evaluates a smooth sine function at the given value.

Class CaptureHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

window

panel

imageBox

movieBox

positions

movieSpeed

movieFPS

movieSmooth

Constructor Detail

CaptureHandler

Method Detail

getPositions

getSpeed

getFPS

isSmooth

getWindow

getPanel

getSnapshot

saveSnapshot

sendToImageJ

captureMovie

matches

initState

saveState

restoreState

captureImage

setProgress

sine