VTK  9.0.2
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 
24 #ifndef vtkChartBox_h
25 #define vtkChartBox_h
26 
27 #include "vtkChart.h"
28 #include "vtkChartsCoreModule.h" // For export macro
29 
30 class vtkIdTypeArray;
31 class vtkPlotBox;
32 class vtkStdString;
33 class vtkStringArray;
34 class vtkTooltipItem;
35 
36 class VTKCHARTSCORE_EXPORT vtkChartBox : public vtkChart
37 {
38 public:
39  vtkTypeMacro(vtkChartBox, vtkChart);
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
45  static vtkChartBox* New();
46 
52  void Update() override;
53 
57  bool Paint(vtkContext2D* painter) override;
58 
60 
63  void SetColumnVisibility(const vtkStdString& name, bool visible);
64  void SetColumnVisibility(vtkIdType column, bool visible);
66 
71  void SetColumnVisibilityAll(bool visible);
72 
74 
80 
85 
87 
90  vtkGetObjectMacro(VisibleColumns, vtkStringArray);
92 
93  // Index of the selected column in the visible columns list.
94  vtkGetMacro(SelectedColumn, int);
95  vtkSetMacro(SelectedColumn, int);
96 
101 
106 
110  virtual vtkAxis* GetYAxis();
111 
115  virtual float GetXPosition(int index);
116 
121 
126  virtual void SetPlot(vtkPlotBox* plot);
127 
131  bool Hit(const vtkContextMouseEvent& mouse) override;
132 
136  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
137 
141  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
142 
146  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;
147 
151  virtual void SetTooltip(vtkTooltipItem* tooltip);
152 
157 
162  vtkIdType segmentIndex = -1);
163 
164 protected:
166  ~vtkChartBox() override;
167 
169 
172  class Private;
173  Private* Storage;
175 
177 
182 
187 
189 
195 
200 
205 
209  void SwapAxes(int a1, int a2);
210 
216  bool LocatePointInPlots(const vtkContextMouseEvent& mouse, int invokeEvent = -1);
217 
218  int LocatePointInPlot(const vtkVector2f& position, const vtkVector2f& tolerance,
219  vtkVector2f& plotPos, vtkPlot* plot, vtkIdType& segmentIndex);
220 
221 private:
222  vtkChartBox(const vtkChartBox&) = delete;
223  void operator=(const vtkChartBox&) = delete;
224 };
225 
227 
233 {
237  int Index;
238 };
240 
241 #endif // vtkChartBox_h
takes care of drawing 2D axes
Definition: vtkAxis.h:69
Factory class for drawing box plot charts.
Definition: vtkChartBox.h:37
void CalculatePlotTransform()
float SelectedColumnDelta
Definition: vtkChartBox.h:193
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.
Definition: vtkChartBox.h:204
int SelectedColumn
Index of the selected column in the visible columns list.
Definition: vtkChartBox.h:192
virtual void SetTooltip(vtkTooltipItem *tooltip)
Set the vtkTooltipItem object that will be displayed by the chart.
virtual vtkTooltipItem * GetTooltip()
Get the vtkTooltipItem object that will be displayed by the chart.
vtkStringArray * VisibleColumns
A list of the visible columns in the chart.
Definition: vtkChartBox.h:186
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.
Definition: vtkChartBox.h:199
bool GetColumnVisibility(vtkIdType column)
Private * Storage
Definition: vtkChartBox.h:172
bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse) override
Mouse button release event.
int LocatePointInPlot(const vtkVector2f &position, const vtkVector2f &tolerance, vtkVector2f &plotPos, vtkPlot *plot, vtkIdType &segmentIndex)
bool GeometryValid
Definition: vtkChartBox.h:176
static vtkChartBox * New()
Creates a box chart.
vtkIdTypeArray * Selection
Selected indices for the table the plot is rendering.
Definition: vtkChartBox.h:181
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...
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 vtkAxis * GetYAxis()
Get the chart Y axis.
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.
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)
vtkPlot * GetPlot(vtkIdType index) override
Get the plot at the specified index, returns null if the index is invalid.
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:45
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:53
data structure to represent mouse events.
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition: vtkIndent.h:34
Class for drawing box plots.
Definition: vtkPlotBox.h:39
Abstract class for 2D plots.
Definition: vtkPlot.h:47
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:35
a vtkAbstractArray subclass for strings
record modification and/or execution time
Definition: vtkTimeStamp.h:33
takes care of drawing 2D axes
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:420
@ name
Definition: vtkX3D.h:225
@ position
Definition: vtkX3D.h:267
@ index
Definition: vtkX3D.h:252
Small struct used by InvokeEvent to send some information about the point that was clicked on.
Definition: vtkChartBox.h:233
vtkVector2i ScreenPosition
Definition: vtkChartBox.h:236
vtkStdString SeriesName
Definition: vtkChartBox.h:234
vtkVector2f Position
Definition: vtkChartBox.h:235
int vtkIdType
Definition: vtkType.h:338