Logo ROOT   6.30.04
Reference Guide
 All Namespaces Files Pages
TGLPlotPainter.h
Go to the documentation of this file.
1 // @(#)root/gl:$Id$
2 // Author: Timur Pocheptsov 14/06/2006
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2004, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #ifndef ROOT_TGLPlotPainter
13 #define ROOT_TGLPlotPainter
14 
15 #include <vector>
16 
17 #include "TVirtualGL.h"
18 #include "TGLPlotBox.h"
19 #include "TPoint.h"
20 #include "TGLUtil.h"
21 #include "TNamed.h"
22 
23 class TGLPlotCoordinates;
24 class TGLPlotCamera;
25 class TGL5DDataSet;
26 class TString;
27 class TColor;
28 class TAxis;
29 class TH1;
30 class TH3;
31 class TF3;
32 
33 /*
34  Box cut. When attached to a plot, cuts away a part of it.
35  Can be moved in a plot's own area in X/Y/Z directions.
36 */
37 
38 class TGLBoxCut {
39 private:
40  Double_t fXLength;
41  Double_t fYLength;
42  Double_t fZLength;
43  TGLVertex3 fCenter;
44  Rgl::Range_t fXRange;
45  Rgl::Range_t fYRange;
46  Rgl::Range_t fZRange;
47 
48  const TGLPlotBox * const fPlotBox;
49  Bool_t fActive;
50  Double_t fFactor;
51 
52  TPoint fMousePos;
53 
54 public:
55  TGLBoxCut(const TGLPlotBox *plotBox);
56  virtual ~TGLBoxCut();
57 
58  void TurnOnOff();
59  Bool_t IsActive()const{return fActive;}
60  void SetActive(Bool_t a);
61 
62  void ResetBoxGeometry();
63 
64  void SetFactor(Double_t f){fFactor = f;}
65 
66  void DrawBox(Bool_t selectionPass, Int_t selected)const;
67 
68  void StartMovement(Int_t px, Int_t py);
69  void MoveBox(Int_t px, Int_t py, Int_t axisID);
70 
71  Bool_t IsInCut(Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax,
72  Double_t zMin, Double_t zMax)const;
73 
74  template<class V>
75  Bool_t IsInCut(const V * v) const
76  {
77  //Check, if box defined by xmin/xmax etc. is in cut.
78  if (v[0] >= fXRange.first && v[0] < fXRange.second &&
79  v[1] >= fYRange.first && v[1] < fYRange.second &&
80  v[2] >= fZRange.first && v[2] < fZRange.second)
81  return kTRUE;
82  return kFALSE;
83  }
84 
85  Rgl::Range_t GetXRange()const{return fXRange;}
86  Rgl::Range_t GetYRange()const{return fYRange;}
87  Rgl::Range_t GetZRange()const{return fZRange;}
88 
89 private:
90  void AdjustBox();
91 
92  ClassDef(TGLBoxCut, 0)//Cuts away part of a plot.
93 };
94 
95 /*
96  2D contour for TH3 slicing.
97 */
98 
99 class TGLTH3Slice : public TNamed {
100 public:
101  enum ESliceAxis {kXOZ, kYOZ, kXOY};
102 
103 private:
104  ESliceAxis fAxisType;
105  const TAxis *fAxis;
106  mutable TGLLevelPalette fPalette;
107 
108  const TGLPlotCoordinates *fCoord;
109  const TGLPlotBox *fBox;
110  Int_t fSliceWidth;
111 
112  const TH3 *fHist;
113  const TF3 *fF3;
114 
115  mutable TGL2DArray<Double_t> fTexCoords;
116 
117  mutable Rgl::Range_t fMinMax;
118 
119 public:
120  TGLTH3Slice(const TString &sliceName,
121  const TH3 *hist,
122  const TGLPlotCoordinates *coord,
123  const TGLPlotBox * box,
124  ESliceAxis axis);
125  TGLTH3Slice(const TString &sliceName,
126  const TH3 *hist, const TF3 *fun,
127  const TGLPlotCoordinates *coord,
128  const TGLPlotBox * box,
129  ESliceAxis axis);
130 
131  void DrawSlice(Double_t pos)const;
132  //SetSliceWidth must have "menu" comment.
133  void SetSliceWidth(Int_t width = 1); // *MENU*
134 
135  void SetMinMax(const Rgl::Range_t &newRange)
136  {
137  fMinMax = newRange;
138  }
139 
140  const TGLLevelPalette & GetPalette()const
141  {
142  return fPalette;
143  }
144 
145 private:
146  void PrepareTexCoords(Double_t pos, Int_t sliceBegin, Int_t sliceEnd)const;
147  void FindMinMax(Int_t sliceBegin, Int_t sliceEnd)const;
148  Bool_t PreparePalette()const;
149  void DrawSliceTextured(Double_t pos)const;
150  void DrawSliceFrame(Int_t low, Int_t up)const;
151 
152  ClassDef(TGLTH3Slice, 0) // TH3 slice
153 };
154 
155 
156 /*
157  TGLPlotPainter class defines interface to different plot painters.
158 */
159 
160 class TGLPlotPainter;
161 
162 /*
163 Object of this class, created on stack in DrawPlot member-functions,
164 saves modelview matrix, moves plot to (0; 0; 0), and
165 restores modelview matrix in dtor.
166 */
167 
168 namespace Rgl {
169 
170 class PlotTranslation {
171 public:
172  PlotTranslation(const TGLPlotPainter *painter);
173  ~PlotTranslation();
174 
175 private:
176  const TGLPlotPainter *fPainter;
177 };
178 
179 }
180 
181 class TGLPlotPainter : public TVirtualGLPainter {
182  friend class Rgl::PlotTranslation;
183 private:
184  const TColor *fPadColor;
185 
186 protected:
187  const Float_t *fPhysicalShapeColor;
188 
189  Double_t fPadPhi;
190  Double_t fPadTheta;
191  TH1 *fHist;
192  TAxis *fXAxis;
193  TAxis *fYAxis;
194  TAxis *fZAxis;
195 
196  TGLPlotCoordinates *fCoord;
197  TGLPlotCamera *fCamera;
198  TGLSelectionBuffer fSelection;
199 
200  Bool_t fUpdateSelection;
201  Bool_t fSelectionPass;
202  Int_t fSelectedPart;
203  TPoint fMousePosition;
204  mutable Double_t fXOZSectionPos;
205  mutable Double_t fYOZSectionPos;
206  mutable Double_t fXOYSectionPos;
207  TGLPlotBox fBackBox;
208  TGLBoxCut fBoxCut;
209 
210  std::vector<Double_t> fZLevels;
211  Bool_t fHighColor;
212 
213  enum ESelectionBase{
214  kHighColorSelectionBase = 7,
215  kTrueColorSelectionBase = 10
216  };
217 
218  Int_t fSelectionBase;
219  mutable Bool_t fDrawPalette;
220  Bool_t fDrawAxes;
221 
222 public:
223 /* TGLPlotPainter(TH1 *hist, TGLPlotCamera *camera, TGLPlotCoordinates *coord, Int_t context,
224  Bool_t xoySelectable, Bool_t xozSelectable, Bool_t yozSelectable);
225  TGLPlotPainter(TGLPlotCamera *camera, Int_t context);*/
226  TGLPlotPainter(TH1 *hist, TGLPlotCamera *camera, TGLPlotCoordinates *coord,
227  Bool_t xoySelectable, Bool_t xozSelectable, Bool_t yozSelectable);
228  TGLPlotPainter(TGL5DDataSet *data, TGLPlotCamera *camera, TGLPlotCoordinates *coord);
229  TGLPlotPainter(TGLPlotCamera *camera);
230 
231  const TGLPlotBox& RefBackBox() const { return fBackBox; }
232  void SetPhysicalShapeColor(const Float_t *rgba)
233  {
234  fPhysicalShapeColor = rgba;
235  }
236 
237  virtual void InitGL()const = 0;
238  virtual void DeInitGL()const = 0;
239  virtual void DrawPlot()const = 0;
240  virtual void Paint();
241 
242  //Checks, if mouse cursor is above plot.
243  virtual Bool_t PlotSelected(Int_t px, Int_t py);
244  //Init geometry does plot's specific initialization.
245  virtual Bool_t InitGeometry() = 0;
246 
247  virtual void StartPan(Int_t px, Int_t py) = 0;
248  //Pan function is already declared in TVirtualGLPainter.
249 
250  //Add string option, it can be a digit in "lego" or "surf".
251  virtual void AddOption(const TString &stringOption) = 0;
252  //Function to process additional events (key presses, mouse clicks.)
253  virtual void ProcessEvent(Int_t event, Int_t px, Int_t py) = 0;
254  //Used by GLpad
255  void SetPadColor(const TColor *color);
256 
257  virtual void SetFrameColor(const TColor *frameColor);
258  //Camera is external to painter, if zoom was changed, or camera
259  //was rotated, selection must be invalidated.
260  void InvalidateSelection();
261 
262  enum ECutAxisID {
263  kXAxis = 7,
264  kYAxis = 8,
265  kZAxis = 9
266  };
267 
268  Bool_t CutAxisSelected()const{return !fHighColor && fSelectedPart <= kZAxis && fSelectedPart >= kXAxis;}
269 
270  void SetDrawFrontBox(Bool_t b) {fBackBox.SetDrawFront(b);}
271  void SetDrawBackBox(Bool_t b) {fBackBox.SetDrawBack(b);}
272  void SetDrawAxes(Bool_t s) {fDrawAxes = s;}
273  Bool_t GetDrawAxes() {return fDrawAxes;}
274 
275 protected:
276  const TColor *GetPadColor()const;
277  //
278  void MoveSection(Int_t px, Int_t py);
279  void DrawSections()const;
280  virtual void DrawSectionXOZ()const = 0;
281  virtual void DrawSectionYOZ()const = 0;
282  virtual void DrawSectionXOY()const = 0;
283 
284  virtual void DrawPaletteAxis()const;
285 
286  virtual void ClearBuffers()const;
287 
288  void PrintPlot()const;
289 
290  //Attention! After one of this methods was called,
291  //the GL_MATRIX_MODE could become different from what
292  //you had before the call: for example, SaveModelviewMatrix will
293  //change it to GL_MODELVIEW.
294  void SaveModelviewMatrix()const;
295  void SaveProjectionMatrix()const;
296 
297  void RestoreModelviewMatrix()const;
298  void RestoreProjectionMatrix()const;
299 
300  ClassDef(TGLPlotPainter, 0) //Base for gl plots
301 };
302 
303 /*
304  Auxiliary class, which holds different
305  information about plot's current coordinate system
306 */
307 
308 class TH2Poly;
309 
310 class TGLPlotCoordinates {
311 private:
312  EGLCoordType fCoordType;
313 
314  Rgl::BinRange_t fXBins;
315  Rgl::BinRange_t fYBins;
316  Rgl::BinRange_t fZBins;
317 
318  Double_t fXScale;
319  Double_t fYScale;
320  Double_t fZScale;
321 
322  Rgl::Range_t fXRange;
323  Rgl::Range_t fYRange;
324  Rgl::Range_t fZRange;
325 
326  Rgl::Range_t fXRangeScaled;
327  Rgl::Range_t fYRangeScaled;
328  Rgl::Range_t fZRangeScaled;
329 
330  Bool_t fXLog;
331  Bool_t fYLog;
332  Bool_t fZLog;
333 
334  Bool_t fModified;
335  Double_t fFactor;
336 
337 public:
338  TGLPlotCoordinates();
339  virtual ~TGLPlotCoordinates();
340 
341  void SetCoordType(EGLCoordType type);
342  EGLCoordType GetCoordType()const;
343 
344  void SetXLog(Bool_t xLog);
345  Bool_t GetXLog()const;
346 
347  void SetYLog(Bool_t yLog);
348  Bool_t GetYLog()const;
349 
350  void SetZLog(Bool_t zLog);
351  Bool_t GetZLog()const;
352 
353  void ResetModified();
354  Bool_t Modified()const;
355  //
356  Bool_t SetRanges(const TH1 *hist, Bool_t errors = kFALSE, Bool_t zBins = kFALSE);
357  //
358  Bool_t SetRanges(TH2Poly *hist);
359  //
360  Bool_t SetRanges(const TAxis *xAxis, const TAxis *yAxis, const TAxis *zAxis);
361 
362  Int_t GetNXBins()const;
363  Int_t GetNYBins()const;
364  Int_t GetNZBins()const;
365 
366  const Rgl::BinRange_t &GetXBins()const;
367  const Rgl::BinRange_t &GetYBins()const;
368  const Rgl::BinRange_t &GetZBins()const;
369 
370  const Rgl::Range_t &GetXRange()const;
371  Double_t GetXLength()const;
372  const Rgl::Range_t &GetYRange()const;
373  Double_t GetYLength()const;
374  const Rgl::Range_t &GetZRange()const;
375  Double_t GetZLength()const;
376 
377  const Rgl::Range_t &GetXRangeScaled()const;
378  const Rgl::Range_t &GetYRangeScaled()const;
379  const Rgl::Range_t &GetZRangeScaled()const;
380 
381  Double_t GetXScale()const{return fXScale;}
382  Double_t GetYScale()const{return fYScale;}
383  Double_t GetZScale()const{return fZScale;}
384 
385  Int_t GetFirstXBin()const{return fXBins.first;}
386  Int_t GetLastXBin()const{return fXBins.second;}
387  Int_t GetFirstYBin()const{return fYBins.first;}
388  Int_t GetLastYBin()const{return fYBins.second;}
389  Int_t GetFirstZBin()const{return fZBins.first;}
390  Int_t GetLastZBin()const{return fZBins.second;}
391 
392  Double_t GetFactor()const;
393 
394 private:
395  Bool_t SetRangesPolar(const TH1 *hist);
396  Bool_t SetRangesCylindrical(const TH1 *hist);
397  Bool_t SetRangesSpherical(const TH1 *hist);
398 
399  Bool_t SetRangesCartesian(const TH1 *hist, Bool_t errors = kFALSE, Bool_t zBins = kFALSE);
400 
401  TGLPlotCoordinates(const TGLPlotCoordinates &);
402  TGLPlotCoordinates &operator = (const TGLPlotCoordinates &);
403 
404  ClassDef(TGLPlotCoordinates, 0)//Auxilary class, holds plot dimensions.
405 };
406 
407 class TGLLevelPalette;
408 
409 namespace Rgl {
410 
411 void DrawPalette(const TGLPlotCamera *camera, const TGLLevelPalette &palette);
412 void DrawPalette(const TGLPlotCamera *camera, const TGLLevelPalette &palette,
413  const std::vector<Double_t> &levels);
414 void DrawPaletteAxis(const TGLPlotCamera *camera, const Range_t &minMax, Bool_t logZ);
415 
416 //Polygonal histogram (TH2Poly) is slightly stretched along x and y.
417 extern const Double_t gH2PolyScaleXY;
418 
419 }
420 
421 #endif