QAbstract3DGraph Class | Qt Graphs 6.8.0
Description: The QAbstract3DGraph class provides a window and render loop for graphs.

- Qt 6.8
- Qt Graphs
- C++ Classes
- QtGraphs
- QAbstract3DGraph
- Qt Graphs | Commercial or GPLv3

# QAbstract3DGraph Class

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

Header: | #include <QAbstract3DGraph>
CMake: | find_package(Qt6 REQUIRED COMPONENTS Graphs) target_link_libraries(mytarget PRIVATE Qt6::Graphs)
qmake: | QT += graphs
Inherits: | QQuickWidget
Inherited By: | Q3DBars, Q3DScatter, and Q3DSurface

- List of all members, including inherited members
- QAbstract3DGraph is part of Qt Graphs C++ Classes for 3D.

## Public Types

enum class | CameraPreset { NoPreset, FrontLow, Front, FrontHigh, LeftLow, …, DirectlyBelow }
enum class | ElementType { None, Series, AxisXLabel, AxisYLabel, AxisZLabel, CustomItem }
enum class | OptimizationHint { Default, Legacy }
enum | SelectionFlag { SelectionNone, SelectionItem, SelectionRow, SelectionItemAndRow, SelectionColumn, …, SelectionMultiSeries }
flags | SelectionFlags
enum class | ShadowQuality { None, Low, Medium, High, SoftLow, …, SoftHigh }

## Properties

activeTheme : Q3DTheme* aspectRatio : qreal cameraTargetPosition : QVector3D cameraXRotation : float cameraYRotation : float cameraZoomLevel : float currentFps : const int horizontalAspectRatio : qreal locale : QLocale margin : qreal maxCameraXRotation : float maxCameraYRotation : float maxCameraZoomLevel : float measureFps : bool minCameraXRotation : float minCameraYRotation : float minCameraZoomLevel : float | msaaSamples : int optimizationHint : QAbstract3DGraph::OptimizationHint orthoProjection : bool polar : bool queriedGraphPosition : const QVector3D radialLabelOffset : float rotationEnabled : bool scene : Q3DScene* const selectedElement : const QAbstract3DGraph::ElementType selectionEnabled : bool selectionMode : QAbstract3DGraph::SelectionFlags shadowQuality : QAbstract3DGraph::ShadowQuality wrapCameraXRotation : bool wrapCameraYRotation : bool zoomAtTargetEnabled : bool zoomEnabled : bool

## Public Functions

virtual | ~QAbstract3DGraph()
Q3DTheme * | activeTheme() const
int | addCustomItem(QCustom3DItem *item)
void | addTheme(Q3DTheme *theme)
qreal | aspectRatio() const
QAbstract3DGraph::CameraPreset | cameraPreset() const
QVector3D | cameraTargetPosition()
float | cameraXRotation()
float | cameraYRotation()
float | cameraZoomLevel()
void | clearSelection()
int | currentFps() const
QList<QCustom3DItem *> | customItems() const
bool | hasSeries(QAbstract3DSeries *series) const
qreal | horizontalAspectRatio() const
bool | isOrthoProjection() const
bool | isPolar() const
QLocale | locale() const
qreal | margin() const
float | maxCameraXRotation()
float | maxCameraYRotation()
float | maxCameraZoomLevel()
bool | measureFps() const
float | minCameraXRotation()
float | minCameraYRotation()
float | minCameraZoomLevel()
int | msaaSamples() const
QAbstract3DGraph::OptimizationHint | optimizationHint() const
QVector3D | queriedGraphPosition() const
float | radialLabelOffset() const
void | releaseCustomItem(QCustom3DItem *item)
void | releaseTheme(Q3DTheme *theme)
void | removeCustomItem(QCustom3DItem *item)
void | removeCustomItemAt(const QVector3D &position)
void | removeCustomItems()
QSharedPointer<QQuickItemGrabResult> | renderToImage(const QSize &imageSize = QSize())
bool | rotationEnabled()
Q3DScene * | scene() const
QAbstract3DAxis * | selectedAxis() const
QCustom3DItem * | selectedCustomItem() const
int | selectedCustomItemIndex() const
QAbstract3DGraph::ElementType | selectedElement() const
int | selectedLabelIndex() const
bool | selectionEnabled()
QAbstract3DGraph::SelectionFlags | selectionMode() const
void | setActiveTheme(Q3DTheme *activeTheme)
void | setAspectRatio(qreal ratio)
void | setCameraPosition(float horizontal, float vertical, float zoom = 100.0f)
void | setCameraPreset(QAbstract3DGraph::CameraPreset preset)
void | setCameraTargetPosition(const QVector3D &target)
void | setCameraXRotation(float rotation)
void | setCameraYRotation(float rotation)
void | setCameraZoomLevel(float level)
void | setHorizontalAspectRatio(qreal ratio)
void | setLocale(const QLocale &locale)
void | setMargin(qreal margin)
void | setMaxCameraXRotation(float rotation)
void | setMaxCameraYRotation(float rotation)
void | setMaxCameraZoomLevel(float level)
void | setMeasureFps(bool enable)
void | setMinCameraXRotation(float rotation)
void | setMinCameraYRotation(float rotation)
void | setMinCameraZoomLevel(float level)
void | setMsaaSamples(int samples)
void | setOptimizationHint(QAbstract3DGraph::OptimizationHint hint)
void | setOrthoProjection(bool enable)
void | setPolar(bool enable)
void | setRadialLabelOffset(float offset)
void | setRotationEnabled(bool enable)
void | setSelectionEnabled(bool enable)
void | setSelectionMode(const QAbstract3DGraph::SelectionFlags &selectionMode)
void | setShadowQuality(const QAbstract3DGraph::ShadowQuality &shadowQuality)
void | setWrapCameraXRotation(bool wrap)
void | setWrapCameraYRotation(bool wrap)
void | setZoomAtTargetEnabled(bool enable)
void | setZoomEnabled(bool enable)
QAbstract3DGraph::ShadowQuality | shadowQuality() const
QList<Q3DTheme *> | themes() const
bool | wrapCameraXRotation()
bool | wrapCameraYRotation()
bool | zoomAtTargetEnabled()
bool | zoomEnabled()

## Signals

void | activeThemeChanged(Q3DTheme *activeTheme)
void | aspectRatioChanged(qreal ratio)
void | cameraPresetChanged(QAbstract3DGraph::CameraPreset preset)
void | cameraTargetPositionChanged(const QVector3D &target)
void | cameraXRotationChanged(float rotation)
void | cameraYRotationChanged(float rotation)
void | cameraZoomLevelChanged(float zoomLevel)
void | currentFpsChanged(int fps)
void | horizontalAspectRatioChanged(qreal ratio)
void | localeChanged(const QLocale &locale)
void | marginChanged(qreal margin)
void | maxCameraXRotationChanged(float rotation)
void | maxCameraYRotationChanged(float rotation)
void | maxCameraZoomLevelChanged(float zoomLevel)
void | measureFpsChanged(bool enabled)
void | minCameraXRotationChanged(float rotation)
void | minCameraYRotationChanged(float rotation)
void | minCameraZoomLevelChanged(float zoomLevel)
void | msaaSamplesChanged(int samples)
void | optimizationHintChanged(QAbstract3DGraph::OptimizationHint hint)
void | orthoProjectionChanged(bool enabled)
void | polarChanged(bool enabled)
void | queriedGraphPositionChanged(const QVector3D &data)
void | radialLabelOffsetChanged(float offset)
void | rotationEnabledChanged(bool enable)
void | selectedElementChanged(QAbstract3DGraph::ElementType type)
void | selectionEnabledChanged(bool enable)
void | selectionModeChanged(const QAbstract3DGraph::SelectionFlags selectionMode)
void | shadowQualityChanged(QAbstract3DGraph::ShadowQuality quality)
void | wrapCameraXRotationChanged(bool wrap)
void | wrapCameraYRotationChanged(bool wrap)
void | zoomAtTargetEnabledChanged(bool enable)
void | zoomEnabledChanged(bool enable)

## Related Non-Members

QSurfaceFormat | qDefaultSurfaceFormat(bool antialias)

## 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 Graphs. 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 Graphs C++ Classes for 3D.

## Member Type Documentation

### enum class QAbstract3DGraph::CameraPreset

Predefined positions for camera.

Constant | Value | Description
--- | --- | ---
`QAbstract3DGraph::CameraPreset::NoPreset` | `0` | Used to indicate a preset has not been set, or the scene has been rotated freely.
`QAbstract3DGraph::CameraPreset::FrontLow` | `1` |
`QAbstract3DGraph::CameraPreset::Front` | `2` |
`QAbstract3DGraph::CameraPreset::FrontHigh` | `3` |
`QAbstract3DGraph::CameraPreset::LeftLow` | `4` |
`QAbstract3DGraph::CameraPreset::Left` | `5` |
`QAbstract3DGraph::CameraPreset::LeftHigh` | `6` |
`QAbstract3DGraph::CameraPreset::RightLow` | `7` |
`QAbstract3DGraph::CameraPreset::Right` | `8` |
`QAbstract3DGraph::CameraPreset::RightHigh` | `9` |
`QAbstract3DGraph::CameraPreset::BehindLow` | `10` |
`QAbstract3DGraph::CameraPreset::Behind` | `11` |
`QAbstract3DGraph::CameraPreset::BehindHigh` | `12` |
`QAbstract3DGraph::CameraPreset::IsometricLeft` | `13` |
`QAbstract3DGraph::CameraPreset::IsometricLeftHigh` | `14` |
`QAbstract3DGraph::CameraPreset::IsometricRight` | `15` |
`QAbstract3DGraph::CameraPreset::IsometricRightHigh` | `16` |
`QAbstract3DGraph::CameraPreset::DirectlyAbove` | `17` |
`QAbstract3DGraph::CameraPreset::DirectlyAboveCW45` | `18` |
`QAbstract3DGraph::CameraPreset::DirectlyAboveCCW45` | `19` |
`QAbstract3DGraph::CameraPreset::FrontBelow` | `20` | In Q3DBars from FrontBelow onward these only work for graphs including negative values. They act as Preset...Low for positive-only values.
`QAbstract3DGraph::CameraPreset::LeftBelow` | `21` |
`QAbstract3DGraph::CameraPreset::RightBelow` | `22` |
`QAbstract3DGraph::CameraPreset::BehindBelow` | `23` |
`QAbstract3DGraph::CameraPreset::DirectlyBelow` | `24` | Acts as FrontLow for positive-only bars.

### enum class QAbstract3DGraph::ElementType

Type of an element in the graph.

Constant | Value | Description
--- | --- | ---
`QAbstract3DGraph::ElementType::None` | `0` | No defined element.
`QAbstract3DGraph::ElementType::Series` | `1` | An item in a series.
`QAbstract3DGraph::ElementType::AxisXLabel` | `2` | The x-axis label.
`QAbstract3DGraph::ElementType::AxisYLabel` | `3` | The y-axis label.
`QAbstract3DGraph::ElementType::AxisZLabel` | `4` | The z-axis label.
`QAbstract3DGraph::ElementType::CustomItem` | `5` | A custom item.

### enum class QAbstract3DGraph::OptimizationHint

The optimization hint for rendering.

Constant | Value | Description
--- | --- | ---
`QAbstract3DGraph::OptimizationHint::Default` | `0` | Provides the full feature set with instancing at a good performance.
`QAbstract3DGraph::OptimizationHint::Legacy` | `1` | Provides the full feature set at a reasonable performance. To be used if OptimizationHint.Default performs poorly or does not work.

### enum QAbstract3DGraph::SelectionFlag
flags QAbstract3DGraph::SelectionFlags

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

Constant | Value | Description
--- | --- | ---
`QAbstract3DGraph::SelectionNone` | `0` | Selection mode disabled.
`QAbstract3DGraph::SelectionItem` | `1` | Selection highlights a single item.
`QAbstract3DGraph::SelectionRow` | `2` | Selection highlights a single row.
`QAbstract3DGraph::SelectionItemAndRow` | `SelectionItem | SelectionRow` | Combination flag for highlighting both item and row with different colors.
`QAbstract3DGraph::SelectionColumn` | `4` | Selection highlights a single column.
`QAbstract3DGraph::SelectionItemAndColumn` | `SelectionItem | SelectionColumn` | Combination flag for highlighting both item and column with different colors.
`QAbstract3DGraph::SelectionRowAndColumn` | `SelectionRow | SelectionColumn` | Combination flag for highlighting both row and column.
`QAbstract3DGraph::SelectionItemRowAndColumn` | `SelectionItem | SelectionRow | SelectionColumn` | Combination flag for highlighting item, row, and column.
`QAbstract3DGraph::SelectionSlice` | `8` | Setting 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::SelectionMultiSeries` | `16` | Setting 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 class QAbstract3DGraph::ShadowQuality

Quality of shadows.

Constant | Value | Description
--- | --- | ---
`QAbstract3DGraph::ShadowQuality::None` | `0` | Shadows are disabled.
`QAbstract3DGraph::ShadowQuality::Low` | `1` | Shadows are rendered in low quality.
`QAbstract3DGraph::ShadowQuality::Medium` | `2` | Shadows are rendered in medium quality.
`QAbstract3DGraph::ShadowQuality::High` | `3` | Shadows are rendered in high quality.
`QAbstract3DGraph::ShadowQuality::SoftLow` | `4` | Shadows are rendered in low quality with softened edges.
`QAbstract3DGraph::ShadowQuality::SoftMedium` | `5` | Shadows are rendered in medium quality with softened edges.
`QAbstract3DGraph::ShadowQuality::SoftHigh` | `6` | Shadows are rendered in high quality with softened edges.

## Property Documentation

### activeTheme : Q3DTheme*

This property holds the active theme of the graph.

Sets activeTheme as the active theme to be used for the graph. Implicitly calls addTheme() to transfer the ownership of the theme to this graph.

If activeTheme is null, a temporary default theme is created. This temporary theme is destroyed if any theme is explicitly set later. Properties of the theme can be modified even after setting it, and the modifications take effect immediately.

Access functions:

Q3DTheme * | activeTheme() const
void | setActiveTheme(Q3DTheme *activeTheme)

Notifier signal:

void | activeThemeChanged(Q3DTheme *activeTheme)

### 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.

Access functions:

qreal | aspectRatio() const
void | setAspectRatio(qreal ratio)

Notifier signal:

void | aspectRatioChanged(qreal ratio)

See also horizontalAspectRatio.

### cameraTargetPosition : QVector3D

This property holds the camera target position as a vector or vertex in the 3D space.

Defaults to `QVector3D(0.0, 0.0, 0.0)`.

Valid coordinate values are between `-1.0...1.0`, where the edge values indicate the edges of the corresponding axis range. Any values outside this range are clamped to the edge.

Note: For bar graphs, the Y-coordinate is ignored and camera always targets a point on the horizontal background.

Access functions:

QVector3D | cameraTargetPosition()
void | setCameraTargetPosition(const QVector3D &target)

Notifier signal:

void | cameraTargetPositionChanged(const QVector3D &target)

### cameraXRotation : float

This property holds the X-rotation angle of the camera around the target point in degrees.

Access functions:

float | cameraXRotation()
void | setCameraXRotation(float rotation)

Notifier signal:

void | cameraXRotationChanged(float rotation)

### cameraYRotation : float

This property holds the Y-rotation angle of the camera around the target point in degrees.

Access functions:

float | cameraYRotation()
void | setCameraYRotation(float rotation)

Notifier signal:

void | cameraYRotationChanged(float rotation)

### cameraZoomLevel : float

This property holds the camera zoom level in percentage.

The default value of `100.0f` means there is no zoom in or out set in the camera. The value is limited by the minCameraZoomLevel and maxCameraZoomLevel properties.

Access functions:

float | cameraZoomLevel()
void | setCameraZoomLevel(float level)

Notifier signal:

void | cameraZoomLevelChanged(float zoomLevel)

See also minCameraZoomLevel and maxCameraZoomLevel.

### `[read-only]` currentFps : const int

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.

Access functions:

int | currentFps() const

Notifier signal:

void | currentFpsChanged(int fps)

See also measureFps.

### 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.

Access functions:

qreal | horizontalAspectRatio() const
void | setHorizontalAspectRatio(qreal ratio)

Notifier signal:

void | horizontalAspectRatioChanged(qreal ratio)

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

### locale : QLocale

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

Defaults to the `"C"` locale.

Access functions:

QLocale | locale() const
void | setLocale(const QLocale &locale)

Notifier signal:

void | localeChanged(const QLocale &locale)

See also QValue3DAxis::labelFormat.

### 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.

Access functions:

qreal | margin() const
void | setMargin(qreal margin)

Notifier signal:

void | marginChanged(qreal margin)

### maxCameraXRotation : float

This property holds the maximum X-rotation angle of the camera around the target point in degrees.

Access functions:

float | maxCameraXRotation()
void | setMaxCameraXRotation(float rotation)

Notifier signal:

void | maxCameraXRotationChanged(float rotation)

### maxCameraYRotation : float

This property holds the maximum Y-rotation angle of the camera around the target point in degrees.

Access functions:

float | maxCameraYRotation()
void | setMaxCameraYRotation(float rotation)

Notifier signal:

void | maxCameraYRotationChanged(float rotation)

### maxCameraZoomLevel : float

This property holds the maximum allowed camera zoom level.

If the maximum level is set to a new value that is lower than the existing minimum level, the minimum level is adjusted to the new maximum as well. If the current cameraZoomLevel is outside the new bounds, it is adjusted as well. Defaults to `500.0f`.

Access functions:

float | maxCameraZoomLevel()
void | setMaxCameraZoomLevel(float level)

Notifier signal:

void | maxCameraZoomLevelChanged(float zoomLevel)

See also cameraZoomLevel and minCameraZoomLevel.

### 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`.

Access functions:

bool | measureFps() const
void | setMeasureFps(bool enable)

Notifier signal:

void | measureFpsChanged(bool enabled)

See also currentFps.

### minCameraXRotation : float

This property holds the minimum X-rotation angle of the camera around the target point in degrees.

Access functions:

float | minCameraXRotation()
void | setMinCameraXRotation(float rotation)

Notifier signal:

void | minCameraXRotationChanged(float rotation)

### minCameraYRotation : float

This property holds the minimum Y-rotation angle of the camera around the target point in degrees.

Access functions:

float | minCameraYRotation()
void | setMinCameraYRotation(float rotation)

Notifier signal:

void | minCameraYRotationChanged(float rotation)

### minCameraZoomLevel : float

This property holds the minimum allowed camera zoom level.

If the minimum level is set to a new value that is higher than the existing maximum level, the maximum level is adjusted to the new minimum as well. If the current zoomLevel is outside the new bounds, it is adjusted as well. The minCameraZoomLevel cannot be set below `1.0f`. Defaults to `10.0f`.

Access functions:

float | minCameraZoomLevel()
void | setMinCameraZoomLevel(float level)

Notifier signal:

void | minCameraZoomLevelChanged(float zoomLevel)

See also cameraZoomLevel and maxCameraZoomLevel.

### msaaSamples : int

This property holds the number of used samples in MSAA.

Sets the number of used MSAA samples to samples. The number of samples can be either 0, 2, 4, or 8.

Access functions:

int | msaaSamples() const
void | setMsaaSamples(int samples)

Notifier signal:

void | msaaSamplesChanged(int samples)

### optimizationHint : QAbstract3DGraph::OptimizationHint

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

The default mode uses instanced rendering, and provides the full feature set at the best level of performance on most systems. 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. Legacy mode renders all items in th graph individually, without instancing. It should be used only if default mode does not work, i.e. if the target system does not support instancing. Defaults to Default.

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:

QAbstract3DGraph::OptimizationHint | optimizationHint() const
void | setOptimizationHint(QAbstract3DGraph::OptimizationHint hint)

Notifier signal:

void | optimizationHintChanged(QAbstract3DGraph::OptimizationHint hint)

See also QAbstract3DSeries::mesh.

### 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`.

Access functions:

bool | isOrthoProjection() const
void | setOrthoProjection(bool enable)

Notifier signal:

void | orthoProjectionChanged(bool enabled)

See also QAbstract3DAxis::labelAutoRotation.

### 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`.

Access functions:

bool | isPolar() const
void | setPolar(bool enable)

Notifier signal:

void | polarChanged(bool enabled)

See also orthoProjection and radialLabelOffset.

### `[read-only]` 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.

Access functions:

QVector3D | queriedGraphPosition() const

Notifier signal:

void | queriedGraphPositionChanged(const QVector3D &data)

See also Q3DScene::graphPositionQuery.

### 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`.

Access functions:

float | radialLabelOffset() const
void | setRadialLabelOffset(float offset)

Notifier signal:

void | radialLabelOffsetChanged(float offset)

See also polar.

### rotationEnabled : bool

This property holds whether this input handler allows graph rotation.

Defaults to `true`.

Access functions:

bool | rotationEnabled()
void | setRotationEnabled(bool enable)

Notifier signal:

void | rotationEnabledChanged(bool enable)

### `[read-only]` scene : Q3DScene* const

This property holds the Q3DScene pointer that can be used to manipulate the scene and access the scene elements.

This property is read-only.

Access functions:

Q3DScene * | scene() const

### `[read-only]` selectedElement : const QAbstract3DGraph::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.

Access functions:

QAbstract3DGraph::ElementType | selectedElement() const

Notifier signal:

void | selectedElementChanged(QAbstract3DGraph::ElementType type)

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

### selectionEnabled : bool

This property holds whether this input handler allows selection from the graph.

Defaults to `true`.

Access functions:

bool | selectionEnabled()
void | setSelectionEnabled(bool enable)

Notifier signal:

void | selectionEnabledChanged(bool enable)

### selectionMode : QAbstract3DGraph::SelectionFlags

Item selection mode.

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

Access functions:

QAbstract3DGraph::SelectionFlags | selectionMode() const
void | setSelectionMode(const QAbstract3DGraph::SelectionFlags &selectionMode)

Notifier signal:

void | selectionModeChanged(const QAbstract3DGraph::SelectionFlags selectionMode)

See also SelectionFlags.

### shadowQuality : QAbstract3DGraph::ShadowQuality

This property holds the quality of the shadow.

One of the ShadowQuality enum values. By default, `Medium`.

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:

QAbstract3DGraph::ShadowQuality | shadowQuality() const
void | setShadowQuality(const QAbstract3DGraph::ShadowQuality &shadowQuality)

Notifier signal:

void | shadowQualityChanged(QAbstract3DGraph::ShadowQuality quality)

See also ShadowQuality.

### wrapCameraXRotation : bool

This property holds the behavior of the minimum and maximum limits in the X-rotation.

If set to `true`, the X-rotation of the camera is wrapped from minimum to maximum and from maximum to minimum. If set to `false`, the X-rotation of the camera is limited to the sector determined by the minimum and maximum values. Set to `true` by default.

Access functions:

bool | wrapCameraXRotation()
void | setWrapCameraXRotation(bool wrap)

Notifier signal:

void | wrapCameraXRotationChanged(bool wrap)

### wrapCameraYRotation : bool

This property holds the behavior of the minimum and maximum limits in the Y-rotation.

If `true`, the Y-rotation of the camera is wrapped from minimum to maximum and from maximum to minimum. If `false`, the Y-rotation of the camera is limited to the sector determined by the minimum and maximum values. Set to `true` by default.

Access functions:

bool | wrapCameraYRotation()
void | setWrapCameraYRotation(bool wrap)

Notifier signal:

void | wrapCameraYRotationChanged(bool wrap)

### zoomAtTargetEnabled : bool

This property holds whether zooming should change the camera target so that the zoomed point of the graph stays at the same location after the zoom.

Defaults to `true`.

Access functions:

bool | zoomAtTargetEnabled()
void | setZoomAtTargetEnabled(bool enable)

Notifier signal:

void | zoomAtTargetEnabledChanged(bool enable)

### zoomEnabled : bool

This property holds whether this input handler allows graph zooming.

Defaults to `true`.

Access functions:

bool | zoomEnabled()
void | setZoomEnabled(bool enable)

Notifier signal:

void | zoomEnabledChanged(bool enable)

## Member Function Documentation

### `[virtual noexcept]` QAbstract3DGraph::~QAbstract3DGraph()

Destroys QAbstract3DGraph.

### int QAbstract3DGraph::addCustomItem(QCustom3DItem *item)

Adds a QCustom3DItem item to the graph. Graph takes ownership of the added item.

Returns the index to the added item if the add operation was successful, -1 if trying to add a null item, and the index of the item if trying to add an already added item.

Items are rendered in the order they have been inserted. The rendering order needs to be taken into account when having solid and transparent items.

See also removeCustomItems(), removeCustomItem(), removeCustomItemAt(), and customItems().

### void QAbstract3DGraph::addTheme(Q3DTheme *theme)

Adds the given theme to the graph. The themes added via addTheme are not taken in to use directly. Only the ownership of the theme is given to the graph. The theme must not be null or already added to another graph.

See also releaseTheme() and setActiveTheme().

### void QAbstract3DGraph::clearSelection()

Clears selection from all attached series.

### QList<QCustom3DItem *> QAbstract3DGraph::customItems() const

Returns the list of all added custom items.

See also addCustomItem().

### bool QAbstract3DGraph::hasSeries(QAbstract3DSeries *series) const

Returns whether the series has already been added to the graph.

### void QAbstract3DGraph::releaseCustomItem(QCustom3DItem *item)

Gets ownership of given item back and removes the item from the graph.

Note: If the same item is added back to the graph, the texture or the texture file needs to be re-set.

See also QCustom3DItem::setTextureImage() and QCustom3DItem::setTextureFile().

### void QAbstract3DGraph::releaseTheme(Q3DTheme *theme)

Releases the ownership of the theme back to the caller, if it was added to this graph. If the released theme is in use, a new default theme will be created and set active.

If the default theme is released and added back later, it behaves as any other theme would.

See also addTheme() and setActiveTheme().

### void QAbstract3DGraph::removeCustomItem(QCustom3DItem *item)

Removes the custom item. Deletes the resources allocated to it.

### void QAbstract3DGraph::removeCustomItemAt(const QVector3D &position)

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

### void QAbstract3DGraph::removeCustomItems()

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

### QSharedPointer<QQuickItemGrabResult> QAbstract3DGraph::renderToImage(const QSize &imageSize = QSize())

Renders current frame to an image of imageSize. Returns a shared pointer to grab resut which can be used to access the rendered image when it's ready. Image is rendered with the current antialiasing settings.

Note: OpenGL ES2 does not support anitialiasing.

See also QQuickItem::grabToImage.

### 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.

See also selectedElement.

### QCustom3DItem *QAbstract3DGraph::selectedCustomItem() const

Can be used to get the selected custom item after receiving `selectedElementChanged` signal with QAbstract3DGraph::ElementType::CustomItem 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.

See also selectedElement.

### int QAbstract3DGraph::selectedCustomItemIndex() const

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

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

See also selectedElement.

### 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.

See also selectedElement.

### void QAbstract3DGraph::setCameraPosition(float horizontal, float vertical, float zoom = 100.0f)

Utility function that sets the camera rotations and distance.horizontal and vertical define the camera rotations to be used. Optional zoom parameter can be given to set the zoom percentage of the camera within the bounds defined by minCameraZoomLevel and maxCameraZoomLevel properties.

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

Returns the list of all added themes.

See also addTheme().

## Related Non-Members

### QSurfaceFormat qDefaultSurfaceFormat(bool antialias)

This convenience function can be used to create a custom surface format suitable for use by Qt Graphs graphs.

The antialias parameter specifies whether or not antialiasing is activated.

Give the surface format returned by this function to the graph constructor (C++) or set it as the window format for QQuickView (QML) before calling `show()` on it.

For example, disable antialiasing on C++ application:

     #include <QtGraphs/qutils.h>

     // ...

     Q3DBars *graph = new Q3DBars(qDefaultSurfaceFormat(false));

For example, enable antialiasing for direct rendering modes on QML application:

     #include <QtGraphs/qutils.h>

     // ...

     QQuickView viewer;
     viewer.setFormat(qDefaultSurfaceFormat(true));