QAbstract3DGraph Class

The QAbstract3DGraph class provides a window and render loop for graphs. More...

Header: #include <QAbstract3DGraph>
CMake: find_package(Qt6 REQUIRED COMPONENTS DataVisualization)
target_link_libraries(mytarget PRIVATE Qt6::DataVisualization)
qmake: QT += datavisualization
Since: QtDataVisualization 1.0
Inherited By:

Q3DBars, Q3DScatter, and Q3DSurface

Public Types

enum ElementType { ElementNone, ElementSeries, ElementAxisXLabel, ElementAxisYLabel, ElementAxisZLabel, ElementCustomItem }
enum OptimizationHint { OptimizationDefault, OptimizationStatic }
flags OptimizationHints
enum SelectionFlag { SelectionNone, SelectionItem, SelectionRow, SelectionItemAndRow, SelectionColumn, …, SelectionMultiSeries }
flags SelectionFlags
enum ShadowQuality { ShadowQualityNone, ShadowQualityLow, ShadowQualityMedium, ShadowQualityHigh, ShadowQualitySoftLow, …, ShadowQualitySoftHigh }

Properties

Public Functions

virtual ~QAbstract3DGraph()
QAbstract3DInputHandler *activeInputHandler() const
Q3DTheme *activeTheme() const
qreal aspectRatio() const
void clearSelection()
qreal currentFps() const
QList<QCustom3DItem *> customItems() const
bool hasContext() const
qreal horizontalAspectRatio() const
QList<QAbstract3DInputHandler *> inputHandlers() const
bool isOrthoProjection() const
bool isPolar() const
bool isReflection() const
QLocale locale() const
qreal margin() const
bool measureFps() const
OptimizationHints optimizationHints() const
QVector3D queriedGraphPosition() const
float radialLabelOffset() const
qreal reflectivity() const
void removeCustomItems()
Q3DScene *scene() const
QAbstract3DAxis *selectedAxis() const
QCustom3DItem *selectedCustomItem() const
int selectedCustomItemIndex() const
ElementType selectedElement() const
int selectedLabelIndex() const
SelectionFlags selectionMode() const
void setActiveInputHandler()
void setActiveTheme()
void setAspectRatio()
void setHorizontalAspectRatio()
void setLocale()
void setMargin()
void setMeasureFps()
void setOptimizationHints()
void setOrthoProjection()
void setPolar()
void setRadialLabelOffset()
void setReflection()
void setReflectivity()
void setSelectionMode()
void setShadowQuality()
ShadowQuality shadowQuality() const
virtual bool shadowsSupported() const
QList<Q3DTheme *> themes() const

Signals

Detailed Description

This class subclasses a QWindow and provides render loop for graphs inheriting it.

You should not need to use this class directly, but one of its subclasses instead.

Anti-aliasing is turned on by default on C++, except in OpenGL ES2 environments, where anti-aliasing is not supported by Qt Data Visualization. To specify non-default anti-aliasing for a graph, give a custom surface format as a constructor parameter. You can use the convenience function qDefaultSurfaceFormat() to create the surface format object.

Note: QAbstract3DGraph sets window flag Qt::FramelessWindowHint on by default. If you want to display graph windows as standalone windows with regular window frame, clear this flag after constructing the graph. For example:

 Q3DBars *graphWindow = new Q3DBars;
 graphWindow->setFlags(graphWindow->flags() ^ Qt::FramelessWindowHint);

See also Q3DBars, Q3DScatter, Q3DSurface, and Qt Data Visualization C++ Classes.

Member Type Documentation

[since QtDataVisualization 1.1] enum QAbstract3DGraph::ElementType

Type of an element in the graph.

ConstantValueDescription
QAbstract3DGraph::ElementNone0No defined element.
QAbstract3DGraph::ElementSeries1A series (that is, an item in a series).
QAbstract3DGraph::ElementAxisXLabel2The x-axis label.
QAbstract3DGraph::ElementAxisYLabel3The y-axis label.
QAbstract3DGraph::ElementAxisZLabel4The z-axis label.
QAbstract3DGraph::ElementCustomItem5A custom item.

This enum was introduced in QtDataVisualization 1.1.

[since Qt Data Visualization 1.1] enum QAbstract3DGraph::OptimizationHint
flags QAbstract3DGraph::OptimizationHints

The optimization hint for rendering.

ConstantValueDescription
QAbstract3DGraph::OptimizationDefault0Provides the full feature set at a reasonable performance.
QAbstract3DGraph::OptimizationStatic1Optimizes the rendering of static data sets at the expense of some features.

This enum was introduced in Qt Data Visualization 1.1.

The OptimizationHints type is a typedef for QFlags<OptimizationHint>. It stores an OR combination of OptimizationHint values.

enum QAbstract3DGraph::SelectionFlag
flags QAbstract3DGraph::SelectionFlags

Item selection modes. Values of this enumeration can be combined with OR operator.

ConstantValueDescription
QAbstract3DGraph::SelectionNone0Selection mode disabled.
QAbstract3DGraph::SelectionItem1Selection highlights a single item.
QAbstract3DGraph::SelectionRow2Selection highlights a single row.
QAbstract3DGraph::SelectionItemAndRowSelectionItem | SelectionRowCombination flag for highlighting both item and row with different colors.
QAbstract3DGraph::SelectionColumn4Selection highlights a single column.
QAbstract3DGraph::SelectionItemAndColumnSelectionItem | SelectionColumnCombination flag for highlighting both item and column with different colors.
QAbstract3DGraph::SelectionRowAndColumnSelectionRow | SelectionColumnCombination flag for highlighting both row and column.
QAbstract3DGraph::SelectionItemRowAndColumnSelectionItem | SelectionRow | SelectionColumnCombination flag for highlighting item, row, and column.
QAbstract3DGraph::SelectionSlice8Setting this mode flag indicates that the graph should take care of the slice view handling automatically. If you wish to control the slice view yourself via Q3DScene, do not set this flag. When setting this mode flag, either SelectionRow or SelectionColumn must also be set, but not both. Slicing is supported by Q3DBars and Q3DSurface only. When this flag is set, slice mode is entered in the following situations:
  • When selection is changed explicitly via series API to a visible item
  • When selection is changed by clicking on the graph
  • When the selection mode changes and the selected item is visible
QAbstract3DGraph::SelectionMultiSeries16Setting this mode means that items for all series at same position are highlighted, instead of just the selected item. The actual selection in the other series doesn't change. When setting this mode flag, one or more of the basic selection flags (SelectionItem, SelectionRow, or SelectionColumn) must also be set. Multi-series selection is not supported for Q3DScatter.

The SelectionFlags type is a typedef for QFlags<SelectionFlag>. It stores an OR combination of SelectionFlag values.

enum QAbstract3DGraph::ShadowQuality

Quality of shadows.

ConstantValueDescription
QAbstract3DGraph::ShadowQualityNone0Shadows are disabled.
QAbstract3DGraph::ShadowQualityLow1Shadows are rendered in low quality.
QAbstract3DGraph::ShadowQualityMedium2Shadows are rendered in medium quality.
QAbstract3DGraph::ShadowQualityHigh3Shadows are rendered in high quality.
QAbstract3DGraph::ShadowQualitySoftLow4Shadows are rendered in low quality with softened edges.
QAbstract3DGraph::ShadowQualitySoftMedium5Shadows are rendered in medium quality with softened edges.
QAbstract3DGraph::ShadowQualitySoftHigh6Shadows are rendered in high quality with softened edges.

Property Documentation

activeInputHandler : QAbstract3DInputHandler*

This property holds the active input handler used in the graph.

Access functions:

QAbstract3DInputHandler *activeInputHandler() const
void setActiveInputHandler()

Notifier signal:

void activeInputHandlerChanged()

activeTheme : Q3DTheme*

This property holds the active theme of the graph.

Access functions:

Q3DTheme *activeTheme() const
void setActiveTheme()

Notifier signal:

void activeThemeChanged()

[since QtDataVisualization 1.1] aspectRatio : qreal

This property holds the ratio of the graph scaling between the longest axis on the horizontal plane and the y-axis.

Defaults to 2.0.

Note: Has no effect on Q3DBars.

This property was introduced in QtDataVisualization 1.1.

Access functions:

qreal aspectRatio() const
void setAspectRatio()

Notifier signal:

void aspectRatioChanged()

See also horizontalAspectRatio.

[read-only, since QtDataVisualization 1.1] currentFps : const qreal

This property holds the rendering results for the last second.

The results are stored in this read-only property when FPS measuring is enabled. It takes at least a second before this value is updated after measuring is activated.

This property was introduced in QtDataVisualization 1.1.

Access functions:

qreal currentFps() const

Notifier signal:

void currentFpsChanged()

See also measureFps.

[since QtDataVisualization 1.2] horizontalAspectRatio : qreal

This property holds the ratio of the graph scaling between the x-axis and z-axis.

The value of 0.0 indicates automatic scaling according to axis ranges. Defaults to 0.0.

Has no effect on Q3DBars, which handles scaling on the horizontal plane via the barThickness and barSpacing properties. Polar graphs also ignore this property.

This property was introduced in QtDataVisualization 1.2.

Access functions:

qreal horizontalAspectRatio() const
void setHorizontalAspectRatio()

Notifier signal:

void horizontalAspectRatioChanged()

See also aspectRatio, polar, Q3DBars::barThickness, and Q3DBars::barSpacing.

[since QtDataVisualization 1.2] locale : QLocale

This property holds the locale used for formatting various numeric labels.

Defaults to the "C" locale.

This property was introduced in QtDataVisualization 1.2.

Access functions:

QLocale locale() const
void setLocale()

Notifier signal:

void localeChanged()

See also QValue3DAxis::labelFormat.

[since QtDataVisualization 1.2] margin : qreal

This property holds the absolute value used for the space left between the edge of the plottable graph area and the edge of the graph background.

If the margin value is negative, the margins are determined automatically and can vary according to the size of the items in the series and the type of the graph. The value is interpreted as a fraction of the y-axis range if the graph aspect ratios have not beed changed from the default values. Defaults to -1.0.

Note: Setting a smaller margin for a scatter graph than the automatically determined margin can cause the scatter items at the edges of the graph to overlap with the graph background.

Note: On scatter and surface graphs, if the margin is small in comparison to the axis label size, the positions of the edge labels of the axes are adjusted to avoid overlap with the edge labels of the neighboring axes.

This property was introduced in QtDataVisualization 1.2.

Access functions:

qreal margin() const
void setMargin()

Notifier signal:

void marginChanged()

[since QtDataVisualization 1.1] measureFps : bool

This property holds whether rendering is done continuously instead of on demand.

If true, rendering is continuous and the value of the currentFps property is updated. Defaults to false.

This property was introduced in QtDataVisualization 1.1.

Access functions:

bool measureFps() const
void setMeasureFps()

Notifier signal:

void measureFpsChanged()

See also currentFps.

optimizationHints : OptimizationHints

This property holds whether the default or static mode is used for rendering optimization.

The default mode provides the full feature set at a reasonable level of performance. The static mode optimizes graph rendering and is ideal for large non-changing data sets. It is slower with dynamic data changes and item rotations. Selection is not optimized, so using the static mode with massive data sets is not advisable. Static optimization works only on scatter graphs. Defaults to OptimizationDefault.

Note: On some environments, large graphs using static optimization may not render, because all of the items are rendered using a single draw call, and different graphics drivers support different maximum vertice counts per call. This is mostly an issue on 32bit and OpenGL ES2 platforms. To work around this issue, choose an item mesh with a low vertex count or use the point mesh.

Access functions:

OptimizationHints optimizationHints() const
void setOptimizationHints()

Notifier signal:

void optimizationHintsChanged()

See also QAbstract3DSeries::mesh.

[since QtDataVisualization 1.1] orthoProjection : bool

This property holds whether orthographic projection is used for displaying the graph.

Defaults to false.

Note: Shadows will be disabled when set to true.

This property was introduced in QtDataVisualization 1.1.

Access functions:

bool isOrthoProjection() const
void setOrthoProjection()

Notifier signal:

void orthoProjectionChanged()

See also QAbstract3DAxis::labelAutoRotation and Q3DCamera::cameraPreset.

[since QtDataVisualization 1.2] polar : bool

This property holds whether horizontal axes are changed into polar axes.

If true, the x-axis becomes the angular axis and the z-axis becomes the radial axis. Polar mode is not available for bar graphs.

Defaults to false.

This property was introduced in QtDataVisualization 1.2.

Access functions:

bool isPolar() const
void setPolar()

Notifier signal:

void polarChanged()

See also orthoProjection and radialLabelOffset.

[read-only, since QtDataVisualization 1.2] queriedGraphPosition : const QVector3D

This property holds the latest queried graph position values along each axis.

This read-only property contains the results from Q3DScene::graphPositionQuery. The values are normalized to the range [-1, 1]. If the queried position was outside the graph bounds, the values will not reflect the real position, but will instead indicate an undefined position outside the range [-1, 1]. The value will be undefined until a query is made.

There is no single correct 3D coordinate to match a particular screen position, so to be consistent, the queries are always done against the inner sides of an invisible box surrounding the graph.

Note: Bar graphs only allow querying graph position at the graph floor level, so the y-value is always zero for bar graphs and the valid queries can be only made at screen positions that contain the floor of the graph.

This property was introduced in QtDataVisualization 1.2.

Access functions:

QVector3D queriedGraphPosition() const

Notifier signal:

void queriedGraphPositionChanged()

See also Q3DScene::graphPositionQuery.

[since QtDataVisualization 1.2] radialLabelOffset : float

This property holds the normalized horizontal offset for the axis labels of the radial polar axis.

The value 0.0 indicates that the labels should be drawn next to the 0-angle angular axis grid line. The value 1.0 indicates that the labels are drawn in their usual place at the edge of the graph background. Defaults to 1.0.

This property is ignored if the polar property value is false.

This property was introduced in QtDataVisualization 1.2.

Access functions:

float radialLabelOffset() const
void setRadialLabelOffset()

Notifier signal:

void radialLabelOffsetChanged()

See also polar.

[since QtDataVisualization 1.2] reflection : bool

This property holds whether floor reflections are on or off.

Defaults to false.

Affects only Q3DBars. However, in Q3DBars graphs holding both positive and negative values, reflections are not supported for custom items that intersect the floor plane. In that case, reflections should be turned off to avoid incorrect rendering.

If using a custom surface format, the stencil buffer needs to be defined (QSurfaceFormat::setStencilBufferSize()) for reflections to work.

This property was introduced in QtDataVisualization 1.2.

Access functions:

bool isReflection() const
void setReflection()

Notifier signal:

void reflectionChanged()

See also reflectivity.

[since QtDataVisualization 1.2] reflectivity : qreal

Floor reflectivity.

Larger numbers make the floor more reflective. The valid range is [0...1]. Defaults to 0.5.

Note: Affects only Q3DBars.

This property was introduced in QtDataVisualization 1.2.

Access functions:

qreal reflectivity() const
void setReflectivity()

Notifier signal:

void reflectivityChanged()

See also reflection.

[read-only] scene : Q3DScene* const

This property holds the Q3DScene pointer that can be used to manipulate the scene and access the scene elements, such as the active camera.

This property is read-only.

Access functions:

Q3DScene *scene() const

[read-only, since QtDataVisualization 1.1] selectedElement : const ElementType

This property holds the element selected in the graph.

This property can be used to query the selected element type. The type is valid until a new selection is made in the graph and the selectedElementChanged signal is emitted.

The signal can be used for example for implementing custom input handlers, as demonstrated in the Graph Gallery example under Scatter Graph tab.

This property was introduced in QtDataVisualization 1.1.

Access functions:

ElementType selectedElement() const

Notifier signal:

void selectedElementChanged()

See also selectedLabelIndex(), selectedAxis(), selectedCustomItemIndex(), selectedCustomItem(), Q3DBars::selectedSeries(), Q3DScatter::selectedSeries(), Q3DSurface::selectedSeries(), and Q3DScene::setSelectionQueryPosition().

selectionMode : SelectionFlags

Item selection mode.

A combination of SelectionFlags. By default, SelectionItem. Different graph types support different selection modes.

Access functions:

SelectionFlags selectionMode() const
void setSelectionMode()

Notifier signal:

void selectionModeChanged()

See also SelectionFlags.

shadowQuality : ShadowQuality

This property holds the quality of the shadow.

One of the ShadowQuality enum values. By default, ShadowQualityMedium.

Note: If setting the shadow quality to a certain level fails, the level is lowered until it is successfully set. The shadowQualityChanged signal is emitted each time a change is made.

Access functions:

ShadowQuality shadowQuality() const
void setShadowQuality()

Notifier signal:

void shadowQualityChanged()

See also ShadowQuality.

Member Function Documentation

[virtual] QAbstract3DGraph::~QAbstract3DGraph()

Destroys QAbstract3DGraph.

void QAbstract3DGraph::clearSelection()

Clears selection from all attached series.

[since QtDataVisualization 1.2] QList<QCustom3DItem *> QAbstract3DGraph::customItems() const

Returns the list of all added custom items.

This function was introduced in QtDataVisualization 1.2.

See also addCustomItem().

bool QAbstract3DGraph::hasContext() const

Returns true if the OpenGL context of the graph has been successfully initialized. Trying to use a graph when the context initialization has failed typically results in a crash. A common reason for a context initialization failure is lack of sufficient platform support for OpenGL.

QList<QAbstract3DInputHandler *> QAbstract3DGraph::inputHandlers() const

Returns the list of all added input handlers.

See also addInputHandler().

[since QtDataVisualization 1.1] void QAbstract3DGraph::removeCustomItems()

Removes all custom items. Deletes the resources allocated to them.

This function was introduced in QtDataVisualization 1.1.

[since QtDataVisualization 1.1] QAbstract3DAxis *QAbstract3DGraph::selectedAxis() const

Can be used to get the selected axis after receiving selectedElementChanged signal with any label type. Selection is valid until the next selectedElementChanged signal.

Returns the pointer to the selected axis, or null.

This function was introduced in QtDataVisualization 1.1.

See also selectedElement.

[since QtDataVisualization 1.1] QCustom3DItem *QAbstract3DGraph::selectedCustomItem() const

Can be used to get the selected custom item after receiving selectedElementChanged signal with QAbstract3DGraph::ElementCustomItem type. Ownership of the item remains with the graph. Selection is valid until the next selectedElementChanged signal.

Returns the pointer to the selected custom item, or null.

This function was introduced in QtDataVisualization 1.1.

See also selectedElement.

[since QtDataVisualization 1.1] int QAbstract3DGraph::selectedCustomItemIndex() const

Can be used to query the index of the selected custom item after receiving selectedElementChanged signal with QAbstract3DGraph::ElementCustomItem type. Selection is valid until the next selectedElementChanged signal.

Returns the index of the selected custom item, or -1.

This function was introduced in QtDataVisualization 1.1.

See also selectedElement.

[since QtDataVisualization 1.1] int QAbstract3DGraph::selectedLabelIndex() const

Can be used to query the index of the selected label after receiving selectedElementChanged signal with any label type. Selection is valid until the next selectedElementChanged signal.

Returns the index of the selected label, or -1.

This function was introduced in QtDataVisualization 1.1.

See also selectedElement.

[virtual] bool QAbstract3DGraph::shadowsSupported() const

Returns true if shadows are supported with the current configuration. OpenGL ES2 configurations do not support shadows.

QList<Q3DTheme *> QAbstract3DGraph::themes() const

Returns the list of all added themes.

See also addTheme().