/Users/thomasburton/Documents/projects/eic/Utilities/eicplot/trunk/include/eicplot/MultiPanelPlot.h

#ifndef _EICPLOT_MULTIPANELPLOT_H_
#define _EICPLOT_MULTIPANELPLOT_H_

#include <list>
#include <string>

#include <TH1D.h>
#include <TPad.h>

class TGaxis;
class TH1;
class TString;
class TVirtualPad;

namespace erhic {
   
   class MultiPanelPlot : public TPad {
   public:
      
      MultiPanelPlot(Int_t nColumns = 1, Int_t nRows = 1,
                     Color_t colour = kWhite);
      
      virtual ~MultiPanelPlot();
      
      virtual void SetLogx(Int_t);

      virtual void SetLogy(Int_t);

      virtual void SetLogz(Int_t);

      virtual Int_t GetLogx() const;

      virtual Int_t GetLogy() const;

      virtual Int_t GetLogz() const;
      
      virtual void Divide(Int_t nColumns = 1, Int_t nRows = 1,
                          Float_t = 0.f, Float_t = 0.f, Int_t color = 0);
      
      virtual void SetLeftMargin(Float_t);
      
      virtual void SetRightMargin(Float_t);
      
      virtual void SetBottomMargin(Float_t);
      
      virtual void SetTopMargin(Float_t);
      
      virtual void Draw(Option_t* = "");
      
      virtual TVirtualPad*      cd(Int_t panel = 0);
      
      virtual TVirtualPad*      GetPad(Int_t panel) const;
      
      virtual void Clear(Option_t* = "");
      
      virtual void Modified(Bool_t flag = 1);
      
      virtual Int_t GetNPanels() const;
      
      virtual Int_t GetNColumns() const;
      
      virtual Int_t GetNRows() const;
      
      virtual void ApplyAxes(const std::string&);
      
      virtual bool IsInLeftColumn(Int_t subpadnumber) const;
      
      virtual bool IsInBottomRow(Int_t subpadnumber) const;
      
      virtual bool IsInRightColumn(Int_t subpadnumber) const;
      
      virtual bool IsInTopRow(Int_t subpadnumber) const;
      
      /* for debuggin */
      static void test(const TString& epsName, int rows, int columns);

      bool IsSelf(const TVirtualPad*) const;

   protected:

      unsigned ClearAxes();
      
      TPad& GetSubPad();
      
      virtual void PositionSubPad();
      
      void ConstructXAxis(int padNumber, TH1* histogram);
      
      void ConstructYAxis(int padNumber, TH1* histogram);
      
      virtual double GetDrawableX();
      
      virtual double GetDrawableY();
      
      virtual TH1* FindHistogram(TVirtualPad*);

      void ApplyMarginForColourPalette(TVirtualPad*, TH1*);
      
      Int_t mNX; 
      Int_t mNY; 
      Int_t mLogx; 
      Int_t mLogy; 
      Int_t mLogz; 
      
      // The MultiPanelPlot itself contains a sub-pad, onto which the
      // histograms are drawn. It is this sub-pad which is divided into
      // individual panels for each histogram.
      // The only things drawn onto the MultiPanelPlot itself are
      //  - the sub-pad
      //  - copies of TGaxis objects in the margins at the left and bottom
      //    between the edge of the main pad and the sub-pad.
      TPad* mSubPad;
      
      std::list<TGaxis*> mAxes; 
      
      double mLabelSize;
      
      ClassDef(MultiPanelPlot, 1)
   };
   
   inline Int_t MultiPanelPlot::GetLogx() const {
      return mLogx;
   }
   
   inline Int_t MultiPanelPlot::GetLogy() const {
      return mLogy;
   }
   
   inline Int_t MultiPanelPlot::GetLogz() const {
      return mLogz;
   }
   
   inline Int_t MultiPanelPlot::GetNPanels() const {
      return GetNColumns() * GetNRows();
   }
   
   inline Int_t MultiPanelPlot::GetNColumns() const {
      return mNX;
   }
   
   inline Int_t MultiPanelPlot::GetNRows() const {
      return mNY;
   }
   
   inline void MultiPanelPlot::Modified(Bool_t flag) {
      GetSubPad().Modified(flag);
      TPad::Modified(flag);
   }
   
   inline double MultiPanelPlot::GetDrawableX() {
      return 1. - GetRightMargin() - GetLeftMargin();
   }
   
   inline double MultiPanelPlot::GetDrawableY() {
      return 1. - GetTopMargin() - GetBottomMargin();
   }
} // namespace erhic

#endif