VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
vtkAxis.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAxis.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
53 #ifndef __vtkAxis_h
54 #define __vtkAxis_h
55 
56 #include "vtkChartsCoreModule.h" // For export macro
57 #include "vtkContextItem.h"
58 #include "vtkSmartPointer.h" // For vtkSmartPointer
59 #include "vtkVector.h" // For position variables
60 #include "vtkRect.h" // For bounding rect
61 #include "vtkStdString.h" // For vtkStdString ivars
62 
63 class vtkContext2D;
64 class vtkPen;
65 class vtkFloatArray;
66 class vtkDoubleArray;
67 class vtkStringArray;
68 class vtkTextProperty;
69 
70 class VTKCHARTSCORE_EXPORT vtkAxis : public vtkContextItem
71 {
72 public:
73  vtkTypeMacro(vtkAxis, vtkContextItem);
74  virtual void PrintSelf(ostream &os, vtkIndent indent);
75 
77 
79  enum {
80  LEFT = 0,
83  TOP,
84  PARALLEL
85  };
87 
88  enum {
89  TICK_SIMPLE = 0,
90  TICK_WILKINSON_EXTENDED
91  };
92 
94  static vtkAxis *New();
95 
97 
99  virtual void SetPosition(int position);
100  vtkGetMacro(Position, int);
102 
104 
105  void SetPoint1(const vtkVector2f& pos);
106  void SetPoint1(float x, float y);
108 
110 
111  vtkGetVector2Macro(Point1, float);
112  vtkVector2f GetPosition1();
114 
116 
117  void SetPoint2(const vtkVector2f& pos);
118  void SetPoint2(float x, float y);
120 
122 
123  vtkGetVector2Macro(Point2, float);
124  vtkVector2f GetPosition2();
126 
129  virtual void SetNumberOfTicks(int numberOfTicks);
130 
132 
133  vtkGetMacro(NumberOfTicks, int);
135 
137 
139  vtkGetObjectMacro(LabelProperties, vtkTextProperty);
141 
145  virtual void SetMinimum(double minimum);
146 
148 
151  vtkGetMacro(Minimum, double);
153 
157  virtual void SetMaximum(double maximum);
158 
160 
163  vtkGetMacro(Maximum, double);
165 
170  virtual void SetUnscaledMinimum(double minimum);
171 
173 
174  vtkGetMacro(UnscaledMinimum, double);
176 
178  virtual void SetUnscaledMaximum(double maximum);
179 
181 
182  vtkGetMacro(UnscaledMaximum, double);
184 
186 
192  virtual void SetRange(double minimum, double maximum);
193  virtual void SetRange(double range[2]);
194  virtual void SetUnscaledRange(double minimum, double maximum);
195  virtual void SetUnscaledRange(double range[2]);
197 
199 
203  virtual void GetRange(double *range);
204  virtual void GetUnscaledRange(double *range);
206 
209  virtual void SetMinimumLimit(double lowest);
210 
212 
214  vtkGetMacro(MinimumLimit, double);
216 
219  virtual void SetMaximumLimit(double highest);
220 
222 
224  vtkGetMacro(MaximumLimit, double);
226 
229  virtual void SetUnscaledMinimumLimit(double lowest);
230 
232 
234  vtkGetMacro(UnscaledMinimumLimit, double);
236 
239  virtual void SetUnscaledMaximumLimit(double highest);
240 
242 
244  vtkGetMacro(UnscaledMaximumLimit, double);
246 
248 
249  vtkGetVector2Macro(Margins, int);
251 
253 
254  vtkSetVector2Macro(Margins, int);
256 
258 
259  virtual void SetTitle(const vtkStdString &title);
260  virtual vtkStdString GetTitle();
262 
264 
265  vtkGetObjectMacro(TitleProperties, vtkTextProperty);
267 
269 
277  vtkGetMacro(LogScaleActive, bool);
279 
281 
283  vtkGetMacro(LogScale, bool);
284  virtual void SetLogScale(bool logScale);
285  vtkBooleanMacro(LogScale,bool);
287 
289 
290  vtkSetMacro(GridVisible, bool);
291  vtkGetMacro(GridVisible, bool);
293 
295 
296  vtkSetMacro(LabelsVisible, bool);
297  vtkGetMacro(LabelsVisible, bool);
299 
301 
302  vtkSetMacro(TicksVisible, bool);
303  vtkGetMacro(TicksVisible, bool);
305 
307 
308  virtual void SetPrecision(int precision);
309  vtkGetMacro(Precision, int);
311 
313 
314  enum {
315  STANDARD_NOTATION = 0,
319 
320 #ifndef VTK_LEGACY_REMOVE
321  // deprecated, use the *_NOTATION versions above
322  STANDARD = STANDARD_NOTATION,
323  SCIENTIFIC = SCIENTIFIC_NOTATION,
324  MIXED = FIXED_NOTATION
325 #endif
326  };
327 
329 
331  virtual void SetNotation(int notation);
332  vtkGetMacro(Notation, int);
334 
336 
337  enum {
338  AUTO = 0, // Automatically scale the axis to view all data that is visible.
339  FIXED, // Use a fixed axis range and make no attempt to rescale.
340  CUSTOM // Deprecated, use the tick label settings instead.
341  };
343 
345 
347  vtkSetMacro(Behavior, int);
348  vtkGetMacro(Behavior, int);
350 
352 
354  vtkGetObjectMacro(Pen, vtkPen);
356 
358 
360  vtkGetObjectMacro(GridPen, vtkPen);
362 
364 
370  vtkSetMacro(TickLabelAlgorithm, int)
371  vtkGetMacro(TickLabelAlgorithm, int)
373 
376  virtual void Update();
377 
379  virtual bool Paint(vtkContext2D *painter);
380 
385  virtual void AutoScale();
386 
389  virtual void RecalculateTickSpacing();
390 
393  virtual vtkDoubleArray* GetTickPositions();
394 
397  virtual vtkFloatArray* GetTickScenePositions();
398 
400  virtual vtkStringArray* GetTickLabels();
401 
403 
409  virtual bool SetCustomTickPositions(vtkDoubleArray* positions,
410  vtkStringArray* labels = 0);
412 
415  VTK_LEGACY(virtual void SetTickPositions(vtkDoubleArray* positions));
416 
419  VTK_LEGACY(virtual void SetTickLabels(vtkStringArray* labels));
420 
426  vtkRectf GetBoundingRect(vtkContext2D* painter);
427 
431  static double NiceNumber(double number, bool roundUp);
432 
434 
436  static double NiceMinMax(double &min, double &max, float pixelRange,
437  float tickPixelSpacing);
439 
440 //BTX
441 protected:
442  vtkAxis();
443  ~vtkAxis();
444 
450  void UpdateLogScaleActive(bool updateMinMaxFromUnscaled);
451 
453  void GenerateTickLabels(double min, double max);
454 
457  void GenerateTickLabels();
458 
459  void GenerateLabelFormat(int notation, double n);
460 
463  double CalculateNiceMinMax(double &min, double &max);
464 
466 
472  double LogScaleTickMark(double number,
473  bool roundUp,
474  bool &niceValue,
475  int &order);
477 
486  void GenerateLogSpacedLinearTicks(int order, double min, double max);
487 
489 
496  void GenerateLogScaleTickMarks(int order,
497  double min = 1.0,
498  double max = 9.0,
499  bool detailLabels = true);
501 
502  int Position; // The position of the axis (LEFT, BOTTOM, RIGHT, TOP)
503  float *Point1; // The position of point 1 (usually the origin)
504  float *Point2; // The position of point 2 (usually the terminus)
505  vtkVector2f Position1, Position2;
506  double TickInterval; // Interval between tick marks in plot space
507  int NumberOfTicks; // The number of tick marks to draw
508  vtkTextProperty* LabelProperties; // Text properties for the labels.
509  double Minimum; // Minimum value of the axis
510  double Maximum; // Maximum values of the axis
511  double MinimumLimit; // Lowest possible value for Minimum
512  double MaximumLimit; // Highest possible value for Maximum
513  double UnscaledMinimum; // UnscaledMinimum value of the axis
514  double UnscaledMaximum; // UnscaledMaximum values of the axis
515  double UnscaledMinimumLimit; // Lowest possible value for UnscaledMinimum
516  double UnscaledMaximumLimit; // Highest possible value for UnscaledMaximum
517  double NonLogUnscaledMinLimit; // Saved UnscaledMinimumLimit (when !LogActive)
518  double NonLogUnscaledMaxLimit; // Saved UnscaledMinimumLimit (when !LogActive)
519  int Margins[2]; // Horizontal/vertical margins for the axis
520  vtkStdString Title; // The text label drawn on the axis
521  vtkTextProperty* TitleProperties; // Text properties for the axis title
522  bool LogScale; // *Should* the axis use a log scale?
523  bool LogScaleActive; // *Is* the axis using a log scale?
524  bool GridVisible; // Whether the grid for the axis should be drawn
525  bool LabelsVisible; // Should the axis labels be visible
526  bool TicksVisible; // Should the tick marks be visible.
527  int Precision; // Numerical precision to use, defaults to 2.
528  int Notation; // The notation to use (standard, scientific, mixed)
529  int Behavior; // The behaviour of the axis (auto, fixed, custom).
530  float MaxLabel[2]; // The widest/tallest axis label.
531  bool TitleAppended; // Track if the title is updated when the label formats
532  // are changed in the Extended Axis Labeling algorithm
533 
535  bool CustomTickLabels;
536 
538  vtkPen* Pen;
539 
542  vtkPen* GridPen;
543 
546 
548  vtkSmartPointer<vtkFloatArray> TickScenePositions;
549 
552 
555  bool UsingNiceMinMax;
556 
558  bool TickMarksDirty;
559 
561  bool Resized;
562 
564  int TickLabelAlgorithm;
565 
567  vtkTimeStamp BuildTime;
568 
569 private:
570  vtkAxis(const vtkAxis &); // Not implemented.
571  void operator=(const vtkAxis &); // Not implemented.
572 
574 
575  bool InRange(double value);
576 //ETX
577 };
579 
580 #endif //__vtkAxis_h
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:46
record modification and/or execution time
Definition: vtkTimeStamp.h:34
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:43
a vtkAbstractArray subclass for strings
Hold a reference to a vtkObjectBase instance.
dynamic, self-adjusting array of double
takes care of drawing 2D axes
Definition: vtkAxis.h:70
a simple class to control print indentation
Definition: vtkIndent.h:38