<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">\section{A\-I\-D\-A\-:\-:I\-Plotter\-Region Class Reference}
\label{classAIDA_1_1IPlotterRegion}\index{A\-I\-D\-A\-::\-I\-Plotter\-Region@{A\-I\-D\-A\-::\-I\-Plotter\-Region}}


User level interface to a plotter region.  




{\ttfamily \#include $&lt;$I\-Plotter\-Region.\-h$&gt;$}

Inheritance diagram for A\-I\-D\-A\-:\-:I\-Plotter\-Region\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classAIDA_1_1IPlotterRegion}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual {\bf $\sim$\-I\-Plotter\-Region} ()\label{classAIDA_1_1IPlotterRegion_a5ac3a5cd2fb07c146e3c4286a290b60c}

\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
virtual bool {\bf plot} (const {\bf I\-Base\-Histogram} \&amp;histogram, const std\-::string \&amp;options=\char`\"{}\char`\"{})=0
\begin{DoxyCompactList}\small\item\em Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. \end{DoxyCompactList}\item 
virtual bool {\bfseries plot} (const {\bf I\-Base\-Histogram} \&amp;histogram, const {\bf I\-Plotter\-Style} \&amp;{\bf style}, const std\-::string \&amp;options=\char`\"{}\char`\"{})=0\label{classAIDA_1_1IPlotterRegion_a2a1c591632a791acd7e8b5b866c2902b}

\item 
virtual bool {\bfseries plot} (const {\bf I\-Function} \&amp;function, const std\-::string \&amp;options=\char`\"{}\char`\"{})=0\label{classAIDA_1_1IPlotterRegion_a791c553649152ad9969c9bdcf4b3c7b8}

\item 
virtual bool {\bfseries plot} (const {\bf I\-Function} \&amp;function, const {\bf I\-Plotter\-Style} \&amp;{\bf style}, const std\-::string \&amp;options=\char`\"{}\char`\"{})=0\label{classAIDA_1_1IPlotterRegion_a97ca856951130316d26a235ed751c855}

\item 
virtual bool {\bfseries plot} (const {\bf I\-Data\-Point\-Set} \&amp;data\-Point\-Set, const std\-::string \&amp;options=\char`\"{}\char`\"{})=0\label{classAIDA_1_1IPlotterRegion_a3e88f9c4226227e5cfeebae9d7b18dfc}

\item 
virtual bool {\bfseries plot} (const {\bf I\-Data\-Point\-Set} \&amp;data\-Point\-Set, const {\bf I\-Plotter\-Style} \&amp;{\bf style}, const std\-::string \&amp;options=\char`\"{}\char`\"{})=0\label{classAIDA_1_1IPlotterRegion_ab4a2b351bf7c8971c8d1cf3e115dd2a9}

\item 
virtual bool {\bf remove} (const {\bf I\-Base\-Histogram} \&amp;histogram)=0
\begin{DoxyCompactList}\small\item\em Remove a data analysis object in the list of things to plot in the region. \end{DoxyCompactList}\item 
virtual bool {\bfseries remove} (const {\bf I\-Function} \&amp;function)=0\label{classAIDA_1_1IPlotterRegion_a19b6b8a2adca51a2e9e2989ec917b81c}

\item 
virtual bool {\bfseries remove} (const {\bf I\-Data\-Point\-Set} \&amp;data\-Point\-Set)=0\label{classAIDA_1_1IPlotterRegion_a69cb3dac67476cf4bded47fc1bce2591}

\item 
virtual void {\bf clear} ()=0
\begin{DoxyCompactList}\small\item\em Clear the list of things to plot in the region. \end{DoxyCompactList}\item 
virtual bool {\bf set\-Parameter} (const std\-::string \&amp;parameter, const std\-::string \&amp;options=\char`\"{}\char`\"{})=0
\begin{DoxyCompactList}\small\item\em Set various plotting paramters for the region. \end{DoxyCompactList}\item 
virtual std\-::string {\bf parameter\-Value} (const std\-::string \&amp;parameter) const =0
\begin{DoxyCompactList}\small\item\em Get value of a parameter. \end{DoxyCompactList}\item 
virtual std\-::vector$&lt;$ std\-::string $&gt;$ {\bfseries available\-Parameter\-Options} (const std\-::string \&amp;parameter) const =0\label{classAIDA_1_1IPlotterRegion_aa30a6fc3417f30499e5c87fcf2a438ab}

\item 
virtual std\-::vector$&lt;$ std\-::string $&gt;$ {\bfseries available\-Parameters} () const =0\label{classAIDA_1_1IPlotterRegion_abe0f2046914a41c97ce0d7c11ff84707}

\item 
virtual {\bf I\-Plotter\-Style} \&amp; {\bf style} ()=0\label{classAIDA_1_1IPlotterRegion_a2e1ddb25b1987d3f2692e33d5430f526}

\begin{DoxyCompactList}\small\item\em Get the style of the region. \end{DoxyCompactList}\item 
virtual bool {\bf set\-Style} (const {\bf I\-Plotter\-Style} \&amp;{\bf style})=0\label{classAIDA_1_1IPlotterRegion_a69a5ae1f61c8194dd128b47d2df3d487}

\begin{DoxyCompactList}\small\item\em Set the style of a region. \end{DoxyCompactList}\item 
virtual bool {\bf apply\-Style} (const {\bf I\-Plotter\-Style} \&amp;{\bf style})=0\label{classAIDA_1_1IPlotterRegion_ab5eb0501d637ef550cf0ce989b98adf0}

\begin{DoxyCompactList}\small\item\em Set the style of a region and apply it to scene objects. \end{DoxyCompactList}\item 
virtual void {\bf set\-Title} (const std\-::string \&amp;title)=0\label{classAIDA_1_1IPlotterRegion_afb088f7c592df8ab99df3a03808b6bbf}

\begin{DoxyCompactList}\small\item\em Set the title of a region. \end{DoxyCompactList}\item 
virtual bool {\bf set\-X\-Limits} (double min=0, double max=0)=0\label{classAIDA_1_1IPlotterRegion_ad09d73d5463741d0b6fb783501313c16}

\begin{DoxyCompactList}\small\item\em Set limit of an axis representation the region area. \end{DoxyCompactList}\item 
virtual bool {\bfseries set\-Y\-Limits} (double min=0, double max=0)=0\label{classAIDA_1_1IPlotterRegion_a28e55551dc15b5305acd58f514452391}

\item 
virtual bool {\bfseries set\-Z\-Limits} (double min=0, double max=0)=0\label{classAIDA_1_1IPlotterRegion_ac3fce98340bcada6bfa2effb53b776dd}

\item 
virtual {\bf I\-Plotter\-Layout} \&amp; {\bf layout} ()=0
\begin{DoxyCompactList}\small\item\em To customize axis position,etc... \end{DoxyCompactList}\item 
virtual bool {\bfseries set\-Layout} (const {\bf I\-Plotter\-Layout} \&amp;{\bf layout})=0\label{classAIDA_1_1IPlotterRegion_a33de57daec4d48c6c4c8fbfc40585441}

\item 
virtual {\bf I\-Info} \&amp; {\bf info} ()=0\label{classAIDA_1_1IPlotterRegion_a4f6c23789620bc57bf3c3314e563d32b}

\begin{DoxyCompactList}\small\item\em Return an \doxyref{I\-Info}{p.}{classAIDA_1_1IInfo} object describing the info area. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{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 \char`\"{}plotting\char`\"{} scene. In general this kind of scene may be in 2\-D or 3\-D. In 2\-D, the scene have \char`\"{}coarse graining parts\char`\"{} like two axis, data representations within the axis. It may have various other parts like a grid, a title, an info area. In 3\-D, 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 \char`\"{}style\char`\"{} interfaces had been introduced. In general there is one style interface per \char`\"{}scene part\char`\"{} ; then \doxyref{I\-Axis\-Style}{p.}{classAIDA_1_1IAxisStyle}, \doxyref{I\-Data\-Style}{p.}{classAIDA_1_1IDataStyle}, \doxyref{I\-Title\-Style}{p.}{classAIDA_1_1ITitleStyle}, \doxyref{I\-Info\-Style}{p.}{classAIDA_1_1IInfoStyle}. Oftenly a \char`\"{}scene part\char`\"{} contains text, line, fill area, etc.... For example an \char`\"{}axis\char`\"{} have a line, ticks, text for tick labels, text for the label of the axis, the magnitude, etc... A \char`\"{}coarse graining scene part\char`\"{} style contains various accessor to \char`\"{}atomic\char`\"{} styles like \doxyref{I\-Marker\-Style}{p.}{classAIDA_1_1IMarkerStyle}, \doxyref{I\-Line\-Style}{p.}{classAIDA_1_1ILineStyle}, \doxyref{I\-Fill\-Style}{p.}{classAIDA_1_1IFillStyle} that permits to build a \char`\"{}customization block\char`\"{} to modify a scene part.

A global style \char`\"{}block\char`\"{}, the \doxyref{I\-Plotter\-Style}{p.}{classAIDA_1_1IPlotterStyle}, could be retreived from a plotting region. This global style block have accessors to the various \char`\"{}coarse graining scene parts\char`\"{} of the plotting scene. Through it, we hope to offer a lot of customization in a convenient way...

The keywords \char`\"{}scene\char`\"{} and \char`\"{}part\char`\"{} had been borrowed from the Open\-Inventor terminology.

\begin{DoxyAuthor}{Author}
The \doxyref{A\-I\-D\-A}{p.}{namespaceAIDA} team ({\tt http\-://aida.\-freehep.\-org/}) 
\end{DoxyAuthor}


\subsection{Member Function Documentation}
\index{A\-I\-D\-A\-::\-I\-Plotter\-Region@{A\-I\-D\-A\-::\-I\-Plotter\-Region}!clear@{clear}}
\index{clear@{clear}!AIDA::IPlotterRegion@{A\-I\-D\-A\-::\-I\-Plotter\-Region}}
\subsubsection[{clear}]{\setlength{\rightskip}{0pt plus 5cm}virtual void A\-I\-D\-A\-::\-I\-Plotter\-Region\-::clear (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IPlotterRegion_a51fbb01fb4520aaf423e6a4fb04ce168}


Clear the list of things to plot in the region. 

Clear the corresponding area on screen window(s). 

Implemented in {\bf A\-I\-D\-A\-::\-I\-Plotter\-Region\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IPlotterRegionROOT_a4f7a46256362dc05a3868331fdbf5409}.

\index{A\-I\-D\-A\-::\-I\-Plotter\-Region@{A\-I\-D\-A\-::\-I\-Plotter\-Region}!layout@{layout}}
\index{layout@{layout}!AIDA::IPlotterRegion@{A\-I\-D\-A\-::\-I\-Plotter\-Region}}
\subsubsection[{layout}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf I\-Plotter\-Layout}\&amp; A\-I\-D\-A\-::\-I\-Plotter\-Region\-::layout (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IPlotterRegion_ac97e8fef4ac609d3bee57ddd2e224763}


To customize axis position,etc... 

Change object position in the scence. 

Implemented in {\bf A\-I\-D\-A\-::\-I\-Plotter\-Region\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IPlotterRegionROOT_a02cb34496d7fca4e3347acaba338776e}.

\index{A\-I\-D\-A\-::\-I\-Plotter\-Region@{A\-I\-D\-A\-::\-I\-Plotter\-Region}!parameter\-Value@{parameter\-Value}}
\index{parameter\-Value@{parameter\-Value}!AIDA::IPlotterRegion@{A\-I\-D\-A\-::\-I\-Plotter\-Region}}
\subsubsection[{parameter\-Value}]{\setlength{\rightskip}{0pt plus 5cm}virtual std\-::string A\-I\-D\-A\-::\-I\-Plotter\-Region\-::parameter\-Value (
\begin{DoxyParamCaption}
\item[{const std\-::string \&amp;}]{parameter}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IPlotterRegion_addf514b8ba32971de3d8fd5a030733ea}


Get value of a parameter. 


\begin{DoxyParams}{Parameters}
{\em param\-Name} &amp; Name of the parameter. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Plotter\-Region\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IPlotterRegionROOT_a6e8ffb8408e21c2945a4877cb82d3719}.

\index{A\-I\-D\-A\-::\-I\-Plotter\-Region@{A\-I\-D\-A\-::\-I\-Plotter\-Region}!plot@{plot}}
\index{plot@{plot}!AIDA::IPlotterRegion@{A\-I\-D\-A\-::\-I\-Plotter\-Region}}
\subsubsection[{plot}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool A\-I\-D\-A\-::\-I\-Plotter\-Region\-::plot (
\begin{DoxyParamCaption}
\item[{const {\bf I\-Base\-Histogram} \&amp;}]{histogram, }
\item[{const std\-::string \&amp;}]{options = {\ttfamily \char`\"{}\char`\"{}}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IPlotterRegion_a9158c3a0bbee7c34256a518bca29cf68}


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. 

Implemented in {\bf A\-I\-D\-A\-::\-I\-Plotter\-Region\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IPlotterRegionROOT_a9187cc7c2c2f626a2f109745954d7ff0}.

\index{A\-I\-D\-A\-::\-I\-Plotter\-Region@{A\-I\-D\-A\-::\-I\-Plotter\-Region}!remove@{remove}}
\index{remove@{remove}!AIDA::IPlotterRegion@{A\-I\-D\-A\-::\-I\-Plotter\-Region}}
\subsubsection[{remove}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool A\-I\-D\-A\-::\-I\-Plotter\-Region\-::remove (
\begin{DoxyParamCaption}
\item[{const {\bf I\-Base\-Histogram} \&amp;}]{histogram}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IPlotterRegion_a8f2460dd93174fe21409a1676c03740b}


Remove a data analysis object in the list of things to plot in the region. 

Activate the graphic layer to update the screen window. 

Implemented in {\bf A\-I\-D\-A\-::\-I\-Plotter\-Region\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IPlotterRegionROOT_a1497f826f6d94989a6f26a3b04a9cae1}.

\index{A\-I\-D\-A\-::\-I\-Plotter\-Region@{A\-I\-D\-A\-::\-I\-Plotter\-Region}!set\-Parameter@{set\-Parameter}}
\index{set\-Parameter@{set\-Parameter}!AIDA::IPlotterRegion@{A\-I\-D\-A\-::\-I\-Plotter\-Region}}
\subsubsection[{set\-Parameter}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool A\-I\-D\-A\-::\-I\-Plotter\-Region\-::set\-Parameter (
\begin{DoxyParamCaption}
\item[{const std\-::string \&amp;}]{parameter, }
\item[{const std\-::string \&amp;}]{options = {\ttfamily \char`\"{}\char`\"{}}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IPlotterRegion_a4c02441261456277cbe85da505341190}


Set various plotting paramters for the region. 

Activate the graphic layer and update the screen window(s) if needed. 

Implemented in {\bf A\-I\-D\-A\-::\-I\-Plotter\-Region\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IPlotterRegionROOT_a9cee2118e953325d6221b8eb3fe79b5a}.



The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
I\-Plotter\-Region.\-h\end{DoxyCompactItemize}
</pre></body></html>