VTK  9.4.20241016
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
34#ifndef vtkChartBox_h
35#define vtkChartBox_h
36
37#include "vtkChart.h"
38#include "vtkChartsCoreModule.h" // For export macro
39#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
40
41VTK_ABI_NAMESPACE_BEGIN
42class vtkIdTypeArray;
43class vtkPlotBox;
44class vtkStdString;
45class vtkStringArray;
46class vtkTooltipItem;
47
48class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkChartBox : public vtkChart
49{
50public:
51 vtkTypeMacro(vtkChartBox, vtkChart);
52 void PrintSelf(ostream& os, vtkIndent indent) override;
53
57 static vtkChartBox* New();
58
64 void Update() override;
65
69 bool Paint(vtkContext2D* painter) override;
70
72
75 void SetColumnVisibility(const vtkStdString& name, bool visible);
76 void SetColumnVisibility(vtkIdType column, bool visible);
78
83 void SetColumnVisibilityAll(bool visible);
84
86
92
97
99
102 vtkGetObjectMacro(VisibleColumns, vtkStringArray);
104
105 // Index of the selected column in the visible columns list.
106 vtkGetMacro(SelectedColumn, int);
107 vtkSetMacro(SelectedColumn, int);
108
112 vtkPlot* GetPlot(vtkIdType index) override;
113
118
122 virtual vtkAxis* GetYAxis();
123
127 virtual float GetXPosition(int index);
128
133
138 virtual void SetPlot(vtkPlotBox* plot);
139
143 bool Hit(const vtkContextMouseEvent& mouse) override;
144
148 bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
149
153 bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
154
159
163 virtual void SetTooltip(vtkTooltipItem* tooltip);
164
169
174 vtkIdType segmentIndex = -1);
175
180 void SetSize(const vtkRectf& rect) override;
181
186 void SetGeometry(int arg1, int arg2) override;
187
192 void SetLayoutStrategy(int strategy) override;
193
194protected:
196 ~vtkChartBox() override;
197
199
202 class Private;
203 Private* Storage;
205
207
212
217
219
225
230
235
239 void SwapAxes(int a1, int a2);
240
246 bool LocatePointInPlots(const vtkContextMouseEvent& mouse, int invokeEvent = -1);
247
248 int LocatePointInPlot(const vtkVector2f& position, const vtkVector2f& tolerance,
249 vtkVector2f& plotPos, vtkPlot* plot, vtkIdType& segmentId);
250
251private:
252 vtkChartBox(const vtkChartBox&) = delete;
253 void operator=(const vtkChartBox&) = delete;
254};
255
257
263{
267 int Index;
268};
270
271VTK_ABI_NAMESPACE_END
272#endif // vtkChartBox_h
takes care of drawing 2D axes
Definition vtkAxis.h:171
Factory class for drawing box plot charts.
Definition vtkChartBox.h:49
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:151
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:108
Class for drawing box plots.
Definition vtkPlotBox.h:50
Abstract class for 2D plots.
Definition vtkPlot.h:154
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:440
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
#define VTK_MARSHALAUTO