Qt 5.13 | Qt Data Visualization | QML Types | AbstractGraph3D QML Type

Qt Data Visualization | Commercial or GPLv3

# AbstractGraph3D QML Type

Base type for 3D visualizations. More...

Import Statement: | import QtDataVisualization 1.13
Since: | QtDataVisualization 1.0
Inherited By: | Bars3D, Scatter3D, and Surface3D

- List of all members, including inherited members

## Properties

- aspectRatio : real
- currentFps : int
- customItemList : list<Custom3DItem>
- horizontalAspectRatio : real
- inputHandler : AbstractInputHandler3D
- locale : locale
- margin : real
- measureFps : bool
- msaaSamples : int
- optimizationHints : AbstractGraph3D.OptimizationHints
- orthoProjection : bool
- polar : bool
- queriedGraphPosition : vector3d
- radialLabelOffset : real
- reflection : bool
- reflectivity : real
- renderingMode : AbstractGraph3D.RenderingMode
- scene : Scene3D
- selectedElement : AbstractGraph3D.ElementType
- selectionMode : AbstractGraph3D.SelectionMode
- shadowQuality : AbstractGraph3D.ShadowQuality
- shadowsSupported : bool
- theme : Theme3D

## Methods

- int addCustomItem(item)
- void clearSelection()
- void releaseCustomItem(item)
- void removeCustomItem(item)
- void removeCustomItemAt(position)
- void removeCustomItems()
- Abstract3DAxis selectedAxis()
- Custom3DItem selectedCustomItem()
- int selectedCustomItemIndex()
- int selectedLabelIndex()

## Detailed Description

The base type for all 3D visualizations in QtDataVisualization.

This type is uncreatable, but it contains properties that are shared between the 3D visualizations.

See also Bars3D, Scatter3D, Surface3D, and Qt Data Visualization C++ Classes.

## Property Documentation

aspectRatio : real

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

This property was introduced in QtDataVisualization 1.1.

See also horizontalAspectRatio.

currentFps : int

When FPS measuring is enabled, the results for the last second are stored in this read-only property. It takes at least a second before this value updates after measuring is activated.

This property was introduced in QtDataVisualization 1.1.

See also measureFps.

customItemList : list<Custom3DItem>

The list of Custom3DItem items added to the graph. The graph takes ownership of the added items.

This property was introduced in QtDataVisualization 1.1.

horizontalAspectRatio : real

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

Note: Has no effect on Bars3D, 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.

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

inputHandler : AbstractInputHandler3D

The active input handler used in the graph. You can disable default input handlers by setting this property to null.

locale : locale

Sets the locale used for formatting various numeric labels. Defaults to the `"C"` locale.

This property was introduced in QtDataVisualization 1.2.

See also ValueAxis3D::labelFormat.

margin : real

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.

measureFps : bool

If `true`, the rendering is done continuously instead of on demand, and the value of the currentFps property is updated. Defaults to `false`.

This property was introduced in QtDataVisualization 1.1.

See also currentFps.

msaaSamples : int

The number of samples used in multisample antialiasing when renderingMode is `RenderIndirect`. When renderingMode is `RenderDirectToBackground` or `RenderDirectToBackground_NoClear`, this property value is read-only and returns the number of samples specified by the window surface format. Defaults to `4`.

See also renderingMode.

optimizationHints : AbstractGraph3D.OptimizationHints

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.

This property was introduced in QtDataVisualization 1.1.

See also Abstract3DSeries::mesh and QAbstract3DGraph::OptimizationHint.

orthoProjection : bool

If `true`, orthographic projection will be 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.

polar : bool

If `true`, the horizontal axes are changed into polar axes. 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.

See also orthoProjection and radialLabelOffset.

queriedGraphPosition : vector3d

This read-only property contains the latest graph position values along each axis queried using Scene3D::graphPositionQuery. The values are normalized to range `[-1, 1]`. If the queried position was outside the graph bounds, the values will not reflect the real position, but will instead be some 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 valid queries can be only made at screen positions that contain the floor of the graph.

This property was introduced in QtDataVisualization 1.2.

See also Scene3D::graphPositionQuery.

radialLabelOffset : real

This property specifies 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. This property is ignored if the polar property value is `false`. Defaults to `1.0`.

This property was introduced in QtDataVisualization 1.2.

See also polar.

reflection : bool

Sets floor reflections on or off. Defaults to `false`.

Note: Affects only Bars3D. However, in Bars3D 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.

This property was introduced in QtDataVisualization 1.2.

See also reflectivity.

reflectivity : real

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

Note: Affects only Bars3D.

This property was introduced in QtDataVisualization 1.2.

See also reflection.

renderingMode : AbstractGraph3D.RenderingMode

How the graph will be rendered. Defaults to `RenderIndirect`.

Constant | Description
--- | ---

`RenderDirectToBackground`

Indicates that the graph will be rendered directly on the window background. Clears the whole window before rendering the graph, including the areas outside the graph. Since the graphs in this rendering mode are drawn on the window background under other QML items, the regular QML window clearing before rendering is suppressed. The graphs handle the clearing themselves instead. If the surface format of the window supports antialiasing, it will be used (see `QtDataVisualization::qDefaultSurfaceFormat()`). This rendering mode offers the best performance at the expense of non-standard QML behavior. For example, the graphs do not obey the z ordering of QML items and the opacity value has no effect on them.

`RenderDirectToBackground_NoClear`

Similar to `RenderDirectToBackground` mode, except that the graph will not clear the whole window before rendering the graph. This mode is better for windows where you have other custom items besides the graphs that also draw on the window background. In that case you need to either take care of the window clearing yourself or ensure that all areas of the window are fully covered with opaque items. If one graph in the window uses either of the direct rendering modes, then all other graphs in the same window also drawn in direct modes should use the exact same direct rendering mode. Otherwise some graphs may not show up, depending on the drawing order of the graphs.

`RenderIndirect`

Indicates the graph will be first rendered to an offscreen surface that is then drawn during normal QML item rendering. The rendered image is antialiased using the multisampling method if it is supported in the current environment and the msaaSamples property value is greater than zero. This rendering mode offers good quality and normal QML item behavior at the expense of performance.

Note: Antialiasing is not supported in OpenGL ES2 environments in any rendering mode.

Note: Setting the `antialiasing` property of the graph does not do anything. However, it is set by the graph itself if the current rendering mode uses antialiasing.

See also msaaSamples.

scene : Scene3D

The Scene3D pointer that can be used to manipulate the scene and access the scene elements, such as the active camera.

This property is read-only.

selectedElement : AbstractGraph3D.ElementType

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 customized input handling, as demonstrated by the Qt Quick 2 Axis Dragging Example.

This property was introduced in QtDataVisualization 1.1.

See also selectedLabelIndex(), selectedAxis(), selectedCustomItemIndex(), selectedCustomItem(), Bars3D::selectedSeries, Scatter3D::selectedSeries, Scene3D::selectionQueryPosition, and QAbstract3DGraph::ElementType.

selectionMode : AbstractGraph3D.SelectionMode

The active selection mode in the visualization. One of the QAbstract3DGraph::SelectionFlag enum values.

See also QAbstract3DGraph::SelectionFlag.

shadowQuality : AbstractGraph3D.ShadowQuality

The quality of shadows. One of the QAbstract3DGraph::ShadowQuality enum values.

See also QAbstract3DGraph::ShadowQuality.

shadowsSupported : bool

This read-only property indicates whether shadows are supported with the current configuration. OpenGL ES2 configurations do not support shadows.

theme : Theme3D

The active theme of the graph.

See also Theme3D.

## Method Documentation

int addCustomItem(item)

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

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

This method was introduced in QtDataVisualization 1.1.

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

void clearSelection()

Clears selection from all attached series.

void releaseCustomItem(item)

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

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

This method was introduced in QtDataVisualization 1.1.

See also Custom3DItem::textureFile.

void removeCustomItem(item)

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

This method was introduced in QtDataVisualization 1.1.

void removeCustomItemAt(position)

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

This method was introduced in QtDataVisualization 1.1.

void removeCustomItems()

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

This method was introduced in QtDataVisualization 1.1.

Abstract3DAxis selectedAxis()

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 selected axis, or null.

This method was introduced in QtDataVisualization 1.1.

See also selectedElement.

Custom3DItem selectedCustomItem()

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

Returns the selected custom item, or null.

This method was introduced in QtDataVisualization 1.1.

See also selectedElement.

int selectedCustomItemIndex()

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

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

This method was introduced in QtDataVisualization 1.1.

See also selectedElement.

int selectedLabelIndex()

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 index of the selected label, or -1.

This method was introduced in QtDataVisualization 1.1.

See also selectedElement.