IPlotterRegion
hep.aida

Interface IPlotterRegion

  • All Known Implementing Classes:
    PlotterRegion


    public interface IPlotterRegion
    User level interface to a plotter region. A region is managed by a plotter. A region must be seen as a scene manager handling a custome "plotting" scene. In general this kind of scene may be in 2D or 3D. In 2D, the scene have "coarse graining parts" like two axis, data representations within the axis. It may have various other parts like a grid, a title, an info area. In 3D, the scene have in general three axis, a different global layout, some data representations within the axis area and also scene parts like title, grid, etc... To customize all these, some "style" interfaces had been introduced. In general there is one style interface per "scene part" ; then IAxisStyle, IDataStyle, ITitleStyle. Oftenly a "scene part" contains text, line, fill area, etc.... For example an "axis" have a line, ticks, text for tick labels, text for the label of the axis, the magnitude, etc... A "coarse graining scene part" style contains various accessor to "atomic" styles like IMarkerStyle, ILineStyle, IFillStyle that permits to build a "customization block" to modify a scene part. A global style "block", the IPlotterStyle, could be retreived from a plotting region. This global style block have accessors to the various "coarse graining scene parts" of the plotting scene. Through it, we hope to offer a lot of customization in a convenient way... The keywords "scene" and "part" had been borrowed from the OpenInventor terminology.
    • Method Summary

      Methods 
      Modifier and TypeMethod and Description
      voidapplyStyle(IPlotterStyle style)
      Set the style of a region and apply it to scene objects.
      String[]availableParameterOptions(String parameter)
      Get available options for a parameter.
      String[]availableParameters()
      Get avaliable parameters.
      voidclear()
      Clear the list of things to plot in the region.
      IInfoinfo()
      Return an IInfo object describing the info area.
      IPlotterLayoutlayout()
      To customize axis position,etc...
      StringparameterValue(String parameter)
      Get value of a parameter.
      voidplot(IBaseHistogram histogram)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IBaseHistogram histogram, IPlotterStyle style)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IBaseHistogram histogram, IPlotterStyle style, String options)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IBaseHistogram histogram, String options)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IDataPointSet dataPointSet)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IDataPointSet dataPointSet, IPlotterStyle style)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IDataPointSet dataPointSet, IPlotterStyle style, String options)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IDataPointSet dataPointSet, String options)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IFunction function)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IFunction function, IPlotterStyle style)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IFunction function, IPlotterStyle style, String options)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IFunction function, String options)
      Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
      voidplot(IPlottable plottable)
      Send a generic plottable object to the plotting region.
      voidplot(IPlottable plottable, IPlotterStyle style)
      Send a generic plottable object to the plotting region.
      voidplot(IPlottable plottable, IPlotterStyle style, String options)
      Send a generic plottable object to the plotting region.
      voidplot(IPlottable plottable, String options)
      Send a generic plottable object to the plotting region.
      voidrefresh()
      Refresh the plotter region graphic.
      voidremove(IBaseHistogram histogram)
      Remove a data analysis object in the list of things to plot in the region.
      voidremove(IDataPointSet dataPointSet)
      Remove a data analysis object in the list of things to plot in the region.
      voidremove(IFunction function)
      Remove a data analysis object in the list of things to plot in the region.
      voidremove(IPlottable plottable)
      Generic entry point to remove some plotted scene part.
      voidsetLayout(IPlotterLayout layout)
      To customize axis position,etc...
      voidsetParameter(String parameter)
      Set various plotting paramters for the region.
      voidsetParameter(String parameter, String options)
      Set various plotting paramters for the region.
      voidsetStyle(IPlotterStyle style)
      Set the style of a region.
      voidsetTitle(String title)
      Set the title of a region.
      voidsetXLimits()
      Set limit of an axis representation the region area.
      voidsetXLimits(double min)
      Set limit of an axis representation the region area.
      voidsetXLimits(double min, double max)
      Set limit of an axis representation the region area.
      voidsetYLimits()
      Set limit of an axis representation the region area.
      voidsetYLimits(double min)
      Set limit of an axis representation the region area.
      voidsetYLimits(double min, double max)
      Set limit of an axis representation the region area.
      voidsetZLimits()
      Set limit of an axis representation the region area.
      voidsetZLimits(double min)
      Set limit of an axis representation the region area.
      voidsetZLimits(double min, double max)
      Set limit of an axis representation the region area.
      IPlotterStylestyle()
      Get the style of the region.
      Stringtitle()
      Get the title of the region.
      doublexLimitMax()
      Get the max limit of x.
      doublexLimitMin()
      Get the min limit of x.
      doubleyLimitMax()
      Get the max limit of y.
      doubleyLimitMin()
      Get the min limit of y.
      doublezLimitMax()
      Get the max limit of z.
      doublezLimitMin()
      Get the min limit of z.

SCaVis 2.1 © jWork.ORG