VTK  9.2.6
vtkChartBox.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkChartBox.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
26
27#ifndef vtkChartBox_h
28#define vtkChartBox_h
29
30#include "vtkChart.h"
31#include "vtkChartsCoreModule.h" // For export macro
32
33class vtkIdTypeArray;
34class vtkPlotBox;
35class vtkStdString;
36class vtkStringArray;
37class vtkTooltipItem;
38
39class VTKCHARTSCORE_EXPORT vtkChartBox : public vtkChart
40{
41public:
42 vtkTypeMacro(vtkChartBox, vtkChart);
43 void PrintSelf(ostream& os, vtkIndent indent) override;
44
48 static vtkChartBox* New();
49
55 void Update() override;
56
60 bool Paint(vtkContext2D* painter) override;
61
63
66 void SetColumnVisibility(const vtkStdString& name, bool visible);
67 void SetColumnVisibility(vtkIdType column, bool visible);
69
74 void SetColumnVisibilityAll(bool visible);
75
77
83
88
90
93 vtkGetObjectMacro(VisibleColumns, vtkStringArray);
95
96 // Index of the selected column in the visible columns list.
97 vtkGetMacro(SelectedColumn, int);
98 vtkSetMacro(SelectedColumn, int);
99
103 vtkPlot* GetPlot(vtkIdType index) override;
104
109
113 virtual vtkAxis* GetYAxis();
114
118 virtual float GetXPosition(int index);
119
124
129 virtual void SetPlot(vtkPlotBox* plot);
130
134 bool Hit(const vtkContextMouseEvent& mouse) override;
135
139 bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
140
144 bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
145
150
154 virtual void SetTooltip(vtkTooltipItem* tooltip);
155
160
165 vtkIdType segmentIndex = -1);
166
171 virtual void SetSize(const vtkRectf& rect) override;
172
177 virtual void SetGeometry(int arg1, int arg2) override;
178
183 virtual void SetLayoutStrategy(int strategy) override;
184
185protected:
187 ~vtkChartBox() override;
188
190
193 class Private;
194 Private* Storage;
196
198
203
208
210
216
221
226
230 void SwapAxes(int a1, int a2);
231
237 bool LocatePointInPlots(const vtkContextMouseEvent& mouse, int invokeEvent = -1);
238
239 int LocatePointInPlot(const vtkVector2f& position, const vtkVector2f& tolerance,
240 vtkVector2f& plotPos, vtkPlot* plot, vtkIdType& segmentId);
241
242private:
243 vtkChartBox(const vtkChartBox&) = delete;
244 void operator=(const vtkChartBox&) = delete;
245};
246
248
260
261
262#endif // vtkChartBox_h
takes care of drawing 2D axes
Definition vtkAxis.h:72
void CalculatePlotTransform()
float SelectedColumnDelta
Index of the selected column in the visible columns list.
void SwapAxes(int a1, int a2)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse) override
Mouse button down event.
void ResetSelection()
vtkSmartPointer< vtkTooltipItem > Tooltip
The tooltip item for the chart - can be used to display extra information.
virtual void SetLayoutStrategy(int strategy) override
Calls superclass implementation and sets GeometryValid to False, causing the chart's geometry to be u...
int SelectedColumn
Index of the selected column in the visible columns list.
virtual void SetTooltip(vtkTooltipItem *tooltip)
Set the vtkTooltipItem object that will be displayed by the chart.
static vtkChartBox * New()
Creates a box chart.
vtkStringArray * VisibleColumns
A list of the visible columns in the chart.
virtual void SetGeometry(int arg1, int arg2) override
Calls superclass implementation and sets GeometryValid to False, causing the chart's geometry to be u...
bool GetColumnVisibility(const vtkStdString &name)
Get the visibility of the specified column.
vtkTimeStamp BuildTime
The point cache is marked dirty until it has been initialized.
bool GetColumnVisibility(vtkIdType column)
Get the visibility of the specified column.
Private * Storage
bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse) override
Mouse button release event.
bool GeometryValid
vtkIdTypeArray * Selection
Selected indices for the table the plot is rendering.
bool MouseMoveEvent(const vtkContextMouseEvent &mouse) override
Mouse move event.
~vtkChartBox() override
void UpdateGeometry(vtkContext2D *)
void SetColumnVisibilityAll(bool visible)
Set the visibility of all columns (true will make them all visible, false will remove all visible col...
int LocatePointInPlot(const vtkVector2f &position, const vtkVector2f &tolerance, vtkVector2f &plotPos, vtkPlot *plot, vtkIdType &segmentId)
vtkIdType GetNumberOfPlots() override
Get the number of plots the chart contains.
virtual void SetTooltipInfo(const vtkContextMouseEvent &, const vtkVector2d &, vtkIdType, vtkPlot *, vtkIdType segmentIndex=-1)
Set the information passed to the tooltip.
bool Paint(vtkContext2D *painter) override
Paint event for the chart, called whenever the chart needs to be drawn.
virtual float GetXPosition(int index)
Get the column X position by index in the visible set.
bool LocatePointInPlots(const vtkContextMouseEvent &mouse, int invokeEvent=-1)
Try to locate a point within the plots to display in a tooltip.
vtkPlot * GetPlot(vtkIdType index) override
Get the plot at the specified index, returns null if the index is invalid.
virtual void SetSize(const vtkRectf &rect) override
Calls superclass implementation and sets GeometryValid to False, causing the chart's geometry to be u...
virtual vtkTooltipItem * GetTooltip()
Get the vtkTooltipItem object that will be displayed by the chart.
virtual vtkAxis * GetYAxis()
Get the chart Y axis.
vtkIdType GetColumnId(const vtkStdString &name)
Get the input table column id of a column by its name.
virtual vtkIdType GetNumberOfVisibleColumns()
Get the number of visible box plots in the current chart.
void SetColumnVisibility(const vtkStdString &name, bool visible)
Set the visibility of the specified column.
virtual void SetPlot(vtkPlotBox *plot)
Set plot to use for the chart.
void Update() override
Perform any updates to the item that may be necessary before rendering.
void SetColumnVisibility(vtkIdType column, bool visible)
Set the visibility of the specified column.
bool Hit(const vtkContextMouseEvent &mouse) override
Return true if the supplied x, y coordinate is inside the item.
Class for drawing 2D primitives to a graphical context.
data structure to represent mouse events.
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition vtkIndent.h:40
Class for drawing box plots.
Definition vtkPlotBox.h:42
Abstract class for 2D plots.
Definition vtkPlot.h:54
Hold a reference to a vtkObjectBase instance.
Wrapper around std::string to keep symbols short.
a vtkAbstractArray subclass for strings
record modification and/or execution time
takes care of drawing 2D axes
Some derived classes for the different vectors commonly used.
Definition vtkVector.h:422
Small struct used by InvokeEvent to send some information about the point that was clicked on.
vtkVector2i ScreenPosition
vtkStdString SeriesName
vtkVector2f Position
int vtkIdType
Definition vtkType.h:332