VTK  9.3.0
vtkChartBox.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
15#ifndef vtkChartBox_h
16#define vtkChartBox_h
17
18#include "vtkChart.h"
19#include "vtkChartsCoreModule.h" // For export macro
20
21VTK_ABI_NAMESPACE_BEGIN
22class vtkIdTypeArray;
23class vtkPlotBox;
24class vtkStdString;
25class vtkStringArray;
26class vtkTooltipItem;
27
28class VTKCHARTSCORE_EXPORT vtkChartBox : public vtkChart
29{
30public:
31 vtkTypeMacro(vtkChartBox, vtkChart);
32 void PrintSelf(ostream& os, vtkIndent indent) override;
33
37 static vtkChartBox* New();
38
44 void Update() override;
45
49 bool Paint(vtkContext2D* painter) override;
50
52
55 void SetColumnVisibility(const vtkStdString& name, bool visible);
56 void SetColumnVisibility(vtkIdType column, bool visible);
58
63 void SetColumnVisibilityAll(bool visible);
64
66
72
77
79
82 vtkGetObjectMacro(VisibleColumns, vtkStringArray);
84
85 // Index of the selected column in the visible columns list.
86 vtkGetMacro(SelectedColumn, int);
87 vtkSetMacro(SelectedColumn, int);
88
92 vtkPlot* GetPlot(vtkIdType index) override;
93
98
102 virtual vtkAxis* GetYAxis();
103
107 virtual float GetXPosition(int index);
108
113
118 virtual void SetPlot(vtkPlotBox* plot);
119
123 bool Hit(const vtkContextMouseEvent& mouse) override;
124
128 bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
129
133 bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
134
139
143 virtual void SetTooltip(vtkTooltipItem* tooltip);
144
149
154 vtkIdType segmentIndex = -1);
155
160 void SetSize(const vtkRectf& rect) override;
161
166 void SetGeometry(int arg1, int arg2) override;
167
172 void SetLayoutStrategy(int strategy) override;
173
174protected:
176 ~vtkChartBox() override;
177
179
182 class Private;
183 Private* Storage;
185
187
192
197
199
205
210
215
219 void SwapAxes(int a1, int a2);
220
226 bool LocatePointInPlots(const vtkContextMouseEvent& mouse, int invokeEvent = -1);
227
228 int LocatePointInPlot(const vtkVector2f& position, const vtkVector2f& tolerance,
229 vtkVector2f& plotPos, vtkPlot* plot, vtkIdType& segmentId);
230
231private:
232 vtkChartBox(const vtkChartBox&) = delete;
233 void operator=(const vtkChartBox&) = delete;
234};
235
237
243{
247 int Index;
248};
250
251VTK_ABI_NAMESPACE_END
252#endif // vtkChartBox_h
takes care of drawing 2D axes
Definition vtkAxis.h:61
Factory class for drawing box plot charts.
Definition vtkChartBox.h:29
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.
void SetGeometry(int arg1, int arg2) 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.
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.
void SetLayoutStrategy(int strategy) override
Calls superclass implementation and sets GeometryValid to False, causing the chart's geometry to be u...
~vtkChartBox() override
void SetSize(const vtkRectf &rect) override
Calls superclass implementation and sets GeometryValid to False, causing the chart's geometry to be u...
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 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.
Factory class for drawing 2D charts.
Definition vtkChart.h:41
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:29
Class for drawing box plots.
Definition vtkPlotBox.h:30
Abstract class for 2D plots.
Definition vtkPlot.h:44
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:411
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:315