VTK  9.3.20240419
vtkPlotPoints.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
3 
73 #ifndef vtkPlotPoints_h
74 #define vtkPlotPoints_h
75 
76 #include "vtkChartsCoreModule.h" // For export macro
77 #include "vtkNew.h" // For ivars
78 #include "vtkPlot.h"
79 #include "vtkRenderingCoreEnums.h" // For marker enum
80 #include "vtkScalarsToColors.h" // For VTK_COLOR_MODE_DEFAULT and _MAP_SCALARS
81 #include "vtkStdString.h" // For color array name
82 
83 VTK_ABI_NAMESPACE_BEGIN
84 class vtkCharArray;
85 class vtkContext2D;
86 class vtkTable;
87 class vtkPoints2D;
88 class vtkFloatArray;
89 class vtkImageData;
90 class vtkScalarsToColors;
92 
93 class VTKCHARTSCORE_EXPORT vtkPlotPoints : public vtkPlot
94 {
95 public:
96  vtkTypeMacro(vtkPlotPoints, vtkPlot);
97  void PrintSelf(ostream& os, vtkIndent indent) override;
98 
102  static vtkPlotPoints* New();
103 
107  bool Paint(vtkContext2D* painter) override;
108 
115  bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
116 
120  void GetBounds(double bounds[4]) override;
121 
125  void GetUnscaledInputBounds(double bounds[4]) override;
126 
128 
134 
139  virtual void CreateDefaultLookupTable();
140 
142 
145  vtkSetMacro(ScalarVisibility, vtkTypeBool);
146  vtkGetMacro(ScalarVisibility, vtkTypeBool);
147  vtkBooleanMacro(ScalarVisibility, vtkTypeBool);
149 
151 
156  void SelectColorArray(vtkIdType arrayNum);
157  void SelectColorArray(const vtkStdString& arrayName);
159 
164 
171  vtkVector2f* location, vtkIdType* segmentId) override;
173 
177  bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max) override;
178 
182  bool SelectPointsInPolygon(const vtkContextPolygon& polygon) override;
183 
187  enum
188  {
194  DIAMOND = VTK_MARKER_DIAMOND
195  };
196 
198 
202  vtkGetMacro(MarkerStyle, int);
203  vtkSetMacro(MarkerStyle, int);
205 
207 
211  vtkGetMacro(MarkerSize, float);
212  vtkSetMacro(MarkerSize, float);
214 
216 
219  vtkGetMacro(ValidPointMaskName, vtkStdString);
220  vtkSetMacro(ValidPointMaskName, vtkStdString);
222 
229  bool UpdateCache() override;
230 
231  void ReleaseGraphicsCache() override;
232 
233 protected:
235  ~vtkPlotPoints() override;
236 
240  bool GetDataArrays(vtkTable* table, vtkDataArray* array[2]);
241 
245  bool CacheRequiresUpdate() override;
246 
251 
257 
264 
268  void CalculateBounds(double bounds[4]);
269 
274 
276 
282 
284 
287  class VectorPIMPL;
288  VectorPIMPL* Sorted;
290 
296 
302 
307 
309 
313  float MarkerSize;
315 
316  bool LogX, LogY;
317 
319 
327 
331  double UnscaledInputBounds[4];
332 
333 private:
334  vtkPlotPoints(const vtkPlotPoints&) = delete;
335  void operator=(const vtkPlotPoints&) = delete;
336 };
337 
338 VTK_ABI_NAMESPACE_END
339 #endif // vtkPlotPoints_h
dynamic, self-adjusting array of char
Definition: vtkCharArray.h:60
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:69
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:155
dynamic, self-adjusting array of float
dynamic, self-adjusting array of vtkIdType
topologically and geometrically regular array of data
Definition: vtkImageData.h:156
a simple class to control print indentation
Definition: vtkIndent.h:108
Class for drawing an points given two columns from a vtkTable.
Definition: vtkPlotPoints.h:94
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 ReleaseGraphicsCache() override
Release cache entries created by this context item.
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.
vtkStdString ColorArrayName
Lookup Table for coloring points by scalar value.
bool UpdateCache() override
Update the internal cache.
void GetBounds(double bounds[4]) override
Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
~vtkPlotPoints() override
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...
vtkUnsignedCharArray * Colors
Lookup Table for coloring points by scalar value.
bool CacheRequiresUpdate() override
Test if the internal cache requires an update.
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:153
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:27
Superclass for mapping scalar values to colors.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:78
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:168
dynamic, self-adjusting array of unsigned char
@ point
Definition: vtkX3D.h:236
@ location
Definition: vtkX3D.h:406
int vtkTypeBool
Definition: vtkABI.h:64
@ VTK_MARKER_DIAMOND
@ VTK_MARKER_SQUARE
@ VTK_MARKER_PLUS
@ VTK_MARKER_CROSS
@ VTK_MARKER_CIRCLE
@ VTK_MARKER_NONE
int vtkIdType
Definition: vtkType.h:315
#define max(a, b)