VTK  9.0.20201202
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 
77  bool GetColumnVisibility(const vtkStdString& name);
78  bool GetColumnVisibility(vtkIdType column);
80 
84  vtkIdType GetColumnId(const vtkStdString& name);
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 
100  vtkPlot* GetPlot(vtkIdType index) override;
101 
105  vtkIdType GetNumberOfPlots() override;
106 
110  virtual vtkAxis* GetYAxis();
111 
115  virtual float GetXPosition(int index);
116 
120  virtual vtkIdType GetNumberOfVisibleColumns();
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 
156  virtual vtkTooltipItem* GetTooltip();
157 
161  virtual void SetTooltipInfo(const vtkContextMouseEvent&, const vtkVector2d&, vtkIdType, vtkPlot*,
162  vtkIdType segmentIndex = -1);
163 
164 protected:
165  vtkChartBox();
166  ~vtkChartBox() override;
167 
169 
172  class Private;
173  Private* Storage;
175 
177 
182 
187 
189 
195 
200 
205 
206  void ResetSelection();
207  void UpdateGeometry(vtkContext2D*);
208  void CalculatePlotTransform();
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& segmentId);
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
vtkChart
Factory class for drawing 2D charts.
Definition: vtkChart.h:44
vtkChart::GetNumberOfPlots
virtual vtkIdType GetNumberOfPlots()
Get the number of plots the chart contains.
vtkContextMouseEvent
data structure to represent mouse events.
Definition: vtkContextMouseEvent.h:34
vtkIdType
int vtkIdType
Definition: vtkType.h:330
vtkChartBoxData::Position
vtkVector2f Position
Definition: vtkChartBox.h:235
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:32
vtkChartBox::VisibleColumns
vtkStringArray * VisibleColumns
A list of the visible columns in the chart.
Definition: vtkChartBox.h:186
vtkChart.h
vtkChartBox
Factory class for drawing box plot charts.
Definition: vtkChartBox.h:36
vtkSmartPointer< vtkTooltipItem >
vtkChartBoxData::SeriesName
vtkStdString SeriesName
Definition: vtkChartBox.h:234
vtkChart::CalculatePlotTransform
bool CalculatePlotTransform(vtkAxis *x, vtkAxis *y, vtkTransform2D *transform)
Given the x and y vtkAxis, and a transform, calculate the transform that the points in a chart would ...
vtkTooltipItem
takes care of drawing 2D axes
Definition: vtkTooltipItem.h:39
vtkContext2D
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:52
vtkPlot
Abstract class for 2D plots.
Definition: vtkPlot.h:47
vtkVector2d
Definition: vtkVector.h:444
vtkX3D::position
Definition: vtkX3D.h:267
vtkPlotBox
Class for drawing box plots.
Definition: vtkPlotBox.h:38
vtkChart::Paint
bool Paint(vtkContext2D *painter) override=0
Paint event for the chart, called whenever the chart needs to be drawn.
vtkChartBox::GeometryValid
bool GeometryValid
Definition: vtkChartBox.h:176
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkAbstractContextItem::Hit
virtual bool Hit(const vtkContextMouseEvent &mouse)
Return true if the supplied x, y coordinate is inside the item.
vtkChart::GetPlot
virtual vtkPlot * GetPlot(vtkIdType index)
Get the plot at the specified index, returns null if the index is invalid.
vtkChartBox::BuildTime
vtkTimeStamp BuildTime
The point cache is marked dirty until it has been initialized.
Definition: vtkChartBox.h:199
vtkChartBox::SelectedColumn
int SelectedColumn
Index of the selected column in the visible columns list.
Definition: vtkChartBox.h:192
vtkAbstractContextItem::MouseMoveEvent
virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse)
Mouse move event.
vtkChartBox::SelectedColumnDelta
float SelectedColumnDelta
Definition: vtkChartBox.h:193
vtkX3D::name
Definition: vtkX3D.h:225
vtkAbstractContextItem::MouseButtonReleaseEvent
virtual bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse)
Mouse button release event.
vtkChartBoxData::ScreenPosition
vtkVector2i ScreenPosition
Definition: vtkChartBox.h:236
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:35
vtkChart::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkChartBox::Tooltip
vtkSmartPointer< vtkTooltipItem > Tooltip
The tooltip item for the chart - can be used to display extra information.
Definition: vtkChartBox.h:204
vtkChartBoxData
Small struct used by InvokeEvent to send some information about the point that was clicked on.
Definition: vtkChartBox.h:232
vtkAxis
takes care of drawing 2D axes
Definition: vtkAxis.h:68
vtkChartBox::Storage
Private * Storage
Definition: vtkChartBox.h:172
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:36
vtkChartBoxData::Index
int Index
Definition: vtkChartBox.h:237
vtkAbstractContextItem::MouseButtonPressEvent
virtual bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse)
Mouse button down event Return true if the item holds the event, false if the event can be propagated...
vtkVector2i
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:419
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
vtkX3D::index
Definition: vtkX3D.h:252
vtkVector2f
Definition: vtkVector.h:432
vtkAbstractContextItem::Update
virtual void Update()
Perform any updates to the item that may be necessary before rendering.
vtkChartBox::Selection
vtkIdTypeArray * Selection
Selected indices for the table the plot is rendering.
Definition: vtkChartBox.h:181