VTK  9.2.6
vtkChartLegend.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkChartLegend.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 
29 #ifndef vtkChartLegend_h
30 #define vtkChartLegend_h
31 
32 #include "vtkChartsCoreModule.h" // For export macro
33 #include "vtkContextItem.h"
34 #include "vtkNew.h" // For vtkNew
35 #include "vtkRect.h" // For vtkRectf return value
36 
37 class vtkChart;
38 class vtkPen;
39 class vtkBrush;
40 class vtkTextProperty;
41 
42 class VTKCHARTSCORE_EXPORT vtkChartLegend : public vtkContextItem
43 {
44 public:
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47 
51  static vtkChartLegend* New();
52 
54 
57  vtkSetVector2Macro(Point, float);
59 
61 
64  vtkGetVector2Macro(Point, float);
66 
67  enum
68  {
69  LEFT = 0,
72  TOP,
74  CUSTOM
75  };
76 
80  void SetPoint(const vtkVector2f& point);
81 
85  const vtkVector2f& GetPointVector();
86 
88 
92  vtkSetMacro(HorizontalAlignment, int);
94 
96 
99  vtkGetMacro(HorizontalAlignment, int);
101 
103 
107  vtkSetMacro(VerticalAlignment, int);
109 
111 
114  vtkGetMacro(VerticalAlignment, int);
116 
118 
121  vtkSetMacro(Padding, int);
123 
125 
128  vtkGetMacro(Padding, int);
130 
132 
135  vtkSetMacro(SymbolWidth, int);
137 
139 
142  vtkGetMacro(SymbolWidth, int);
144 
148  virtual void SetLabelSize(int size);
149 
153  virtual int GetLabelSize();
154 
156 
161  vtkSetMacro(Inline, bool);
162  vtkGetMacro(Inline, bool);
164 
166 
172  vtkSetMacro(DragEnabled, bool);
173  vtkGetMacro(DragEnabled, bool);
175 
179  void SetChart(vtkChart* chart);
180 
184  vtkChart* GetChart();
185 
190  void Update() override;
191 
195  bool Paint(vtkContext2D* painter) override;
196 
203  virtual vtkRectf GetBoundingRect(vtkContext2D* painter);
204 
208  vtkPen* GetPen();
209 
213  vtkBrush* GetBrush();
214 
218  vtkTextProperty* GetLabelProperties();
219 
221 
229  vtkSetMacro(CacheBounds, bool);
230  vtkGetMacro(CacheBounds, bool);
231  vtkBooleanMacro(CacheBounds, bool);
233 
237  bool Hit(const vtkContextMouseEvent& mouse) override;
238 
242  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
243 
247  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
248 
252  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;
253 
254 protected:
255  vtkChartLegend();
256  ~vtkChartLegend() override;
257 
258  float* Point; // The point the legend is anchored to.
259  int HorizontalAlignment; // Alignment of the legend to the point it is anchored to.
260  int VerticalAlignment; // Alignment of the legend to the point it is anchored to.
261 
266 
271 
276 
281 
287 
291  int Button;
292 
295 
297 
301  int Padding;
302 
307 
311  bool Inline;
312 
313  // Private storage class
314  class Private;
315  Private* Storage;
316 
317 private:
318  vtkChartLegend(const vtkChartLegend&) = delete;
319  void operator=(const vtkChartLegend&) = delete;
320 };
321 
322 #endif // vtkChartLegend_h
Private * Storage
vtkTimeStamp PlotTime
base class for items that are part of a vtkContextScene.
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...
virtual bool Paint(vtkContext2D *painter)
Paint event for the item, called whenever the item needs to be drawn.
record modification and/or execution time
Definition: vtkTimeStamp.h:35
bool DragEnabled
Should we move the legend box around in response to the mouse drag?
bool Inline
Should the legend be drawn inline in its chart?
int Padding
Padding between symbol and text.
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:57
Factory class for drawing 2D charts.
Definition: vtkChart.h:51
vtkTimeStamp RectTime
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:40
data structure to represent mouse events.
a simple class to control print indentation
Definition: vtkIndent.h:39
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse)
Mouse button release event.
vtkNew< vtkBrush > Brush
The brush used to render the background of the legend.
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:39
represent text properties.
int SymbolWidth
Width of the symbols in pixels in the legend.
draw the chart legend
int Button
Last button to be pressed.
bool CacheBounds
Should the legend attempt to avoid recalculating its position & bounds unnecessarily?
virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse)
Mouse move event.
virtual bool Hit(const vtkContextMouseEvent &mouse)
Return true if the supplied x, y coordinate is inside the item.
vtkNew< vtkTextProperty > LabelProperties
The text properties of the labels used in the legend.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual void Update()
Perform any updates to the item that may be necessary before rendering.
vtkNew< vtkPen > Pen
The pen used to draw the legend box.