SurfaceFormat (Mango Plugin API)

All Superinterfaces:

MangoPluginType
```
public interface SurfaceFormat
extends MangoPluginType
```
A class that implements SurfaceFormat can be registered with Mango to extend the number of surface formats supported.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getOptions()` Returns options.
`JPanel`	`getOptionsPanel(Surface[] data, Shape[] shapes, SurfaceController controller)` Deprecated.
`String`	`getPreferredFileExtension()` Returns the preferred file extension of this format.
`boolean`	`isThisFormat(File file)` Used to determine if a file is of this format (e.g., read magic number, check file size, check file extension, etc).
`Surface[]`	`readSurfaceFile(File file, ViewerController controller, Vector<Shape> shapes, boolean baseSurface)` Deprecated.
`Surface[]`	`readSurfaceHeader(File file, Vector<Shape> shapes)` Reads surface header (meta data) from file.
`void`	`setOptions(String options)` Sets the options.
`void`	`writeSurfaceFile(File file, Surface[] surfaces, Shape[] shapes, SurfaceController controller)` Deprecated.

Methods inherited from interface edu.uthscsa.ric.mango.MangoPluginType
getMinimumVersionSupported, getPluginName, getPluginURL, getVersion, hasNewerVersion

- Method Detail
  - getOptions
```
String getOptions()
```
    Returns options.
    
    Returns:
    options
  - getOptionsPanel
```
@Deprecated
JPanel getOptionsPanel(Surface[] data,
                                Shape[] shapes,
                                SurfaceController controller)
```
    Deprecated.
  - getPreferredFileExtension
```
String getPreferredFileExtension()
```
    Returns the preferred file extension of this format.
    
    Returns:
    the preferred file extension
  - isThisFormat
```
boolean isThisFormat(File file)
```
    Used to determine if a file is of this format (e.g., read magic number, check file size, check file extension, etc).
    
    Parameters:
    file - the file to read
    
    Returns:
    returns true if this file can be read by this format, false otherwise
  - readSurfaceFile
```
@Deprecated
Surface[] readSurfaceFile(File file,
                                   ViewerController controller,
                                   Vector<Shape> shapes,
                                   boolean baseSurface)
                          throws SurfaceFormatException
```
    Deprecated.
    
    Reads surface data from file. For returned data, if triangle data is in the form of strip counts, then normals data must be present. If triangle data is in the form of indices, then normals data may or may not be present.
    
    Parameters:
    file - the file to read
    controller - the ViewerController object can be used to access image dimensions, orientation, lookup tables, etc.
    shapes - shape objects can be stored here
    baseSurface - true if the viewer does not yet exist, false if you are loading shapes into an existing viewer
    
    Returns:
    the read surface data; the first index in the return array specifies the base image surface.
    
    Throws:
    
    SurfaceFormatException - surface format exception
  - readSurfaceHeader
```
Surface[] readSurfaceHeader(File file,
                          Vector<Shape> shapes)
                            throws SurfaceFormatException
```
    Reads surface header (meta data) from file.
    
    Parameters:
    file - the file to read
    shapes - shape objects can be stored here
    
    Returns:
    the read surface data; the first index in the return array specifies the base image surface.
    
    Throws:
    
    SurfaceFormatException - surface format exception
  - setOptions
```
void setOptions(String options)
```
    Sets the options.
    
    Parameters:
    options - the options
  - writeSurfaceFile
```
@Deprecated
void writeSurfaceFile(File file,
                               Surface[] surfaces,
                               Shape[] shapes,
                               SurfaceController controller)
                      throws SurfaceFormatException
```
    Deprecated.
    
    Writes surface data to file. Triangle data is always passed to this method as strip counts.
    
    Parameters:
    file - the file to write
    surfaces - an array of surfaces; the first index is the base surface
    shapes - an array of shapes
    controller - the SurfaceController
    
    Throws:
    
    SurfaceFormatException - surface format exception

Interface SurfaceFormat

Method Summary

Methods inherited from interface edu.uthscsa.ric.mango.MangoPluginType

Method Detail

getOptions

getOptionsPanel

getPreferredFileExtension

isThisFormat

readSurfaceFile

readSurfaceHeader

setOptions

writeSurfaceFile