Package dataPlotsFX.data

Interface TDDataInfoPlugin

public interface TDDataInfoPlugin
A plugin is used to display extra data for a TDDataInfo.

This is usually used to add some data annotations or different plotting options for a particular data block where a bespoke TDDataInfoFX is not necessary. It is the responsibility of the module to add the plugin to the the TDDisplay.

Example: The click train detector module does not need to do a large amount of drawing as super detections are already coloured appropriately. However some of the algorithms add additional draweing to the display and thus a plugin is more appropriate.

Author:
Jamie Macaulay

  • Method Summary

    Modifier and Type
    Method
    Description
    Class<?>
    getDataInfoClass()
    Get the data info class to add the plugin to.
    boolean
    repaint(int plotNumber, javafx.scene.canvas.GraphicsContext g, long scrollStart, TDProjectorFX tdProjector, TDDataInfoFX dataInfo)
    Paint the on the display

  • Method Details

    • getDataInfoClass

      Class<?> getDataInfoClass()
      Get the data info class to add the plugin to. The plugin will be added to all these.
      Returns:
      the data info class.

    • repaint

      boolean repaint(int plotNumber, javafx.scene.canvas.GraphicsContext g, long scrollStart, TDProjectorFX tdProjector, TDDataInfoFX dataInfo)
      Paint the on the display
      Parameters:
      plotNumber - - the plot number
      g - - the graphics context
      scrollStart - - the start of the display
      tdProjector - - the projector
      dataInfo - - the data info. The plugin is added to all dataInfos of type getDataInfoClass();
      Returns:
      true if successfully painted.