VTK  9.1.0
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
52#ifndef vtkChartXYZ_h
53#define vtkChartXYZ_h
54
55#include "vtkChartsCoreModule.h" // For export macro
56#include "vtkColor.h" // For vtkColor4ub
57#include "vtkContextItem.h"
58#include "vtkNew.h" // For ivars
59#include "vtkRect.h" // For vtkRectf ivars
60#include "vtkSmartPointer.h" // For ivars
61#include "vtkStdString.h" // For vtkStdString
62#include "vtkTextProperty.h" // For axes text properties
63#include <vector> // For ivars
64
66class vtkAxis;
67class vtkContext3D;
69class vtkPen;
71class vtkPlot3D;
72class vtkTable;
73class vtkTransform;
75
76class VTKCHARTSCORE_EXPORT vtkChartXYZ : public vtkContextItem
77{
78public:
80 void PrintSelf(ostream& os, vtkIndent indent) override;
81
82 static vtkChartXYZ* New();
83
93 void SetGeometry(const vtkRectf& bounds);
94
102 void SetMargins(const vtkVector4i& margins);
103
107 vtkSetMacro(Angle, double);
108
112 void SetAroundX(bool isX);
113
118
122 vtkAxis* GetAxis(int axis);
123
127 virtual void SetAxis(int axisIndex, vtkAxis* axis);
128
130
133 void SetAxisColor(const vtkColor4ub& color);
136
157
161 vtkSetMacro(XAxisLabel, vtkStdString);
162
166 vtkSetMacro(YAxisLabel, vtkStdString);
167
171 vtkSetMacro(ZAxisLabel, vtkStdString);
172
178 vtkSetMacro(EnsureOuterEdgeAxisLabelling, bool);
179
184 vtkSetMacro(AutoRotate, bool);
185
190 void SetDecorateAxes(bool b);
191
196 void SetFitToScene(bool b);
197
201 void Update() override;
202
206 bool Paint(vtkContext2D* painter) override;
207
212
216 virtual bool RemovePlot(vtkPlot3D* plot);
217
222
228
235
239 bool Hit(const vtkContextMouseEvent& mouse) override;
240
244 bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
245
249 bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
250
254 bool MouseWheelEvent(const vtkContextMouseEvent& mouse, int delta) override;
255
261 bool KeyPressEvent(const vtkContextKeyEvent& key) override;
262
267
271 vtkGetMacro(ClippingPlanesEnabled, bool);
272
276 vtkSetMacro(ScaleBoxWithPlot, bool);
277
281 vtkGetMacro(ScaleBoxWithPlot, bool);
282
283protected:
285 ~vtkChartXYZ() override;
286
291 {
295 DOWN
296 };
297
302 {
308 STANDARD
309 };
310
315 {
323 NORTH_WEST
324 };
325
331 virtual void CalculateTransforms();
332
340
344 bool Rotate(const vtkContextMouseEvent& mouse);
345
349 bool Rotate(const RotateDirection rotateDirection);
350
354 bool Pan(const vtkContextMouseEvent& mouse);
355
359 bool Zoom(const vtkContextMouseEvent& mouse);
360
364 bool Spin(const vtkContextMouseEvent& mouse);
365
369 void LookDownX();
370
374 void LookDownY();
375
379 void LookDownZ();
380
384 void LookUpX();
385
389 void LookUpY();
390
394 void LookUpZ();
395
400
405
410
415
419 void ZoomAxes(int delta);
420
426
437
442
446 void DrawAxes(vtkContext3D* context);
447
453
459
469
474
480 void GetOffsetForAxisLabel(int axis, float* bounds, float* offset);
481
487 double CalculateNiceMinMax(double& min, double& max, int axis);
488
492 void GetClippingPlaneEquation(int i, double* planeEquation);
493
497 std::size_t GetMarginLeft() const;
498
502 std::size_t GetMarginBottom() const;
503
507 std::size_t GetPlotWidth() const;
508
512 std::size_t GetPlotHeight() const;
513
517 enum
518 {
520 USE_GEOMETRY
521 } SizeStrategy = USE_GEOMETRY;
522
527 vtkVector4i Margins = vtkVector4i(40, 40, 40, 40);
528
533 vtkRectf Geometry = vtkRectf(40, 40, 120, 120);
534
538 std::vector<vtkSmartPointer<vtkAxis>> Axes;
539
544 bool AutoRotate = false;
545
550 bool IsX = false;
551
556 double Angle = 0;
557
562 bool DrawAxesDecoration = true;
563
568 bool FitToScene = true;
569
574
581
586
591
597
603
609
616
621
626
631
636
640 std::vector<vtkPlot3D*> Plots;
641
645 std::vector<vtkIdType> FreePlaces;
646
651
655 std::string XAxisLabel;
656
660 std::string YAxisLabel;
661
665 std::string ZAxisLabel;
666
672 bool EnsureOuterEdgeAxisLabelling = false;
677
682 float AxesBoundaryPoints[8][3];
683
688 float TickLabelOffset[3][2];
689
694
699
701
704 int XAxisToLabel[3];
705 int YAxisToLabel[3];
706 int ZAxisToLabel[3];
708
712 int DirectionToData[3];
713
717 double DataBounds[4];
718
722 bool ClippingPlanesEnabled = true;
723
727 bool ScaleBoxWithPlot = true;
728
729private:
730 vtkChartXYZ(const vtkChartXYZ&) = delete;
731 void operator=(const vtkChartXYZ&) = delete;
732};
733
734#endif
takes care of drawing 2D axes
Definition: vtkAxis.h:178
Factory class for drawing 3D XYZ charts.
Definition: vtkChartXYZ.h:77
~vtkChartXYZ() override
void SetClippingPlanesEnabled(bool)
Hide data outside the box.
vtkNew< vtkTransform > FutureBoxScale
This transform keeps track of the Scale of the FutureBox transform.
Definition: vtkChartXYZ.h:620
vtkNew< vtkTransform > FutureBox
This transform is initialized as a copy of Box.
Definition: vtkChartXYZ.h:615
std::string XAxisLabel
The label for the X Axis.
Definition: vtkChartXYZ.h:655
@ USE_MARGINS_AND_SCENE_SIZE
Definition: vtkChartXYZ.h:519
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.
Definition: vtkChartXYZ.h:585
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.
Definition: vtkChartXYZ.h:625
int SceneHeight
The height of the scene, as of the most recent call to Paint().
Definition: vtkChartXYZ.h:693
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.
Definition: vtkChartXYZ.h:291
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.
Definition: vtkChartXYZ.h:660
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...
Definition: vtkChartXYZ.h:602
std::vector< vtkSmartPointer< vtkAxis > > Axes
The 3 axes of this chart.
Definition: vtkChartXYZ.h:538
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.
Definition: vtkChartXYZ.h:676
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.
Definition: vtkChartXYZ.h:590
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.
Definition: vtkChartXYZ.h:630
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).
Definition: vtkChartXYZ.h:608
std::string ZAxisLabel
The label for the Z Axis.
Definition: vtkChartXYZ.h:665
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.
Definition: vtkChartXYZ.h:640
vtkNew< vtkTransform > ContextTransform
This is the transform that is applied when rendering data from the plots.
Definition: vtkChartXYZ.h:573
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.
Definition: vtkChartXYZ.h:635
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.
Definition: vtkChartXYZ.h:315
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.
Definition: vtkChartXYZ.h:596
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...
Definition: vtkChartXYZ.h:580
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.
Definition: vtkChartXYZ.h:650
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.
Definition: vtkChartXYZ.h:302
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.
Definition: vtkChartXYZ.h:645
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().
Definition: vtkChartXYZ.h:698
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.
Definition: vtkContext2D.h:73
Class for drawing 3D primitives to a graphical context.
Definition: vtkContext3D.h:60
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:113
Allocate and hold a VTK object.
Definition: vtkNew.h:165
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:136
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.
Definition: vtkStdString.h:105
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:172
represent text properties.
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:164
dynamic, self-adjusting array of unsigned char
int vtkIdType
Definition: vtkType.h:332
#define max(a, b)