VTK
vtkChartXYZ.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkChartXYZ.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 
23 #ifndef vtkChartXYZ_h
24 #define vtkChartXYZ_h
25 
26 #include "vtkChartsCoreModule.h" // For export macro
27 #include "vtkContextItem.h"
28 #include "vtkColor.h" // For vtkColor4ub
29 #include "vtkRect.h" // For vtkRectf ivars
30 #include "vtkNew.h" // For ivars
31 #include "vtkSmartPointer.h" // For ivars
32 #include <vector> // For ivars
33 
34 class vtkAnnotationLink;
35 class vtkAxis;
36 class vtkContext3D;
38 class vtkPen;
39 class vtkPlaneCollection;
40 class vtkPlot3D;
41 class vtkTable;
42 class vtkTransform;
44 
45 class VTKCHARTSCORE_EXPORT vtkChartXYZ : public vtkContextItem
46 {
47 public:
48  vtkTypeMacro(vtkChartXYZ, vtkContextItem);
49  void PrintSelf(ostream &os, vtkIndent indent) override;
50 
51  static vtkChartXYZ * New();
52 
59  void SetGeometry(const vtkRectf &bounds);
60 
64  void SetAngle(double angle);
65 
69  void SetAroundX(bool isX);
70 
74  virtual void SetAnnotationLink(vtkAnnotationLink *link);
75 
79  vtkAxis * GetAxis(int axis);
80 
82 
85  void SetAxisColor(const vtkColor4ub& color);
86  vtkColor4ub GetAxisColor();
88 
93  void SetAutoRotate(bool b);
94 
99  void SetDecorateAxes(bool b);
100 
105  void SetFitToScene(bool b);
106 
110  void Update() override;
111 
115  bool Paint(vtkContext2D *painter) override;
116 
120  virtual vtkIdType AddPlot(vtkPlot3D* plot);
121 
125  void ClearPlots();
126 
131  void RecalculateBounds();
132 
138  void RecalculateTransform();
139 
143  bool Hit(const vtkContextMouseEvent &mouse) override;
144 
148  bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse) override;
149 
153  bool MouseMoveEvent(const vtkContextMouseEvent &mouse) override;
154 
158  bool MouseWheelEvent(const vtkContextMouseEvent &mouse, int delta) override;
159 
165  bool KeyPressEvent(const vtkContextKeyEvent &key) override;
166 
167 protected:
168  vtkChartXYZ();
169  ~vtkChartXYZ() override;
170 
176  virtual void CalculateTransforms();
177 
184  bool CalculatePlotTransform(vtkAxis *x, vtkAxis *y, vtkAxis *z,
185  vtkTransform *transform);
186 
190  bool Rotate(const vtkContextMouseEvent &mouse);
191 
195  bool Pan(const vtkContextMouseEvent &mouse);
196 
200  bool Zoom(const vtkContextMouseEvent &mouse);
201 
205  bool Spin(const vtkContextMouseEvent &mouse);
206 
210  void LookDownX();
211 
215  void LookDownY();
216 
220  void LookDownZ();
221 
225  void LookUpX();
226 
230  void LookUpY();
231 
235  void LookUpZ();
236 
240  bool CheckForSceneResize();
241 
245  void RescaleAxes();
246 
250  void ScaleUpAxes();
251 
255  void ScaleDownAxes();
256 
260  void ZoomAxes(int delta);
261 
266  void InitializeAxesBoundaryPoints();
267 
277  void InitializeFutureBox();
278 
282  void ComputeDataBounds();
283 
287  void DrawAxes(vtkContext3D *context);
288 
293  void DetermineWhichAxesToLabel();
294 
298  void DrawTickMarks(vtkContext2D *painter);
299 
303  void DrawAxesLabels(vtkContext2D *painter);
304 
310  void GetOffsetForAxisLabel(int axis, float *bounds, float *offset);
311 
317  double CalculateNiceMinMax(double &min, double &max, int axis);
318 
322  void GetClippingPlaneEquation(int i, double *planeEquation);
323 
328 
332  std::vector< vtkSmartPointer<vtkAxis> > Axes;
333 
339 
344  bool IsX;
345 
350  double Angle;
351 
357 
363 
368 
375 
380 
385 
391 
397 
403 
410 
415 
420 
425 
430 
434  std::vector<vtkPlot3D *> Plots;
435 
440 
445 
450 
455 
460  float AxesBoundaryPoints[14][3];
461 
466  float TickLabelOffset[3][2];
467 
472 
477 
479 
482  int XAxisToLabel[3];
483  int YAxisToLabel[3];
484  int ZAxisToLabel[3];
486 
490  int DirectionToData[3];
491 
495  double DataBounds[4];
496 
497 private:
498  vtkChartXYZ(const vtkChartXYZ &) = delete;
499  void operator=(const vtkChartXYZ &) = delete;
500 };
501 
502 #endif
int SceneHeight
The height of the scene, as of the most recent call to Paint().
Definition: vtkChartXYZ.h:471
std::vector< vtkSmartPointer< vtkAxis > > Axes
The 3 axes of this chart.
Definition: vtkChartXYZ.h:332
bool AutoRotate
This boolean indicates whether or not we&#39;re using this chart to rotate on a timer.
Definition: vtkChartXYZ.h:338
data structure to represent key events.
int SceneWidth
The weight of the scene, as of the most recent call to Paint().
Definition: vtkChartXYZ.h:476
vtkNew< vtkTransform > PlotTransform
This transform translates and scales the plots&#39; data points so that they appear within the axes of th...
Definition: vtkChartXYZ.h:374
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...
vtkNew< vtkTransform > Scale
This transform keeps track of how the data points have been scaled (zoomed in or zoomed out) within t...
Definition: vtkChartXYZ.h:396
virtual bool Paint(vtkContext2D *painter)
Paint event for the item, called whenever the item needs to be drawn.
maintain a list of planes
vtkNew< vtkTransform > Rotation
This transform keeps track of how the chart has been rotated.
Definition: vtkChartXYZ.h:384
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:54
int vtkIdType
Definition: vtkType.h:345
bool IsX
When we&#39;re in AutoRotate mode, this boolean tells us if we should rotate about the X axis or the Y ax...
Definition: vtkChartXYZ.h:344
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:52
vtkRectf Geometry
The size and position of this chart.
Definition: vtkChartXYZ.h:327
virtual bool MouseWheelEvent(const vtkContextMouseEvent &mouse, int delta)
Mouse wheel event, positive delta indicates forward movement of the wheel.
takes care of drawing 2D axes
Definition: vtkAxis.h:68
data structure to represent mouse events.
double Angle
When we&#39;re in AutoRotate mode, this value tells the chart how much it should be rotated.
Definition: vtkChartXYZ.h:350
a simple class to control print indentation
Definition: vtkIndent.h:33
std::string YAxisLabel
The label for the Y Axis.
Definition: vtkChartXYZ.h:444
std::string ZAxisLabel
The label for the Z Axis.
Definition: vtkChartXYZ.h:449
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:36
vtkNew< vtkTransform > Translation
This transform keeps track of how the data points have been panned within the chart.
Definition: vtkChartXYZ.h:390
vtkSmartPointer< vtkAnnotationLink > Link
This link is used to share selected points with other classes.
Definition: vtkChartXYZ.h:429
virtual bool KeyPressEvent(const vtkContextKeyEvent &key)
Key press event.
dynamic, self-adjusting array of unsigned char
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:62
vtkNew< vtkPen > AxisPen
This is the pen that is used to draw the axes.
Definition: vtkChartXYZ.h:424
virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse)
Mouse move event.
vtkNew< vtkTransform > ContextTransform
This is the transform that is applied when rendering data from the plots.
Definition: vtkChartXYZ.h:367
virtual bool Hit(const vtkContextMouseEvent &mouse)
Return true if the supplied x, y coordinate is inside the item.
bool FitToScene
This boolean indicates whether or not we should automatically resize the chart so that it snugly fill...
Definition: vtkChartXYZ.h:362
std::string XAxisLabel
The label for the X Axis.
Definition: vtkChartXYZ.h:439
Abstract class for 3D plots.
Definition: vtkPlot3D.h:44
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
vtkNew< vtkPlaneCollection > BoundingCube
The six planes that define the bounding cube of our 3D axes.
Definition: vtkChartXYZ.h:454
vtkNew< vtkTransform > BoxScale
This transform keeps track of how the axes have been scaled (zoomed in or zoomed out).
Definition: vtkChartXYZ.h:402
std::vector< vtkPlot3D * > Plots
The plots that are drawn within this chart.
Definition: vtkChartXYZ.h:434
Factory class for drawing 3D XYZ charts.
Definition: vtkChartXYZ.h:45
vtkNew< vtkTransform > FutureBox
This transform is initialized as a copy of Box.
Definition: vtkChartXYZ.h:409
bool DrawAxesDecoration
This boolean indicates whether or not we should draw tick marks and axes labels.
Definition: vtkChartXYZ.h:356
virtual void Update()
Perform any updates to the item that may be necessary before rendering.
#define max(a, b)
vtkNew< vtkTransform > FutureBoxScale
This transform keeps track of the Scale of the FutureBox transform.
Definition: vtkChartXYZ.h:414
vtkNew< vtkTransform > Box
This is the transform that is applied when rendering data from the plots.
Definition: vtkChartXYZ.h:379
vtkNew< vtkPen > Pen
This is the pen that is used to draw data from the plots.
Definition: vtkChartXYZ.h:419
Class for drawing 3D primitives to a graphical context.
Definition: vtkContext3D.h:40