1// Copyright (C) 2023 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
3
4//
5// W A R N I N G
6// -------------
7//
8// This file is not part of the QtGraphs API. It exists purely as an
9// implementation detail. This header file may change from version to
10// version without notice, or even be removed.
11//
12// We mean it.
13
14#ifndef QQUICKGRAPHSBARS_H
15#define QQUICKGRAPHSBARS_H
16
17#include "qabstract3daxis.h"
18#include "qbar3dseries.h"
19#include "qquickgraphsitem_p.h"
20#include <private/barinstancing_p.h>
21
22#include <QtQuick3D/private/qquick3dmaterial_p.h>
23
24QT_BEGIN_NAMESPACE
25
26class QCategory3DAxis;
27
28struct Bars3DChangeBitField
29{
30 bool multiSeriesScalingChanged : 1;
31 bool barSpecsChanged : 1;
32 bool selectedBarChanged : 1;
33 bool rowsChanged : 1;
34 bool itemChanged : 1;
35 bool floorLevelChanged : 1;
36 bool barSeriesMarginChanged : 1;
37 bool axisRangeChanged : 1;
38 bool floorChanged : 1;
39
40 Bars3DChangeBitField()
41 : multiSeriesScalingChanged(true)
42 , barSpecsChanged(true)
43 , selectedBarChanged(true)
44 , rowsChanged(false)
45 , itemChanged(false)
46 , floorLevelChanged(false)
47 , barSeriesMarginChanged(false)
48 , axisRangeChanged(false)
49 , floorChanged(true)
50 {}
51};
52
53class Q_GRAPHS_EXPORT QQuickGraphsBars : public QQuickGraphsItem
54{
55 Q_OBJECT
56 Q_PROPERTY(QCategory3DAxis *rowAxis READ rowAxis WRITE setRowAxis NOTIFY rowAxisChanged)
57 Q_PROPERTY(QValue3DAxis *valueAxis READ valueAxis WRITE setValueAxis NOTIFY valueAxisChanged)
58 Q_PROPERTY(
59 QCategory3DAxis *columnAxis READ columnAxis WRITE setColumnAxis NOTIFY columnAxisChanged)
60 Q_PROPERTY(bool multiSeriesUniform READ isMultiSeriesUniform WRITE setMultiSeriesUniform NOTIFY
61 multiSeriesUniformChanged)
62 Q_PROPERTY(float barThickness READ barThickness WRITE setBarThickness NOTIFY barThicknessChanged)
63 Q_PROPERTY(QSizeF barSpacing READ barSpacing WRITE setBarSpacing NOTIFY barSpacingChanged)
64 Q_PROPERTY(bool barSpacingRelative READ isBarSpacingRelative WRITE setBarSpacingRelative NOTIFY
65 barSpacingRelativeChanged)
66 Q_PROPERTY(QSizeF barSeriesMargin READ barSeriesMargin WRITE setBarSeriesMargin NOTIFY
67 barSeriesMarginChanged)
68 Q_PROPERTY(QQmlListProperty<QBar3DSeries> seriesList READ seriesList CONSTANT)
69 Q_PROPERTY(QBar3DSeries *selectedSeries READ selectedSeries NOTIFY selectedSeriesChanged)
70 Q_PROPERTY(QBar3DSeries *primarySeries READ primarySeries WRITE setPrimarySeries NOTIFY
71 primarySeriesChanged)
72 Q_PROPERTY(float floorLevel READ floorLevel WRITE setFloorLevel NOTIFY floorLevelChanged)
73 Q_CLASSINFO("DefaultProperty", "seriesList")
74
75 QML_NAMED_ELEMENT(Bars3D)
76
77public:
78 explicit QQuickGraphsBars(QQuickItem *parent = 0);
79 ~QQuickGraphsBars() override;
80
81 struct ChangeItem
82 {
83 QBar3DSeries *series;
84 QPoint point;
85 };
86 struct ChangeRow
87 {
88 QBar3DSeries *series;
89 qsizetype row;
90 };
91
92 QCategory3DAxis *rowAxis() const;
93 void setRowAxis(QCategory3DAxis *axis);
94 QValue3DAxis *valueAxis() const;
95 void setValueAxis(QValue3DAxis *axis);
96 QCategory3DAxis *columnAxis() const;
97 void setColumnAxis(QCategory3DAxis *axis);
98
99 void setMultiSeriesUniform(bool uniform);
100 bool isMultiSeriesUniform() const;
101
102 void setBarThickness(float thicknessRatio);
103 float barThickness() const;
104
105 void setBarSpacing(QSizeF spacing);
106 QSizeF barSpacing() const;
107
108 void setBarSpacingRelative(bool relative);
109 bool isBarSpacingRelative() const;
110
111 void setBarSeriesMargin(QSizeF margin);
112 QSizeF barSeriesMargin() const;
113
114 void setMultiSeriesScaling(bool uniform);
115 bool multiSeriesScaling() const;
116
117 void setBarSpecs(float thicknessRatio = 1.0f,
118 QSizeF spacing = QSizeF(1.0, 1.0),
119 bool relative = true);
120
121 void setFloorLevel(float level);
122 float floorLevel() const;
123
124 QQmlListProperty<QBar3DSeries> seriesList();
125 static void appendSeriesFunc(QQmlListProperty<QBar3DSeries> *list, QBar3DSeries *series);
126 static qsizetype countSeriesFunc(QQmlListProperty<QBar3DSeries> *list);
127 static QBar3DSeries *atSeriesFunc(QQmlListProperty<QBar3DSeries> *list, qsizetype index);
128 static void clearSeriesFunc(QQmlListProperty<QBar3DSeries> *list);
129 Q_INVOKABLE void addSeries(QBar3DSeries *series);
130 Q_INVOKABLE void removeSeries(QBar3DSeries *series);
131 Q_INVOKABLE void insertSeries(qsizetype index, QBar3DSeries *series);
132 Q_INVOKABLE void clearSelection() override;
133
134 void setPrimarySeries(QBar3DSeries *series);
135 QBar3DSeries *primarySeries() const;
136 QBar3DSeries *selectedSeries() const;
137 static QPoint invalidSelectionPosition() { return QPoint(-1, -1); }
138 void setSelectionMode(QtGraphs3D::SelectionFlags mode) override;
139
140 void handleAxisAutoAdjustRangeChangedInOrientation(QAbstract3DAxis::AxisOrientation orientation,
141 bool autoAdjust) override;
142 void handleSeriesVisibilityChangedBySender(QObject *sender) override;
143
144 void handleAxisRangeChangedBySender(QObject *sender) override;
145 void adjustAxisRanges() override;
146 void handleLightingModeChanged() override;
147
148 void setSelectedBar(QPoint coord, QBar3DSeries *series, bool enterSlice);
149
150 QList<QBar3DSeries *> barSeriesList();
151
152 bool isSeriesVisualsDirty() const { return m_isSeriesVisualsDirty; }
153 void setSeriesVisualsDirty(bool dirty) { m_isSeriesVisualsDirty = dirty; }
154 bool isDataDirty() const { return m_isDataDirty; }
155 void setDataDirty(bool dirty) { m_isDataDirty = dirty; }
156
157 void renderSliceToImage(int requestedIndex, QtGraphs3D::SliceCaptureType sliceType);
158 Q_REVISION(6, 10)
159 Q_INVOKABLE void renderSliceToImage(int requestedIndex, QtGraphs3D::SliceCaptureType sliceType,
160 const QUrl &filePath);
161
162protected:
163 void componentComplete() override;
164 void synchData() override;
165 void updateFloor();
166 void updateParameters();
167 void updateFloorLevel(float level);
168 void updateGraph() override;
169 void updateAxisRange(float min, float max) override;
170 void updateAxisReversed(bool enable) override;
171 void updateLightStrength() override;
172 void calculateSceneScalingFactors() override;
173 QVector3D calculateCategoryLabelPosition(QAbstract3DAxis *axis,
174 QVector3D labelPosition,
175 int index) override;
176 float calculateCategoryGridLinePosition(QAbstract3DAxis *axis, int index) override;
177 void createSliceView() override;
178 void toggleSliceGraph() override;
179 void handleLabelCountChanged(QQuick3DRepeater *repeater, QColor axisLabelColor) override;
180 void updateSelectionMode(QtGraphs3D::SelectionFlags mode) override;
181 bool doPicking(QPointF position) override;
182 bool doRayPicking(QVector3D origin, QVector3D direction) override;
183 QAbstract3DAxis *createDefaultAxis(QAbstract3DAxis::AxisOrientation orientation) override;
184 void updateSliceItemLabel(const QString &label, QVector3D position) override;
185
186 QQuick3DViewport* createOffscreenSliceView(int requestedIndex,
187 QtGraphs3D::SliceCaptureType sliceType);
188
189public Q_SLOTS:
190 void handleAxisXChanged(QAbstract3DAxis *axis) override;
191 void handleAxisYChanged(QAbstract3DAxis *axis) override;
192 void handleAxisZChanged(QAbstract3DAxis *axis) override;
193 void handleSeriesMeshChanged(QAbstract3DSeries::Mesh mesh);
194 void handleMeshSmoothChanged(bool enable);
195 void handleCameraRotationChanged();
196 void handleArrayReset();
197 void handleRowsAdded(qsizetype startIndex, qsizetype count);
198 void handleRowsChanged(qsizetype startIndex, qsizetype count);
199 void handleRowsRemoved(qsizetype startIndex, qsizetype count);
200 void handleRowsInserted(qsizetype startIndex, qsizetype count);
201 void handleItemChanged(qsizetype rowIndex, qsizetype columnIndex);
202 void handleDataRowLabelsChanged();
203 void handleDataColumnLabelsChanged();
204 void handleRowColorsChanged();
205 void handleValueColoringChanged();
206
207Q_SIGNALS:
208 void rowAxisChanged(QCategory3DAxis *axis);
209 void valueAxisChanged(QValue3DAxis *axis);
210 void columnAxisChanged(QCategory3DAxis *axis);
211 void multiSeriesUniformChanged(bool uniform);
212 void barThicknessChanged(float thicknessRatio);
213 void barSpacingChanged(QSizeF spacing);
214 void barSpacingRelativeChanged(bool relative);
215 void barSeriesMarginChanged(QSizeF margin);
216 void meshFileNameChanged(const QString &filename);
217 void primarySeriesChanged(QBar3DSeries *series);
218 void selectedSeriesChanged(QBar3DSeries *series);
219 void floorLevelChanged(float level);
220 Q_REVISION(6, 10)
221 void sliceImageChanged(const QImage &image);
222
223private:
224 enum SelectionType {
225 SelectionNone = 0,
226 SelectionItem,
227 SelectionRow,
228 SelectionColumn,
229 };
230
231 Bars3DChangeBitField m_changeTracker;
232 QList<ChangeItem> m_changedItems;
233 QList<ChangeRow> m_changedRows;
234
235 QBar3DSeries *m_primarySeries = nullptr;
236
237 bool m_isMultiSeriesUniform = false;
238 bool m_isBarSpecRelative = true;
239 float m_barThicknessRatio = 1.0f;
240 QSizeF m_barSpacing = QSizeF(1.0f, 1.0f);
241 float m_floorLevel = 0.0f;
242 QSizeF m_barSeriesMargin = QSizeF(0.0f, 0.0f);
243
244 qsizetype m_cachedRowCount = 0;
245 qsizetype m_cachedColumnCount = 0;
246 qsizetype m_minRow = 0;
247 qsizetype m_maxRow = 0;
248 qsizetype m_minCol = 0;
249 qsizetype m_maxCol = 0;
250 qsizetype m_newRows = 0;
251 qsizetype m_newCols = 0;
252
253 float m_maxSceneSize = 40.f;
254 float m_rowWidth = 0.0f;
255 float m_columnDepth = 0.0f;
256 float m_maxDimension = 0.0f;
257 float m_scaleFactor = 0.0f;
258 float m_xScaleFactor = 1.f;
259 float m_zScaleFactor = 1.f;
260
261 QSizeF m_cachedBarSeriesMargin = QSizeF(0.0f, 0.0f);
262 QSizeF m_cachedBarThickness = QSizeF(1.0f, 1.0f);
263 QSizeF m_cachedBarSpacing = QSizeF(1.0f, 1.0f);
264
265 float m_xScale = scale().x();
266 float m_yScale = scale().y();
267 float m_zScale = scale().z();
268
269 float m_vBackgroundMargin = 0.1f;
270 float m_hBackgroundMargin = 0.1f;
271
272 bool m_hasNegativeValues = false;
273 bool m_noZeroInRange = false;
274 float m_actualFloorLevel = 0.0f;
275 float m_heightNormalizer = 1.0f;
276 float m_backgroundAdjustment = 0.0f;
277
278 QQuick3DModel *m_floorBackground = nullptr;
279 QQuick3DNode *m_floorBackgroundScale = nullptr;
280 QQuick3DNode *m_floorBackgroundRotation = nullptr;
281
282 QBar3DSeries *m_selectedBarSeries = nullptr;
283 QPoint m_selectedBar = invalidSelectionPosition(); // Points to row & column in data window.
284 QVector3D m_selectedBarPos = QVector3D(0.0f, 0.0f, 0.0f);
285
286 struct BarModel
287 {
288 QQuick3DModel *model = nullptr;
289 QBarDataItem *barItem;
290 QPoint coord;
291 int visualIndex;
292 float heightValue;
293 QQuick3DTexture *texture;
294 BarInstancing *instancing = nullptr;
295 BarInstancing *selectionInstancing = nullptr;
296 QQuick3DModel *selectedModel = nullptr;
297 BarInstancing *multiSelectionInstancing = nullptr;
298 QQuick3DModel *multiSelectedModel = nullptr;
299 };
300
301 QHash<QBar3DSeries *, QList<BarModel *> *> m_barModelsMap;
302 QAbstract3DSeries::Mesh m_meshType = QAbstract3DSeries::Mesh::Sphere;
303 bool m_smooth = false;
304 bool m_keepSeriesUniform = false;
305 bool m_hasHighlightTexture = false;
306 float m_seriesScaleX = 0.0f;
307 float m_seriesScaleZ = 0.0f;
308 float m_seriesStep = 0.0f;
309 float m_seriesStart = 0.0f;
310 float m_zeroPosition = 0.0f;
311 int m_visibleSeriesCount = 0;
312 QQuick3DTexture *m_highlightTexture = nullptr;
313 QQuick3DTexture *m_multiHighlightTexture = nullptr;
314 QHash<QBar3DSeries *, QList<BarModel *>> m_slicedBarModels;
315 bool m_selectionDirty = false;
316 QImage *m_grabresult = nullptr;
317
318 void calculateHeightAdjustment();
319 void calculateSeriesStartPosition();
320 void connectSeries(QBar3DSeries *series);
321 void disconnectSeries(QBar3DSeries *series);
322 void generateBars(QList<QBar3DSeries *> &barSeriesList);
323 QQuick3DModel *createDataItem(QQuick3DNode *scene, QAbstract3DSeries *series);
324 QString getMeshFileName();
325 void fixMeshFileName(QString &fileName, QAbstract3DSeries::Mesh meshType);
326 void updateBarVisuality(QBar3DSeries *series, int visualIndex);
327 void updateBarPositions(QBar3DSeries *series);
328 float updateBarHeightParameters(const QBarDataItem *item);
329 void updateBarVisuals(QBar3DSeries *series);
330 void updateItemMaterial(QQuick3DModel *item,
331 bool useGradient,
332 bool rangeGradient,
333 const QString &materialName);
334 void updateMaterialProperties(QQuick3DModel *item,
335 const bool isHighlight,
336 const bool isMultiHighlight,
337 QQuick3DTexture *texture,
338 QColor color,
339 const bool transparency = false);
340 void removeBarModels();
341 void deleteBarModels(QQuick3DModel *model);
342 void deleteBarItemHolders(BarInstancing *instancing);
343 QQuick3DTexture *createTexture();
344 void updateSelectedBar();
345 SelectionType isSelected(int row, int bar, QBar3DSeries *series);
346 void resetClickedStatus();
347 void removeSlicedBarModels();
348 void createBarItemHolders(QBar3DSeries *series, QList<BarModel *> barList, bool slice);
349
350 void updateBarSpecs(float thicknessRatio, QSizeF spacing, bool relative);
351 void updateBarSeriesMargin(QSizeF margin);
352
353 void adjustSelectionPosition(QPoint &pos, const QBar3DSeries *series);
354
355 friend class Q3DBarsWidgetItem;
356 friend class QQuickGraphsBarsNode;
357};
358
359QT_END_NAMESPACE
360#endif // QQUICKGRAPHSBARS_H
361

source code of qtgraphs/src/graphs3d/qml/qquickgraphsbars_p.h