Package mgui.io.standard.gifti

Class GiftiSurfaceLoader

java.lang.Object
mgui.io.FileLoader
mgui.io.domestic.shapes.InterfaceShapeLoader
mgui.io.domestic.shapes.SurfaceFileLoader
mgui.io.standard.gifti.GiftiSurfaceLoader
All Implemented Interfaces:
InterfaceIO, IconObject
public class GiftiSurfaceLoader
extends SurfaceFileLoader
Loads an XML-format GIFTI file. See http://www.nitrc.org/projects/gifti/ for details and specification.
Since:
1.0
Version:
1.0
Author:
Andrew Reid

  • Constructor Details

    • GiftiSurfaceLoader

      public GiftiSurfaceLoader()

    • GiftiSurfaceLoader

      public GiftiSurfaceLoader​(java.io.File file)

  • Method Details

    • load

      public boolean load​(InterfaceIOOptions options, ProgressUpdater progress_bar)
      Description copied from class: FileLoader
      Loads data from the set of files or URLs specified by options. Loading is controlled by the specifications of options. If loaded object is of type PersistentObject, this method should also set the file loader and reference URL for the object.

      This method should also set the URL reference and writer and loader attributes to match this one and its complement.

      Overrides:
      load in class SurfaceFileLoader
      progress_bar - An optional progress updater. Can be null.
      Returns:

    • loadSurface

      public Mesh3DInt loadSurface​(ProgressUpdater progress_bar, InterfaceIOOptions options) throws java.io.IOException
      Description copied from class: SurfaceFileLoader
      Loads a single surface from the appropriate source. Returns a Mesh3DInt object if load was successful, or null otherwise. This method should also set the file loader and reference URL for the object.
      Specified by:
      loadSurface in class SurfaceFileLoader
      Returns:
      Mesh3DInt mesh representing the surface being loaded
      Throws:
      java.io.IOException

    • getWriterComplement

      public InterfaceIOType getWriterComplement()
      Description copied from class: FileLoader
      Returns the InterfaceIOType of a FileWriter which is the complement of this loader; i.e., writes what this loader reads with identical encoding. Transfer between loader and writer should be lossless.

      Returns null if no complement is defined.

      Overrides:
      getWriterComplement in class FileLoader
      Returns: