FlyThroughRenderInterface (MIPAV API Documentation)

All Known Implementing Classes:

FlyThroughRender, FlythruRender
```
public interface FlyThroughRenderInterface
```
Interface between the graphics-independent Fly-through user-interface and the graphics-dependent Fly-through renderers. The user-interface and graphics-independent classes for the Fly-through view are in gov.nih.mipav.view.renderer.flythroughview. Both the WildMagic and J3D Fly-through views work with the graphics-independent Fly-through classes by implementing this interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`autoRun()`	Causes the FlyPathBehavior to fly down the current path from start to finish and back again.
`java.lang.Object`	`getBranchState()`
`java.awt.Canvas`	`getCanvas()`
`int`	`getCounter()`
`int`	`getHeight()`
`ModelImage`	`getImage()`
`int`	`getWidth()`
`void`	`makeMove(java.lang.String cmd)`	Passes move command from the JPanelFlythruMove to the FlyPathBehavior class.
`void`	`record(boolean bOn)`	Turn recording frames on/off.
`void`	`setCurrentState(java.lang.Object _state)`	Set the BranchState in the FlyPathBehavior.
`boolean`	`writeImage()`	Write the current frame to disk.

- Method Detail
  - makeMove
```
void makeMove(java.lang.String cmd)
```
    Passes move command from the JPanelFlythruMove to the FlyPathBehavior class.
    
    Parameters:
    
    cmd - move command.
  - getImage
```
ModelImage getImage()
```
    Returns:
    
    access to the ModelImage mask image used by the Fly-through renderer.
  - autoRun
```
void autoRun()
```
    Causes the FlyPathBehavior to fly down the current path from start to finish and back again.
  - getBranchState
```
java.lang.Object getBranchState()
```
    Returns:
    
    the current BranchState from the FlyPatheBehavior class.
  - setCurrentState
```
void setCurrentState(java.lang.Object _state)
```
    Set the BranchState in the FlyPathBehavior.
    
    Parameters:
    
    _state -
  - writeImage
```
boolean writeImage()
```
    Write the current frame to disk.
    
    Returns:
    
    true on success, false if failure to write image.
  - getCanvas
```
java.awt.Canvas getCanvas()
```
    Returns:
    
    the Canvas from the Fly-through renderer.
  - record
```
void record(boolean bOn)
```
    Turn recording frames on/off.
    
    Parameters:
    
    bOn -
  - getCounter
```
int getCounter()
```
    Returns:
    
    the current frame counter.
  - getWidth
```
int getWidth()
```
    Returns:
    
    the frame width.
  - getHeight
```
int getHeight()
```
    Returns:
    
    the frame height.