VTK
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  LEFT = 0,
71  TOP,
73  CUSTOM
74  };
75 
79  void SetPoint(const vtkVector2f &point);
80 
84  const vtkVector2f& GetPointVector();
85 
87 
91  vtkSetMacro(HorizontalAlignment, int);
93 
95 
98  vtkGetMacro(HorizontalAlignment, int);
100 
102 
106  vtkSetMacro(VerticalAlignment, int);
108 
110 
113  vtkGetMacro(VerticalAlignment, int);
115 
117 
120  vtkSetMacro(Padding, int);
122 
124 
127  vtkGetMacro(Padding, int);
129 
131 
134  vtkSetMacro(SymbolWidth, int);
136 
138 
141  vtkGetMacro(SymbolWidth, int);
143 
147  virtual void SetLabelSize(int size);
148 
152  virtual int GetLabelSize();
153 
155 
160  vtkSetMacro(Inline, bool);
161  vtkGetMacro(Inline, bool);
163 
165 
171  vtkSetMacro(DragEnabled, bool);
172  vtkGetMacro(DragEnabled, bool);
174 
178  void SetChart(vtkChart* chart);
179 
183  vtkChart* GetChart();
184 
189  void Update() override;
190 
194  bool Paint(vtkContext2D *painter) override;
195 
202  virtual vtkRectf GetBoundingRect(vtkContext2D* painter);
203 
207  vtkPen * GetPen();
208 
212  vtkBrush * GetBrush();
213 
217  vtkTextProperty * GetLabelProperties();
218 
220 
228  vtkSetMacro(CacheBounds, bool);
229  vtkGetMacro(CacheBounds, bool);
230  vtkBooleanMacro(CacheBounds, bool);
232 
236  bool Hit(const vtkContextMouseEvent &mouse) override;
237 
241  bool MouseMoveEvent(const vtkContextMouseEvent &mouse) override;
242 
246  bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse) override;
247 
251  bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse) override;
252 
253 protected:
254  vtkChartLegend();
255  ~vtkChartLegend() override;
256 
257  float* Point; // The point the legend is anchored to.
258  int HorizontalAlignment; // Alignment of the legend to the point it is anchored to.
259  int VerticalAlignment; // Alignment of the legend to the point it is anchored to.
260 
265 
270 
275 
280 
286 
290  int Button;
291 
294 
296 
300  int Padding;
301 
306 
310  bool Inline;
311 
312  // Private storage class
313  class Private;
314  Private* Storage;
315 
316 private:
317  vtkChartLegend(const vtkChartLegend &) = delete;
318  void operator=(const vtkChartLegend &) = delete;
319 };
320 
321 #endif //vtkChartLegend_h
vtkChart
Factory class for drawing 2D charts.
Definition: vtkChart.h:50
vtkBrush
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:40
vtkContextMouseEvent
data structure to represent mouse events.
Definition: vtkContextMouseEvent.h:40
vtkChartLegend::Button
int Button
Last button to be pressed.
Definition: vtkChartLegend.h:290
vtkChartLegend::Pen
vtkNew< vtkPen > Pen
The pen used to draw the legend box.
Definition: vtkChartLegend.h:264
vtkChartLegend::RectTime
vtkTimeStamp RectTime
Definition: vtkChartLegend.h:293
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkChartLegend
draw the chart legend
Definition: vtkChartLegend.h:42
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:35
vtkContext2D
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:58
vtkContextItem.h
vtkChartLegend::CacheBounds
bool CacheBounds
Should the legend attempt to avoid recalculating its position & bounds unnecessarily?
Definition: vtkChartLegend.h:285
vtkChartLegend::Inline
bool Inline
Should the legend be drawn inline in its chart?
Definition: vtkChartLegend.h:310
vtkX3D::point
Definition: vtkX3D.h:236
vtkRect.h
vtkChartLegend::LabelProperties
vtkNew< vtkTextProperty > LabelProperties
The text properties of the labels used in the legend.
Definition: vtkChartLegend.h:274
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkChartLegend::DragEnabled
bool DragEnabled
Should we move the legend box around in response to the mouse drag?
Definition: vtkChartLegend.h:279
vtkAbstractContextItem::Hit
virtual bool Hit(const vtkContextMouseEvent &mouse)
Return true if the supplied x, y coordinate is inside the item.
vtkX3D::size
Definition: vtkX3D.h:253
vtkNew< vtkPen >
vtkContextItem::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkChartLegend::CENTER
Definition: vtkChartLegend.h:69
vtkAbstractContextItem::MouseMoveEvent
virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse)
Mouse move event.
vtkChartLegend::SymbolWidth
int SymbolWidth
Width of the symbols in pixels in the legend.
Definition: vtkChartLegend.h:305
vtkAbstractContextItem::MouseButtonReleaseEvent
virtual bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse)
Mouse button release event.
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:39
vtkContextItem
base class for items that are part of a vtkContextScene.
Definition: vtkContextItem.h:34
vtkChartLegend::Rect
vtkRectf Rect
Definition: vtkChartLegend.h:295
vtkChartLegend::PlotTime
vtkTimeStamp PlotTime
Definition: vtkChartLegend.h:292
vtkChartLegend::BOTTOM
Definition: vtkChartLegend.h:72
vtkChartLegend::VerticalAlignment
int VerticalAlignment
Definition: vtkChartLegend.h:259
vtkChartLegend::HorizontalAlignment
int HorizontalAlignment
Definition: vtkChartLegend.h:258
vtkChartLegend::Point
float * Point
Definition: vtkChartLegend.h:257
vtkNew.h
vtkX3D::Inline
Definition: vtkX3D.h:113
vtkAbstractContextItem::Paint
virtual bool Paint(vtkContext2D *painter)
Paint event for the item, called whenever the item needs to be drawn.
vtkChartLegend::TOP
Definition: vtkChartLegend.h:71
vtkChartLegend::Padding
int Padding
Padding between symbol and text.
Definition: vtkChartLegend.h:300
vtkChartLegend::Storage
Private * Storage
Definition: vtkChartLegend.h:313
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...
vtkPen
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:39
vtkRectf
Definition: vtkRect.h:332
vtkVector2f
Definition: vtkVector.h:422
vtkChartLegend::RIGHT
Definition: vtkChartLegend.h:70
vtkAbstractContextItem::Update
virtual void Update()
Perform any updates to the item that may be necessary before rendering.
vtkChartLegend::Brush
vtkNew< vtkBrush > Brush
The brush used to render the background of the legend.
Definition: vtkChartLegend.h:269