This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.
Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
AIDA::IPlotterRegion Class Reference
#include <IPlotterRegion.h>
List of all members.
Public Methods |
| virtual | ~IPlotterRegion () |
| | Destructor. More...
|
| virtual bool | plot (const IBaseHistogram &histogram, const std::string &options="")=0 |
| virtual bool | plot (const IBaseHistogram &histogram, const IPlotterStyle &style, const std::string &options="")=0 |
| virtual bool | plot (const IFunction &function, const std::string &options="")=0 |
| virtual bool | plot (const IFunction &function, const IPlotterStyle &style, const std::string &options="")=0 |
| virtual bool | plot (const IDataPointSet &dataPointSet, const std::string &options="")=0 |
| virtual bool | plot (const IDataPointSet &dataPointSet, const IPlotterStyle &style, const std::string &options="")=0 |
| virtual bool | remove (const IBaseHistogram &histogram)=0 |
| virtual bool | remove (const IFunction &function)=0 |
| virtual bool | remove (const IDataPointSet &dataPointSet)=0 |
| virtual void | clear ()=0 |
| virtual bool | setParameter (const std::string ¶meter, const std::string &options="")=0 |
| virtual std::string | parameterValue (const std::string ¶meter) const=0 |
| virtual std::vector<std::string> | availableParameterOptions (const std::string ¶meter) const=0 |
| virtual std::vector<std::string> | availableParameters () const=0 |
| virtual IPlotterStyle& | style ()=0 |
| virtual bool | setStyle (const IPlotterStyle &style)=0 |
| virtual bool | applyStyle (const IPlotterStyle &style)=0 |
| virtual void | setTitle (const std::string &title)=0 |
| virtual bool | setXLimits (double min=0, double max=0)=0 |
| virtual bool | setYLimits (double min=0, double max=0)=0 |
| virtual bool | setZLimits (double min=0, double max=0)=0 |
| virtual IPlotterLayout& | layout ()=0 |
| virtual bool | setLayout (const IPlotterLayout &layout)=0 |
| virtual IInfo& | info ()=0 |
Detailed Description
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, IInfoStyle. 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.
-
Author:
-
The AIDA team (http://aida.freehep.org/)
Definition at line 62 of file IPlotterRegion.h.
Constructor & Destructor Documentation
|
AIDA::IPlotterRegion::~IPlotterRegion (
|
) [inline, virtual]
|
|
Member Function Documentation
|
bool AIDA::IPlotterRegion::applyStyle (
|
const IPlotterStyle & style ) [pure virtual]
|
|
|
|
Set the style of a region and apply it to scene objects. |
|
std::vector< std::string > AIDA::IPlotterRegion::availableParameterOptions<std::string> (
|
const std::string & parameter ) const [pure virtual]
|
|
|
std::vector< std::string > AIDA::IPlotterRegion::availableParameters<std::string> (
|
) const [pure virtual]
|
|
|
void AIDA::IPlotterRegion::clear (
|
) [pure virtual]
|
|
|
|
Clear the list of things to plot in the region. Clear the corresponding area on screen window(s). |
|
IInfo & AIDA::IPlotterRegion::info (
|
) [pure virtual]
|
|
|
|
Return an IInfo object describing the info area. |
|
|
To customize axis position,etc... Change object position in the scence. |
|
std::string AIDA::IPlotterRegion::parameterValue (
|
const std::string & parameter ) const [pure virtual]
|
|
|
|
Get value of a parameter. -
Parameters:
-
| paramName
|
Name of the parameter. |
-
Returns:
-
the value.
|
|
bool AIDA::IPlotterRegion::plot (
|
const IDataPointSet & dataPointSet,
|
|
const IPlotterStyle & style,
|
|
const std::string & options = "" ) [pure virtual]
|
|
|
bool AIDA::IPlotterRegion::plot (
|
const IDataPointSet & dataPointSet,
|
|
const std::string & options = "" ) [pure virtual]
|
|
|
bool AIDA::IPlotterRegion::plot (
|
const IFunction & function,
|
|
const IPlotterStyle & style,
|
|
const std::string & options = "" ) [pure virtual]
|
|
|
bool AIDA::IPlotterRegion::plot (
|
const IFunction & function,
|
|
const std::string & options = "" ) [pure virtual]
|
|
|
bool AIDA::IPlotterRegion::plot (
|
const IBaseHistogram & histogram,
|
|
const IPlotterStyle & style,
|
|
const std::string & options = "" ) [pure virtual]
|
|
|
bool AIDA::IPlotterRegion::plot (
|
const IBaseHistogram & histogram,
|
|
const std::string & options = "" ) [pure virtual]
|
|
|
|
Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method. |
|
bool AIDA::IPlotterRegion::remove (
|
const IDataPointSet & dataPointSet ) [pure virtual]
|
|
|
bool AIDA::IPlotterRegion::remove (
|
const IFunction & function ) [pure virtual]
|
|
|
bool AIDA::IPlotterRegion::remove (
|
const IBaseHistogram & histogram ) [pure virtual]
|
|
|
|
Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window. |
|
bool AIDA::IPlotterRegion::setLayout (
|
const IPlotterLayout & layout ) [pure virtual]
|
|
|
bool AIDA::IPlotterRegion::setParameter (
|
const std::string & parameter,
|
|
const std::string & options = "" ) [pure virtual]
|
|
|
|
Set various plotting paramters for the region. Activate the graphic layer and update the screen window(s) if needed. |
|
bool AIDA::IPlotterRegion::setStyle (
|
const IPlotterStyle & style ) [pure virtual]
|
|
|
|
Set the style of a region. |
|
void AIDA::IPlotterRegion::setTitle (
|
const std::string & title ) [pure virtual]
|
|
|
|
Set the title of a region. |
|
bool AIDA::IPlotterRegion::setXLimits (
|
double min = 0,
|
|
double max = 0 ) [pure virtual]
|
|
|
|
Set limit of an axis representation the region area. |
|
bool AIDA::IPlotterRegion::setYLimits (
|
double min = 0,
|
|
double max = 0 ) [pure virtual]
|
|
|
bool AIDA::IPlotterRegion::setZLimits (
|
double min = 0,
|
|
double max = 0 ) [pure virtual]
|
|
|
|
Get the style of the region. |
The documentation for this class was generated from the following file:
Generated at Tue Feb 18 15:48:24 2003 for AIDA_Interfaces by
1.2.8.1 written by Dimitri van Heesch,
© 1997-2001