IPlotter
hep.aida

Interface IPlotter

  • All Known Implementing Classes:
    DummyPlotter, Plotter


    public interface IPlotter
    User level interface to plotter. This IPlotter interface assumes the handling of multiple plotting regions. Then the IPlotter should be seen as a "page" managing multiple drawing region. It assumes that a "current" region mechanism is used. The keyword "region" is borrowed from the OpenInventor terminology (viewing region). See also the IPlotterRegion for more comments.
    • Method Detail

      • createRegion

        IPlotterRegion createRegion()
        Create a new region. that is to say between 0 and 1. Then a region with (x=0,y=0,w=1,h=1) maps the full page. "x" goes left to right. "y" bottom to top.
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegion

        IPlotterRegion createRegion(double x)
        Create a new region.
        Parameters:
        x, - y, w, h Position and size in normal coordinates that is to say between 0 and 1. Then a region with (x=0,y=0,w=1,h=1) maps the full page. "x" goes left to right. "y" bottom to top.
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegion

        IPlotterRegion createRegion(double x,                          double y)
        Create a new region.
        Parameters:
        x, - y, w, h Position and size in normal coordinates that is to say between 0 and 1. Then a region with (x=0,y=0,w=1,h=1) maps the full page. "x" goes left to right. "y" bottom to top.
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegion

        IPlotterRegion createRegion(double x,                          double y,                          double w)
        Create a new region.
        Parameters:
        x, - y, w, h Position and size in normal coordinates that is to say between 0 and 1. Then a region with (x=0,y=0,w=1,h=1) maps the full page. "x" goes left to right. "y" bottom to top.
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegion

        IPlotterRegion createRegion(double x,                          double y,                          double w,                          double h)
        Create a new region.
        Parameters:
        x, - y, w, h Position and size in normal coordinates that is to say between 0 and 1. Then a region with (x=0,y=0,w=1,h=1) maps the full page. "x" goes left to right. "y" bottom to top.
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegions

        void createRegions()                   throws IllegalArgumentException
        Create a grid of regions. By default the current region is the top left one (with index 0). Region are indexed from zero, with increasing order left to right, top to bottom.
        Throws:
        IllegalArgumentException
      • createRegions

        void createRegions(int columns)                   throws IllegalArgumentException
        Create a grid of regions. By default the current region is the top left one (with index 0). Region are indexed from zero, with increasing order left to right, top to bottom.
        Parameters:
        index - Set the current region.
        Throws:
        IllegalArgumentException
      • createRegions

        void createRegions(int columns,                 int rows)                   throws IllegalArgumentException
        Create a grid of regions. By default the current region is the top left one (with index 0). Region are indexed from zero, with increasing order left to right, top to bottom.
        Parameters:
        index - Set the current region.
        Throws:
        IllegalArgumentException
      • createRegions

        void createRegions(int columns,                 int rows,                 int index)                   throws IllegalArgumentException
        Create a grid of regions. By default the current region is the top left one (with index 0). Region are indexed from zero, with increasing order left to right, top to bottom.
        Parameters:
        index - Set the current region.
        Throws:
        IllegalArgumentException
      • currentRegion

        IPlotterRegion currentRegion()
        Returns:
        The current region.
      • currentRegionNumber

        int currentRegionNumber()
        Returns:
        The current region index.
      • numberOfRegions

        int numberOfRegions()
        Returns:
        The number of regions.
      • next

        IPlotterRegion next()
        Set current region to be the "next" one. If exceeding the number of regions, the current region index return to 0.
        Returns:
        The new current region.
      • region

        IPlotterRegion region(int index)
        Returns:
        A region, knowing its index.
      • destroyRegions

        void destroyRegions()
        Destroy regions.
      • clearRegions

        void clearRegions()
        Clear all regions. It does not reset the number and position of regions. This can be done through a destroyRegions.
      • parameterValue

        String parameterValue(String parameter)
        Get value of a parameter.
        Parameters:
        paramName - Name of the parameter.
        Returns:
        the value.
      • availableParameterOptions

        String[] availableParameterOptions(String parameter)
      • availableParameters

        String[] availableParameters()
      • interact

        void interact()              throws RuntimeException
        Give control to the plotter GUI. The plotter must be able to return from this function from a user action in its GUI.
        Throws:
        RuntimeException
      • writeToFile

        void writeToFile(String filename)                 throws IOException
        Produce an output file.
        Parameters:
        type - A string to describe the type of the output : "PS" or "PostScript" for PostScript, "JPEG" for JPEG. If nothing is given, the type is guessed from the given file name suffix (.ps for PostScript, .jpg for JPEG, etc...).
        Throws:
        IOException
      • writeToFile

        void writeToFile(String filename,               String type)                 throws IOException
        Produce an output file.
        Parameters:
        type - A string to describe the type of the output : "PS" or "PostScript" for PostScript, "JPEG" for JPEG. If nothing is given, the type is guessed from the given file name suffix (.ps for PostScript, .jpg for JPEG, etc...).
        Throws:
        IOException
      • setTitle

        void setTitle(String title)
        Set the global title of the plotter (page).
      • title

        String title()
        Get the global title of the plotter (page).
      • setTitleStyle

        void setTitleStyle(ITitleStyle style)
        Set title style
      • setStyle

        void setStyle(IPlotterStyle style)
        Set the global plotter style.

SCaVis 1.7 © jWork.org