VTK  9.2.6
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
26#ifndef vtkChartXYZ_h
27#define vtkChartXYZ_h
28
29#include "vtkChartsCoreModule.h" // For export macro
30#include "vtkColor.h" // For vtkColor4ub
31#include "vtkContextItem.h"
32#include "vtkNew.h" // For ivars
33#include "vtkRect.h" // For vtkRectf ivars
34#include "vtkSmartPointer.h" // For ivars
35#include "vtkStdString.h" // For vtkStdString
36#include "vtkTextProperty.h" // For axes text properties
37#include <vector> // For ivars
38
40class vtkAxis;
41class vtkContext3D;
43class vtkPen;
45class vtkPlot3D;
46class vtkTable;
47class vtkTransform;
49
50class VTKCHARTSCORE_EXPORT vtkChartXYZ : public vtkContextItem
51{
52public:
54 void PrintSelf(ostream& os, vtkIndent indent) override;
55
56 static vtkChartXYZ* New();
57
67 void SetGeometry(const vtkRectf& bounds);
68
76 void SetMargins(const vtkVector4i& margins);
77
81 vtkSetMacro(Angle, double);
82
86 void SetAroundX(bool isX);
87
92
96 vtkAxis* GetAxis(int axis);
97
101 virtual void SetAxis(int axisIndex, vtkAxis* axis);
102
104
107 void SetAxisColor(const vtkColor4ub& color);
110
131
135 vtkSetMacro(XAxisLabel, vtkStdString);
136
140 vtkSetMacro(YAxisLabel, vtkStdString);
141
145 vtkSetMacro(ZAxisLabel, vtkStdString);
146
152 vtkSetMacro(EnsureOuterEdgeAxisLabelling, bool);
153
158 vtkSetMacro(AutoRotate, bool);
159
164 void SetDecorateAxes(bool b);
165
170 void SetFitToScene(bool b);
171
175 void Update() override;
176
180 bool Paint(vtkContext2D* painter) override;
181
186
190 virtual bool RemovePlot(vtkPlot3D* plot);
191
196
202
209
213 bool Hit(const vtkContextMouseEvent& mouse) override;
214
218 bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
219
223 bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
224
228 bool MouseWheelEvent(const vtkContextMouseEvent& mouse, int delta) override;
229
235 bool KeyPressEvent(const vtkContextKeyEvent& key) override;
236
241
245 vtkGetMacro(ClippingPlanesEnabled, bool);
246
250 vtkSetMacro(ScaleBoxWithPlot, bool);
251
255 vtkGetMacro(ScaleBoxWithPlot, bool);
256
257protected:
259 ~vtkChartXYZ() override;
260
265 {
269 DOWN
270 };
271
284
299
305 virtual void CalculateTransforms();
306
314
318 bool Rotate(const vtkContextMouseEvent& mouse);
319
323 bool Rotate(const RotateDirection rotateDirection);
324
328 bool Pan(const vtkContextMouseEvent& mouse);
329
333 bool Zoom(const vtkContextMouseEvent& mouse);
334
338 bool Spin(const vtkContextMouseEvent& mouse);
339
343 void LookDownX();
344
348 void LookDownY();
349
353 void LookDownZ();
354
358 void LookUpX();
359
363 void LookUpY();
364
368 void LookUpZ();
369
374
379
384
389
393 void ZoomAxes(int delta);
394
400
411
416
420 void DrawAxes(vtkContext3D* context);
421
427
433
443
448
454 void GetOffsetForAxisLabel(int axis, float* bounds, float* offset);
455
461 double CalculateNiceMinMax(double& min, double& max, int axis);
462
466 void GetClippingPlaneEquation(int i, double* planeEquation);
467
471 std::size_t GetMarginLeft() const;
472
476 std::size_t GetMarginBottom() const;
477
481 std::size_t GetPlotWidth() const;
482
486 std::size_t GetPlotHeight() const;
487
491 enum
492 {
494 USE_GEOMETRY
495 } SizeStrategy = USE_GEOMETRY;
496
501 vtkVector4i Margins = vtkVector4i(40, 40, 40, 40);
502
507 vtkRectf Geometry = vtkRectf(40, 40, 120, 120);
508
512 std::vector<vtkSmartPointer<vtkAxis>> Axes;
513
518 bool AutoRotate = false;
519
524 bool IsX = false;
525
530 double Angle = 0;
531
536 bool DrawAxesDecoration = true;
537
542 bool FitToScene = true;
543
548
555
560
565
571
577
583
590
595
600
605
610
614 std::vector<vtkPlot3D*> Plots;
615
619 std::vector<vtkIdType> FreePlaces;
620
625
629 std::string XAxisLabel;
630
634 std::string YAxisLabel;
635
639 std::string ZAxisLabel;
640
646 bool EnsureOuterEdgeAxisLabelling = false;
651
656 float AxesBoundaryPoints[8][3];
657
662 float TickLabelOffset[3][2];
663
668
673
675
678 int XAxisToLabel[3];
679 int YAxisToLabel[3];
680 int ZAxisToLabel[3];
682
686 int DirectionToData[3];
687
691 double DataBounds[4];
692
696 bool ClippingPlanesEnabled = true;
697
701 bool ScaleBoxWithPlot = true;
702
703private:
704 vtkChartXYZ(const vtkChartXYZ&) = delete;
705 void operator=(const vtkChartXYZ&) = delete;
706};
707
708#endif
takes care of drawing 2D axes
Definition vtkAxis.h:72
Factory class for drawing 3D XYZ charts.
Definition vtkChartXYZ.h:51
~vtkChartXYZ() override
void SetClippingPlanesEnabled(bool)
Hide data outside the box.
@ USE_MARGINS_AND_SCENE_SIZE
vtkNew< vtkTransform > FutureBoxScale
This transform keeps track of the Scale of the FutureBox transform.
vtkNew< vtkTransform > FutureBox
This transform is initialized as a copy of Box.
std::string XAxisLabel
The label for the X Axis.
void ScaleDownAxes()
Scale down the axes when the scene gets smaller.
bool Paint(vtkContext2D *painter) override
Paint event for the chart, called whenever the chart needs to be drawn.
void RescaleAxes()
Scale the axes up or down in response to a scene resize.
vtkNew< vtkTransform > Box
This is the transform that is applied when rendering data from the plots.
void SetAxisColor(const vtkColor4ub &color)
Set the color for the axes.
void LookUpX()
Adjust the rotation of the chart so that we are looking up the X axis.
vtkNew< vtkPen > Pen
This is the pen that is used to draw data from the plots.
int SceneHeight
The height of the scene, as of the most recent call to Paint().
virtual bool RemovePlot(vtkPlot3D *plot)
Removes a plot from the chart.
vtkAxis * GetAxis(int axis)
Get the x (0), y (1) or z (2) axis.
void DrawAxesLabels(vtkContext2D *painter)
Label the axes.
void DrawTickMarks(vtkContext2D *painter)
Draw tick marks and tick mark labels along the axes.
static vtkChartXYZ * New()
RotateDirection
Rotation directions.
bool Zoom(const vtkContextMouseEvent &mouse)
Zoom in or out on the data in response to a mouse movement.
std::string YAxisLabel
The label for the Y Axis.
void Update() override
Perform any updates to the item that may be necessary before rendering.
bool Rotate(const vtkContextMouseEvent &mouse)
Rotate the chart in response to a mouse movement.
double CalculateNiceMinMax(double &min, double &max, int axis)
Calculate the next "nicest" numbers above and below the current minimum.
vtkNew< vtkTransform > Scale
This transform keeps track of how the data points have been scaled (zoomed in or zoomed out) within t...
std::vector< vtkSmartPointer< vtkAxis > > Axes
The 3 axes of this chart.
bool Spin(const vtkContextMouseEvent &mouse)
Spin the chart in response to a mouse movement.
void GetClippingPlaneEquation(int i, double *planeEquation)
Get the equation for the ith face of our bounding cube.
vtkNew< vtkPlaneCollection > BoundingCube
The six planes that define the bounding cube of our 3D axes.
virtual void CalculateTransforms()
Calculate the transformation matrices used to draw data points and axes in the scene.
vtkNew< vtkTransform > Rotation
This transform keeps track of how the chart has been rotated.
void LegacyDetermineWhichAxesToLabel()
Old-style axis labelling, for compatibility; labelling may occur in less optimal places e....
void DrawAxes(vtkContext3D *context)
Draw the cube axes of this chart.
vtkNew< vtkPen > AxisPen
This is the pen that is used to draw the axes.
bool CalculatePlotTransform(vtkAxis *x, vtkAxis *y, vtkAxis *z, vtkTransform *transform)
Given the x, y and z vtkAxis, and a transform, calculate the transform that the points in a chart wou...
vtkNew< vtkTransform > BoxScale
This transform keeps track of how the axes have been scaled (zoomed in or zoomed out).
std::string ZAxisLabel
The label for the Z Axis.
void LookUpZ()
Adjust the rotation of the chart so that we are looking up the Z axis.
void GetOffsetForAxisLabel(int axis, float *bounds, float *offset)
Compute how some text should be offset from an axis.
void ClearPlots()
Remove all the plots from this chart.
std::size_t GetPlotHeight() const
Gets the current height of the plot in pixels irrespective of the size-strategy used.
void DetermineWhichAxesToLabel()
For each of the XYZ dimensions, find the axis line that is furthest from the rendered data.
std::vector< vtkPlot3D * > Plots
The plots that are drawn within this chart.
vtkNew< vtkTransform > ContextTransform
This is the transform that is applied when rendering data from the plots.
void LookDownX()
Adjust the rotation of the chart so that we are looking down the X axis.
vtkSmartPointer< vtkAnnotationLink > Link
This link is used to share selected points with other classes.
std::size_t GetMarginBottom() const
Gets the current margin top in pixels irrespective of the size-strategy used.
Direction
The direction to data from an axis.
void SetAroundX(bool isX)
Set whether or not we're rotating about the X axis.
void SetMargins(const vtkVector4i &margins)
Set the margins in pixels ordered top right bottom left The box will be drawn inside those margins,...
void ZoomAxes(int delta)
Change the scaling of the axes by a specified amount.
void LookUpY()
Adjust the rotation of the chart so that we are looking up the Y axis.
void SetDecorateAxes(bool b)
Set whether or not axes labels & tick marks should be drawn.
vtkNew< vtkTransform > Translation
This transform keeps track of how the data points have been panned within the chart.
void InitializeFutureBox()
Initialize the "future box" transform.
vtkNew< vtkTransform > PlotTransform
This transform translates and scales the plots' data points so that they appear within the axes of th...
bool CheckForSceneResize()
Check to see if the scene changed size since the last render.
void InitializeAxesBoundaryPoints()
Initialize a list of "test points".
vtkColor4ub GetAxisColor()
Set the color for the axes.
bool Rotate(const RotateDirection rotateDirection)
Rotate the chart in a specific direction.
bool KeyPressEvent(const vtkContextKeyEvent &key) override
Key press event.
void ScaleUpAxes()
Scale up the axes when the scene gets larger.
void SetGeometry(const vtkRectf &bounds)
Set the geometry in pixel coordinates (origin and width/height).
virtual void SetAxis(int axisIndex, vtkAxis *axis)
Set the x (0), y (1) or z (2) axis.
void ComputeDataBounds()
Compute a bounding box for the data that is rendered within the axes.
void LookDownZ()
Adjust the rotation of the chart so that we are looking down the Z axis.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkNew< vtkTextProperty > AxesTextProperty
The text properties of the axes.
bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse) override
Mouse press event.
void RecalculateBounds()
Determine the XYZ bounds of the plots within this chart.
void SetFitToScene(bool b)
Set whether or not the chart should automatically resize itself to fill the scene.
void NewDetermineWhichAxesToLabel()
New style axis labelling, ensuring labelling is always at the edges of the chart in the most sensible...
bool MouseWheelEvent(const vtkContextMouseEvent &mouse, int delta) override
Mouse wheel event.
bool MouseMoveEvent(const vtkContextMouseEvent &mouse) override
Mouse move event.
AxisState
The state of an axis.
void LookDownY()
Adjust the rotation of the chart so that we are looking down the Y axis.
std::vector< vtkIdType > FreePlaces
These plots got removed (from Plots), try to reuse the free spot.
std::size_t GetPlotWidth() const
Gets the current width of the plot in pixels irrespective of the size-strategy used.
vtkTextProperty * GetAxesTextProperty()
Get the text property for axes.
virtual void SetAnnotationLink(vtkAnnotationLink *link)
Set the vtkAnnotationLink for the chart.
void RecalculateTransform()
Use this chart's Geometry to set the endpoints of its axes.
int SceneWidth
The weight of the scene, as of the most recent call to Paint().
virtual vtkIdType AddPlot(vtkPlot3D *plot)
Adds a plot to the chart.
bool Hit(const vtkContextMouseEvent &mouse) override
Returns true if the transform is interactive, false otherwise.
std::size_t GetMarginLeft() const
Gets the current margin left in pixels irrespective of the size-strategy used.
bool Pan(const vtkContextMouseEvent &mouse)
Pan the data within the chart in response to a mouse movement.
Class for drawing 2D primitives to a graphical context.
Class for drawing 3D primitives to a graphical context.
base class for items that are part of a vtkContextScene.
data structure to represent key events.
data structure to represent mouse events.
a simple class to control print indentation
Definition vtkIndent.h:40
Allocate and hold a VTK object.
Definition vtkNew.h:62
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition vtkPen.h:40
maintain a list of planes
Abstract class for 3D plots.
Definition vtkPlot3D.h:45
Hold a reference to a vtkObjectBase instance.
Wrapper around std::string to keep symbols short.
A table, which contains similar-typed columns of data.
Definition vtkTable.h:74
represent text properties.
describes linear transformations via a 4x4 matrix
dynamic, self-adjusting array of unsigned char
int vtkIdType
Definition vtkType.h:332
#define max(a, b)