VTK  9.2.6
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
33#ifndef vtkPlotPoints_h
34#define vtkPlotPoints_h
35
36#include "vtkChartsCoreModule.h" // For export macro
37#include "vtkNew.h" // For ivars
38#include "vtkPlot.h"
39#include "vtkRenderingCoreEnums.h" // For marker enum
40#include "vtkScalarsToColors.h" // For VTK_COLOR_MODE_DEFAULT and _MAP_SCALARS
41#include "vtkStdString.h" // For color array name
42
43class vtkCharArray;
44class vtkContext2D;
45class vtkTable;
46class vtkPoints2D;
47class vtkFloatArray;
48class vtkStdString;
49class vtkImageData;
52
53class VTKCHARTSCORE_EXPORT vtkPlotPoints : public vtkPlot
54{
55public:
56 vtkTypeMacro(vtkPlotPoints, vtkPlot);
57 void PrintSelf(ostream& os, vtkIndent indent) override;
58
62 static vtkPlotPoints* New();
63
67 bool Paint(vtkContext2D* painter) override;
68
75 bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
76
80 void GetBounds(double bounds[4]) override;
81
85 void GetUnscaledInputBounds(double bounds[4]) override;
86
88
94
100
102
105 vtkSetMacro(ScalarVisibility, vtkTypeBool);
106 vtkGetMacro(ScalarVisibility, vtkTypeBool);
107 vtkBooleanMacro(ScalarVisibility, vtkTypeBool);
109
111
117 void SelectColorArray(const vtkStdString& arrayName);
119
124
130 vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
131 vtkVector2f* location, vtkIdType* segmentId) override;
133
137 bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max) override;
138
142 bool SelectPointsInPolygon(const vtkContextPolygon& polygon) override;
143
147 enum
148 {
154 DIAMOND = VTK_MARKER_DIAMOND
155 };
156
158
162 vtkGetMacro(MarkerStyle, int);
163 vtkSetMacro(MarkerStyle, int);
165
167
171 vtkGetMacro(MarkerSize, float);
172 vtkSetMacro(MarkerSize, float);
174
176
179 vtkGetMacro(ValidPointMaskName, vtkStdString);
180 vtkSetMacro(ValidPointMaskName, vtkStdString);
182
189 bool UpdateCache() override;
190
191protected:
193 ~vtkPlotPoints() override;
194
198 bool GetDataArrays(vtkTable* table, vtkDataArray* array[2]);
199
203 virtual bool CacheRequiresUpdate() override;
204
209
215
222
226 void CalculateBounds(double bounds[4]);
227
232
234
240
242
245 class VectorPIMPL;
246 VectorPIMPL* Sorted;
248
254
260
265
267
273
274 bool LogX, LogY;
275
277
285
289 double UnscaledInputBounds[4];
290
291private:
292 vtkPlotPoints(const vtkPlotPoints&) = delete;
293 void operator=(const vtkPlotPoints&) = delete;
294};
295
296#endif // vtkPlotPoints_h
dynamic, self-adjusting array of char
Class for drawing 2D primitives to a graphical context.
abstract superclass for arrays of numeric data
dynamic, self-adjusting array of float
dynamic, self-adjusting array of vtkIdType
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:40
Allocate and hold a VTK object.
Definition vtkNew.h:62
Class for drawing an points given two columns from a vtkTable.
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.
virtual bool CacheRequiresUpdate() override
Test if the internal cache requires an update.
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.
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.
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.
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.
vtkCharArray * ValidPointMask
Array which marks valid points in the array.
static vtkPlotPoints * New()
Creates a 2D Chart object.
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.
vtkScalarsToColors * GetLookupTable()
Specify a lookup table for the mapper to use.
Abstract class for 2D plots.
Definition vtkPlot.h:54
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:37
Superclass for mapping scalar values to colors.
Wrapper around std::string to keep symbols short.
A table, which contains similar-typed columns of data.
Definition vtkTable.h:74
dynamic, self-adjusting array of unsigned char
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)