VTK  9.3.0
vtkAxisExtended.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
16 #ifndef vtkAxisExtended_h
17 #define vtkAxisExtended_h
18 #endif
19 
20 #include "vtkChartsCoreModule.h" // For export macro
21 #include "vtkObject.h"
22 #include "vtkVector.h" // Needed for vtkVector
23 
24 VTK_ABI_NAMESPACE_BEGIN
25 class VTKCHARTSCORE_EXPORT vtkAxisExtended : public vtkObject
26 {
27 public:
28  vtkTypeMacro(vtkAxisExtended, vtkObject);
29  static vtkAxisExtended* New();
30  void PrintSelf(ostream& os, vtkIndent indent) override;
31 
36  static double Simplicity(int qIndex, int qLength, int j, double lmin, double lmax, double lstep);
37 
42  static double SimplicityMax(int qIndex, int qLength, int j);
43 
48  static double Coverage(double dmin, double dmax, double lmin, double lmax);
49 
53  static double CoverageMax(double dmin, double dmax, double span);
54 
59  static double Density(int k, double m, double dmin, double dmax, double lmin, double lmax);
60 
65  static double DensityMax(int k, double m);
66 
70  static double FormatLegibilityScore(double n, int format);
71 
75  static int FormatStringLength(int format, double n, int precision);
76 
82  vtkVector3d GenerateExtendedTickLabels(double dmin, double dmax, double m, double scaling);
83 
85 
88  vtkGetMacro(FontSize, int);
89  vtkSetMacro(FontSize, int);
91 
92  vtkGetMacro(DesiredFontSize, int);
93  vtkSetMacro(DesiredFontSize, int);
94 
95  vtkGetMacro(Precision, int);
96  vtkSetMacro(Precision, int);
97  vtkGetMacro(LabelFormat, int);
98  vtkSetMacro(LabelFormat, int);
99 
100  vtkGetMacro(Orientation, int);
101  vtkSetMacro(Orientation, int);
102 
103  vtkGetMacro(IsAxisVertical, bool);
104  vtkSetMacro(IsAxisVertical, bool);
105 
106 protected:
108  ~vtkAxisExtended() override;
109 
113  double Legibility(
114  double lmin, double lmax, double lstep, double scaling, vtkVector<int, 3>& parameters);
115 
117  int FontSize;
123 
124 private:
125  vtkAxisExtended(const vtkAxisExtended&) = delete;
126  void operator=(const vtkAxisExtended&) = delete;
127 };
128 VTK_ABI_NAMESPACE_END
extended axis tick positioning
static double Coverage(double dmin, double dmax, double lmin, double lmax)
This method makes the data range approximately same as the labeling range more preferable.
~vtkAxisExtended() override
static vtkAxisExtended * New()
static double SimplicityMax(int qIndex, int qLength, int j)
This method returns the maximum possible value of simplicity value given q and j.
static double FormatLegibilityScore(double n, int format)
This methods return the legibility score of different formats.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
double Legibility(double lmin, double lmax, double lstep, double scaling, vtkVector< int, 3 > &parameters)
This method implements an exhaustive search of the legibilty parameters.
static double DensityMax(int k, double m)
Derives the maximum values for density given k (number of ticks) and m (user given)
static double Simplicity(int qIndex, int qLength, int j, double lmin, double lmax, double lstep)
This method return a value to make step sizes corresponding to low q and j values more preferable.
static double CoverageMax(double dmin, double dmax, double span)
This gives the maximum possible value of coverage given the step size.
static int FormatStringLength(int format, double n, int precision)
This method returns the string length of different format notations.
static double Density(int k, double m, double dmin, double dmax, double lmin, double lmax)
This method return a value to make the density of the labels close to the user given value.
vtkVector3d GenerateExtendedTickLabels(double dmin, double dmax, double m, double scaling)
This method implements the algorithm given in the paper The method return the minimum tick position,...
a simple class to control print indentation
Definition: vtkIndent.h:29
abstract base class for most VTK objects
Definition: vtkObject.h:52
templated base type for storage of vectors.
Definition: vtkVector.h:30