RGHistoWindow.hh

Go to the documentation of this file.

//======================================================================
/*! \file RGHistoWindow.hh
 *
 *  Include file for class RGHistoWindow
 */
//======================================================================

//  18 septembre 2009
//  - option du constructeur pour ne pas créer immédiatement l'interface
//    (nécessaire pour la classe RGHistoTools afin de placer les menus
//     avant les cadres de RGHistoWindow)


#ifndef RG_HISTO_WINDOW_HH
#define RG_HISTO_WINDOW_HH

#include "RGFrameEvent.hh"
#include <TPad.h>
#include <TCanvas.h>
#include <TH1.h>
#include <TRootEmbeddedCanvas.h>
#include <TGFrame.h>
#include <TGSplitter.h>
#include <TGButton.h>
#include <TGLabel.h>
#include <TGNumberEntry.h>

#include "RGHistoLimits.hh"
#include "RGWidgetFunctions.hh"


///! Histogram window options
enum RGHistoWindowOptions
{
  // option de choix des histo
  rghw1DHisto   = 0x00000001,
  rghw2DHisto   = 0x00000002,
  rghw3DHisto   = 0x00000004,
  rghwAllHisto  = 0x00000007,
  rghwCopyHisto = 0x00000008,

  // options des outils prédéfinis
  rghwToolSplitter   = 0x00000010,
  rghwPositionLine   = 0x00000020,
  rghwLimitsTool     = 0x00000040,
  rghwLimitsUnderPad = 0x00000080

};

//======================================================================
/*! class RGHistoWindow
 *
 *  This class defines a window with a plotting zone (canvas) to display
 *  an histogram, and some widgets zone.
 *  Its purpose is to display a single histogram for specific purpose
 *  (the pad should not be divided).
 *
 *  The following options are defined:
 *
 *  - \b rghw1DHisto    allows 1D histograms
 *  - \b rghw2DHisto    allows 2D histograms
 *  - \b rghw3DHisto    allows 3D histograms
 *  - \b rghwAllHisto   allows 1D, 2D and 3D histograms (if none is allowed
 *                      they are all...)
 *  - \b rghwToolSplitter     use a splitter for adjustable separation between
 *                            canvas and the tools frame.
 *  - \b rghwPositionLine     display an information line below the canvas
 *  - \b rghwLimitsTool       set the display limits tools for histograms
 *  - \b rghwLimitsUnderPad   set the display limits tools under the histogram
 *                            pad (default is in tools frame)
 *
 *  When cursor in on the plotting area, the histogram display can be moved
 *  with keyboard arrow keys.
 *  The + and - keys are for zoom in and out.
 *
 *
 *  The (default) interface looks like:
 *
 *  \image html RGHistoWindow.gif
 *
 *
 *  The display limits can also be placed below the plot canvas
 *  (the optional area on the right can be used for additional GUI
 *  elements - see below):
 *
 *  \image html RGHistoWindow_b.gif
 *
 *
 *  It also defines various frames in order to add new elements to the
 *  graphical interface.
 *  The positions of the empty frames are shown here, together with the
 *  (non empty) class frames where new elements can be added:
 *
 *  \image html RGHistoWindow_frames_a.gif
 */

class RGHistoWindow : public TGTransientFrame,
                      public RGFrameEvent,
                      public RGHistoLimits
{
  //------------------------------------------------------------
  /*! \object_doc{RGHistoWindow} */
  GObject(RGHistoWindow);
  //------------------------------------------------------------

  public:
    // For debugging (counter to increment dump files number)
    //static  int       test_count;

    static  UInt_t    canvas_width;   ///< Default canvas width
    static  UInt_t    canvas_height;  ///< Default canvas height

  protected:
    UInt_t        options;        ///< Window options
    bool          limits_widgets; ///< Flag indicating if histogram limits widgets are created

    TCanvas     * canvas_ptr;     ///< Canvas pointer
    TH1         * histo_ptr;      ///< Histogram pointer
    bool          histo_copy;     ///< Flag if the class works with a copy of the histogram

    string        plot_mode;      ///< ROOT options for histogram display

  // Interface widgets
    bool          inhibit_slot;   ///< Prevents recursive calls

    TRootEmbeddedCanvas * w_canvas; ///< Pointer to embedded canvas

    // cadres principaux
    //    +------------------------------------------+
    //    | upper frame                              |
    //    +------------------------------------------+
    //    +------------------------------------------+
    //    | middle frame                             |
    //    | +-------+ +------------------+ +-------+ |
    //    | | mid.  | | center           | | mid.  | |
    //    | | left  | | frame            | | right | |
    //    | | frame | |                  | | frame | |
    //    | |       | |                  | |       | |
    //    | |       | |  up. canvas fr.  | |       | |
    //    | |       | |  canvas + tools  | |       | |
    //    | |       | |                  | |       | |
    //    | |       | |                  | |       | |
    //    | +-------+ +------------------+ +-------+ |
    //    +------------------------------------------+
    //    +------------------------------------------+
    //    | lower frame                              |
    //    +------------------------------------------+

    TGCompositeFrame    * w_upper_frame;            ///< Upper base frame
    TGHorizontalFrame   * w_middle_frame;           ///< Middle base frame
    TGCompositeFrame    *  w_middle_left_frame;     ///<  Middle left frame
    TGHorizontalFrame   *  w_center_frame;          ///<  Middle center frame
    TGCompositeFrame    *    w_upper_canvas_frame;  ///<   Base frame on top of pad
    TGCompositeFrame    *  w_middle_right_frame;    ///<  Middle right frame
    TGCompositeFrame    * w_lower_frame;            ///< Lower base frame

    // cadres de la zone d'outils centrale
    //    +----------------------------------+
    //    | center frame                     |
    //    | +------------------+ s +-------+ |
    //    | |                  | p |       | |
    //    | | canvas frame     | l | tools | |
    //    | |                  | i | frame | |
    //    | |                  | t |       | |
    //    | |                  | t |       | |
    //    | |   position line  | e |       | |
    //    | +------------------+ r +-------+ |
    //    +----------------------------------+
    TGVerticalFrame     * w_canvas_frame;     ///< Canvas frame
    TGVSplitter         * w_splitter;         ///< Frames separator
    TGVerticalFrame     * w_tools_frame;      ///< Tools frame
    TGLabel             * w_position_line;    ///< Position information line

    // cadre des outils
    //    +----------------------------------+
    //    | tools frame                      |
    //    | +------------------------------+ |
    //    | | upper tools frame            | |  définie si le cadre limits
    //    | +------------------------------+ |  est défini (sinon = tools frame)
    //    | +------------------------------+ |
    //    | | limits frame                 | |
    //    | +------------------------------+ |
    //    +----------------------------------+
    TGCompositeFrame    * w_upper_tools_frame;    ///< Upper frame for additionnal widgets
    TGGroupFrame        * w_limits_frame;         ///< Frame for plot limits

    TGHorizontalFrame   *  w_axis_frame;          ///<   Sous-cadre des axes
    TGVerticalFrame     *   w_axis_name_frame;    ///<   Cadre labels des axes
    TGLabel             *    w_x_label;           ///<    Labels
    TGLabel             *    w_y_label;           ///<    Labels
    TGLabel             *    w_z_label;           ///<    Labels
    TGVerticalFrame     *   w_axis_log_frame;     ///<   Cadre boutons échelle log
    TGCheckButton       *    w_x_log_button;      ///<    Bouton échelle log
    TGCheckButton       *    w_y_log_button;      ///<    Bouton échelle log
    TGCheckButton       *    w_z_log_button;      ///<    Bouton échelle log
    TGVerticalFrame     *   w_axis_min_label;     ///<   Cadre labels valeurs min
    TGLabel             *    w_min_label[3];      ///<    Labels
    TGVerticalFrame     *   w_axis_min_value;     ///<   Cadre valeurs min
    TGNumberEntry       *    w_x_min_entry;       ///<    Saisie valeur mini
    TGNumberEntry       *    w_y_min_entry;       ///<    Saisie valeur mini
    TGNumberEntry       *    w_z_min_entry;       ///<    Saisie valeur mini
    TGVerticalFrame     *   w_axis_max_label;     ///<   Cadre labels valeurs max
    TGLabel             *    w_max_label[3];      ///<    Labels
    TGVerticalFrame     *   w_axis_max_value;     ///<   Cadre valeurs min
    TGNumberEntry       *    w_x_max_entry;       ///<    Saisie valeur maxi
    TGNumberEntry       *    w_y_max_entry;       ///<    Saisie valeur maxi
    TGNumberEntry       *    w_z_max_entry;       ///<    Saisie valeur maxi
    TGVerticalFrame     *   w_axis_full_frame;    ///<   Cadre boutons pleine échelle
    TGTextButton        *    w_x_full_button;     ///<    Bouton pleine échelle
    TGTextButton        *    w_y_full_button;     ///<    Bouton pleine échelle
    TGTextButton        *    w_z_full_button;     ///<    Bouton pleine échelle
    TGVerticalFrame     *   w_zoom_frame;         ///<   Cadre boutons zoom
    TGTextButton        *    w_unzoom_button;     ///<    Bouton unzoom
    TGTextButton        *    w_auto_button;       ///<    Bouton échelle automatique
    TGHorizontalFrame   *  w_angles_frame;        ///<  Cadre des angles
    TGNumberEntry       *   w_theta_entry;        ///<   Saisie de l'angle
    TGNumberEntry       *   w_phi_entry;          ///<   Saisie de l'angle

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:

    // Constructor
    RGHistoWindow ( const TGWindow * main      = NULL,
                    TH1            * hptr      = NULL,
                    const string     plot_opt  = "",
                    const UInt_t     opts      = 0,
                    const bool       construct = true,
                    const bool       autostart = true );

    // Copy constructor
    RGHistoWindow ( const RGHistoWindow &original );

    // Affectation operator
    RGHistoWindow & operator = ( const RGHistoWindow &original );

    // Destructor
    virtual ~RGHistoWindow();

  //------------------------------------------------------------
  protected:
    void    ClassInit ( );

  //------------------------------------------------------------
  // Interface construction and execution
  public:
    virtual void    Construct         ( );
    virtual void    ConstructLimits   ( );

    virtual void    MapSubwindows     ( );
    virtual void    RemapToolsFrame   ( );
    virtual void    UpdateWindowTitle ( );

    virtual void    Request   ( );
    virtual void    Quit      ( );

    TGCompositeFrame    * GetUpperFrame       ( );  // inline
    TGHorizontalFrame   * GetMiddleFrame      ( );  // inline
    TGCompositeFrame    * GetMiddleLeftFrame  ( );  // inline
    TGHorizontalFrame   * GetCenterFrame      ( );  // inline
    TGCompositeFrame    * GetUpperCanvasFrame ( );  // inline
    TGVerticalFrame     * GetCanvasFrame      ( );  // inline
    TGCompositeFrame    * GetMiddleRightFrame ( );  // inline
    TGCompositeFrame    * GetLowerFrame       ( );  // inline
    TGVerticalFrame     * GetToolsFrame       ( );  // inline
    TGCompositeFrame    * GetUpperToolsFrame  ( );  // inline

  //------------------------------------------------------------
  // Pad events
    virtual void  PadEvent ( Int_t event, Int_t x, Int_t y, TObject * selected );

    virtual void  SetPositionNul    ( );
    virtual void  SetPositionHisto  ( const Double_t xh, const Double_t yh );
    virtual void  SetPositionXAxis  ( const Double_t xh );
    virtual void  SetPositionYAxis  ( const Double_t yh );
    virtual void  SetPositionZAxis  ( const Double_t zh );

    virtual void  XAxisChanged ( );
    virtual void  YAxisChanged ( );
    virtual void  ZAxisChanged ( );

    virtual void  ArrowKeyLeft  ( );
    virtual void  ArrowKeyRight ( );
    virtual void  ArrowKeyUp    ( );
    virtual void  ArrowKeyDown  ( );

    virtual void  ZoomInKey  ( );
    virtual void  ZoomOutKey ( );

  //------------------------------------------------------------
  // Updates
    virtual void  Reset     ( );

    // Redefinition of RGHistoLimits function
    //      the first one is to avoid compilation warning due
    //      to -Woverloaded-virtual option
    virtual Int_t SetHisto  ( TH1 * hptr, const bool reset = false ); // inline
    virtual Int_t SetHisto  ( TH1 * hptr, const bool reset, const bool redraw );


    virtual void  Redraw       ( );
    virtual void  PlotHisto    ( );
    virtual void  UpdateLimits ( );

    virtual bool  SetXLog ( const Bool_t b = kTRUE );
    virtual bool  SetYLog ( const Bool_t b = kTRUE );
    virtual bool  SetZLog ( const Bool_t b = kTRUE );


    virtual void  SetXFull ( const Bool_t redraw );
    virtual void  SetYFull ( const Bool_t redraw );
    virtual void  SetZFull ( const Bool_t redraw );

        // these function are overloaded from RGHistoLimits to
        // avoid compilation warning
    virtual void  SetXFull ( );   // inline
    virtual void  SetYFull ( );   // inline
    virtual void  SetZFull ( );   // inline

  //------------------------------------------------------------
  //  Slots

    virtual void  LogXToggled ( Bool_t b );
    virtual void  LogYToggled ( Bool_t b );
    virtual void  LogZToggled ( Bool_t b );

    virtual void  XValueChanged ( );
    virtual void  YValueChanged ( );
    virtual void  ZValueChanged ( );

    virtual void  XFullButtonClicked  ( );
    virtual void  YFullButtonClicked  ( );
    virtual void  ZFullButtonClicked  ( );
    virtual void  UnzoomButtonClicked ( );
    virtual void  AutoButtonClicked   ( );

    virtual void  AnglesChanged ( );

  //------------------------------------------------------------
  /*! For ROOT dictionary.*/
    ClassDef(RGHistoWindow,0);
};

//----------------------------------------------------------------------
//  Inline functions
#include "icc/RGHistoWindow.icc"

//======================================================================
#endif