VTK  9.1.0
vtkPlotPoints.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPlotPoints.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 
30 #ifndef vtkPlotPoints_h
31 #define vtkPlotPoints_h
32 
33 #include "vtkChartsCoreModule.h" // For export macro
34 #include "vtkNew.h" // For ivars
35 #include "vtkPlot.h"
36 #include "vtkRenderingCoreEnums.h" // For marker enum
37 #include "vtkScalarsToColors.h" // For VTK_COLOR_MODE_DEFAULT and _MAP_SCALARS
38 #include "vtkStdString.h" // For color array name
39 
40 class vtkCharArray;
41 class vtkContext2D;
42 class vtkTable;
43 class vtkPoints2D;
44 class vtkFloatArray;
45 class vtkStdString;
46 class vtkImageData;
47 class vtkScalarsToColors;
49 
50 class VTKCHARTSCORE_EXPORT vtkPlotPoints : public vtkPlot
51 {
52 public:
53  vtkTypeMacro(vtkPlotPoints, vtkPlot);
54  void PrintSelf(ostream& os, vtkIndent indent) override;
55 
59  static vtkPlotPoints* New();
60 
66  void Update() override;
67 
71  bool Paint(vtkContext2D* painter) override;
72 
79  bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
80 
84  void GetBounds(double bounds[4]) override;
85 
89  void GetUnscaledInputBounds(double bounds[4]) override;
90 
92 
98 
103  virtual void CreateDefaultLookupTable();
104 
106 
109  vtkSetMacro(ScalarVisibility, vtkTypeBool);
110  vtkGetMacro(ScalarVisibility, vtkTypeBool);
111  vtkBooleanMacro(ScalarVisibility, vtkTypeBool);
113 
115 
120  void SelectColorArray(vtkIdType arrayNum);
121  void SelectColorArray(const vtkStdString& arrayName);
123 
128 
135  vtkVector2f* location, vtkIdType* segmentId) override;
137 
141  bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max) override;
142 
146  bool SelectPointsInPolygon(const vtkContextPolygon& polygon) override;
147 
151  enum
152  {
158  DIAMOND = VTK_MARKER_DIAMOND
159  };
160 
162 
166  vtkGetMacro(MarkerStyle, int);
167  vtkSetMacro(MarkerStyle, int);
169 
171 
175  vtkGetMacro(MarkerSize, float);
176  vtkSetMacro(MarkerSize, float);
178 
180 
183  vtkGetMacro(ValidPointMaskName, vtkStdString);
184  vtkSetMacro(ValidPointMaskName, vtkStdString);
186 
187 protected:
189  ~vtkPlotPoints() override;
190 
194  bool GetDataArrays(vtkTable* table, vtkDataArray* array[2]);
195 
200 
205 
211 
218 
222  void CalculateBounds(double bounds[4]);
223 
228 
230 
236 
238 
241  class VectorPIMPL;
242  VectorPIMPL* Sorted;
244 
250 
256 
261 
266 
268 
272  float MarkerSize;
274 
275  bool LogX, LogY;
276 
278 
286 
290  double UnscaledInputBounds[4];
291 
292 private:
293  vtkPlotPoints(const vtkPlotPoints&) = delete;
294  void operator=(const vtkPlotPoints&) = delete;
295 };
296 
297 #endif // vtkPlotPoints_h
dynamic, self-adjusting array of char
Definition: vtkCharArray.h:49
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:54
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:36
dynamic, self-adjusting array of vtkIdType
topologically and geometrically regular array of data
Definition: vtkImageData.h:48
a simple class to control print indentation
Definition: vtkIndent.h:34
Class for drawing an points given two columns from a vtkTable.
Definition: vtkPlotPoints.h:51
void CalculateLogSeries()
Handle calculating the log of the x or y series if necessary.
int MarkerStyle
The marker style that should be used.
virtual void CreateDefaultLookupTable()
Create default lookup table.
void GetUnscaledInputBounds(double bounds[4]) override
Get the non-log-scaled bounds on chart inputs for this plot as (Xmin, Xmax, Ymin, Ymax).
void SelectColorArray(const vtkStdString &arrayName)
When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use f...
void CalculateUnscaledInputBounds()
Calculate the unscaled input bounds from the input arrays.
float MarkerSize
The marker style that should be used.
void FindBadPoints()
Find all of the "bad points" in the series.
bool GetDataArrays(vtkTable *table, vtkDataArray *array[2])
Populate the data arrays ready to operate on input data.
bool PaintLegend(vtkContext2D *painter, const vtkRectf &rect, int legendIndex) override
Paint legend event for the XY plot, called whenever the legend needs the plot items symbol/mark/line ...
vtkTypeBool ScalarVisibility
Lookup Table for coloring points by scalar value.
bool UpdateTableCache(vtkTable *table)
Update the table cache.
vtkStdString ColorArrayName
Lookup Table for coloring points by scalar value.
void GetBounds(double bounds[4]) override
Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
~vtkPlotPoints() override
void Update() override
Perform any updates to the item that may be necessary before rendering.
void SetLookupTable(vtkScalarsToColors *lut)
Specify a lookup table for the mapper to use.
vtkIdTypeArray * BadPoints
An array containing the indices of all the "bad points", meaning any x, y pair that has an infinity,...
bool SelectPoints(const vtkVector2f &min, const vtkVector2f &max) override
Select all points in the specified rectangle.
void SelectColorArray(vtkIdType arrayNum)
When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use f...
vtkTimeStamp BuildTime
The point cache is marked dirty until it has been initialized.
vtkUnsignedCharArray * Colors
Lookup Table for coloring points by scalar value.
vtkPoints2D * Points
Store a well packed set of XY coordinates for this data series.
VectorPIMPL * Sorted
vtkStdString ValidPointMaskName
Name of the valid point mask array.
vtkScalarsToColors * GetLookupTable()
Specify a lookup table for the mapper to use.
bool Paint(vtkContext2D *painter) override
Paint event for the XY plot, called whenever the chart needs to be drawn.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void CalculateBounds(double bounds[4])
Calculate the bounds of the plot, ignoring the bad points.
bool SelectPointsInPolygon(const vtkContextPolygon &polygon) override
Select all points in the specified polygon.
vtkNew< vtkFloatArray > SelectedPoints
Store a well packed set of XY coordinates for this data series.
void CreateSortedPoints()
Create the sorted point list if necessary.
static vtkPlotPoints * New()
Creates a 2D Chart object.
vtkCharArray * ValidPointMask
Array which marks valid points in the array.
vtkStdString GetColorArrayName()
Get the array name to color by.
vtkIdType GetNearestPoint(const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId) override
Function to query a plot for the nearest point to the specified coordinate.
vtkScalarsToColors * LookupTable
Lookup Table for coloring points by scalar value.
Abstract class for 2D plots.
Definition: vtkPlot.h:48
virtual vtkIdType GetNearestPoint(const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId)
Function to query a plot for the nearest point to the specified coordinate.
represent and manipulate 2D points
Definition: vtkPoints2D.h:34
Superclass for mapping scalar values to colors.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:36
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:63
record modification and/or execution time
Definition: vtkTimeStamp.h:33
dynamic, self-adjusting array of unsigned char
@ point
Definition: vtkX3D.h:242
@ location
Definition: vtkX3D.h:412
int vtkTypeBool
Definition: vtkABI.h:69
@ VTK_MARKER_DIAMOND
@ VTK_MARKER_SQUARE
@ VTK_MARKER_PLUS
@ VTK_MARKER_CROSS
@ VTK_MARKER_CIRCLE
@ VTK_MARKER_NONE
int vtkIdType
Definition: vtkType.h:332
#define max(a, b)