VTK  9.2.5
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 
46 #ifndef vtkChartBox_h
47 #define vtkChartBox_h
48 
49 #include "vtkChart.h"
50 #include "vtkChartsCoreModule.h" // For export macro
51 
52 class vtkIdTypeArray;
53 class vtkPlotBox;
54 class vtkStdString;
55 class vtkStringArray;
56 class vtkTooltipItem;
57 
58 class VTKCHARTSCORE_EXPORT vtkChartBox : public vtkChart
59 {
60 public:
61  vtkTypeMacro(vtkChartBox, vtkChart);
62  void PrintSelf(ostream& os, vtkIndent indent) override;
63 
67  static vtkChartBox* New();
68 
74  void Update() override;
75 
79  bool Paint(vtkContext2D* painter) override;
80 
82 
85  void SetColumnVisibility(const vtkStdString& name, bool visible);
86  void SetColumnVisibility(vtkIdType column, bool visible);
88 
93  void SetColumnVisibilityAll(bool visible);
94 
96 
102 
107 
109 
112  vtkGetObjectMacro(VisibleColumns, vtkStringArray);
114 
115  // Index of the selected column in the visible columns list.
116  vtkGetMacro(SelectedColumn, int);
117  vtkSetMacro(SelectedColumn, int);
118 
123 
128 
132  virtual vtkAxis* GetYAxis();
133 
137  virtual float GetXPosition(int index);
138 
143 
148  virtual void SetPlot(vtkPlotBox* plot);
149 
153  bool Hit(const vtkContextMouseEvent& mouse) override;
154 
158  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
159 
163  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
164 
168  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;
169 
173  virtual void SetTooltip(vtkTooltipItem* tooltip);
174 
179 
184  vtkIdType segmentIndex = -1);
185 
190  virtual void SetSize(const vtkRectf& rect) override;
191 
196  virtual void SetGeometry(int arg1, int arg2) override;
197 
202  virtual void SetLayoutStrategy(int strategy) override;
203 
204 protected:
206  ~vtkChartBox() override;
207 
209 
212  class Private;
213  Private* Storage;
215 
217 
222 
227 
229 
235 
240 
245 
249  void SwapAxes(int a1, int a2);
250 
256  bool LocatePointInPlots(const vtkContextMouseEvent& mouse, int invokeEvent = -1);
257 
258  int LocatePointInPlot(const vtkVector2f& position, const vtkVector2f& tolerance,
259  vtkVector2f& plotPos, vtkPlot* plot, vtkIdType& segmentId);
260 
261 private:
262  vtkChartBox(const vtkChartBox&) = delete;
263  void operator=(const vtkChartBox&) = delete;
264 };
265 
267 
273 {
277  int Index;
278 };
280 
281 #endif // vtkChartBox_h
takes care of drawing 2D axes
Definition: vtkAxis.h:181
Factory class for drawing box plot charts.
Definition: vtkChartBox.h:59
void CalculatePlotTransform()
float SelectedColumnDelta
Index of the selected column in the visible columns list.
Definition: vtkChartBox.h:233
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:244
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.
Definition: vtkChartBox.h:232
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:226
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.
Definition: vtkChartBox.h:239
bool GetColumnVisibility(vtkIdType column)
Get the visibility of the specified column.
Private * Storage
Definition: vtkChartBox.h:212
bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse) override
Mouse button release event.
bool GeometryValid
Definition: vtkChartBox.h:216
static vtkChartBox * New()
Creates a box chart.
vtkIdTypeArray * Selection
Selected indices for the table the plot is rendering.
Definition: vtkChartBox.h:221
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 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.
virtual void SetSize(const vtkRectf &rect) override
Calls superclass implementation and sets GeometryValid to False, causing the chart's geometry to be u...
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.
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:52
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:77
data structure to represent mouse events.
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition: vtkIndent.h:119
Class for drawing box plots.
Definition: vtkPlotBox.h:61
Abstract class for 2D plots.
Definition: vtkPlot.h:163
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:108
a vtkAbstractArray subclass for strings
record modification and/or execution time
Definition: vtkTimeStamp.h:55
takes care of drawing 2D axes
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:481
@ 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:273
vtkVector2i ScreenPosition
Definition: vtkChartBox.h:276
vtkStdString SeriesName
Definition: vtkChartBox.h:274
vtkVector2f Position
Definition: vtkChartBox.h:275
int vtkIdType
Definition: vtkType.h:332