PySide6.QtGraphsWidgets.Q3DScatterWidgetItem

class Q3DScatterWidgetItem

The Q3DScatterWidgetItem class provides methods for rendering 3D scatter graphs. More…

Inheritance diagram of PySide6.QtGraphsWidgets.Q3DScatterWidgetItem

Synopsis

Properties

Methods

Signals

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

This class enables developers to render 3D scatter graphs and view them by freely rotating the scene. Rotation is achieved by holding down the right mouse button and moving the mouse, while zooming is accomplished using the mouse wheel. If enabled, selection is performed with the left mouse button. The scene can be reset to the default camera view by clicking the mouse wheel. On touch devices, rotation is achieved by tap-and-move, selection by tap-and-hold, and zooming by pinch.

If no axes are set explicitly to Q3DScatterWidgetItem , temporary default axes with no labels are created. These default axes can be modified via axis accessors, but as soon any axis is set explicitly for the orientation, the default axis for that orientation is destroyed.

Q3DScatterWidgetItem supports more than one series visible at the same time.

Q3DScatterWidgetItem has transparency support. This feature allows you to adjust the opacity of the scatter points, making them partially see-through, fully transparent, or opaque.

How to construct a minimal Q3DScatterWidgetItem graph

First, construct Q3DScatterWidgetItem . Since we are running the graph as the top-level window in this example, we need to clear the Qt::FramelessWindowHint flag, which is set by default:

quickWidget = QQuickWidget()
scatter = Q3DScatterWidgetItem()
scatter.setWidget(quickWidget)
scatter.widget().setMinimumSize(QSize(256, 256))

Now Q3DScatterWidgetItem is ready to receive data to be rendered. Add one series of 3 QVector3D items:

Note

In the new proxy-series relationship, data is held in series. Therefore, for the proxy to be able to add, delete, or edit the data, it is a prerequisite to create a series first.

series = QScatter3DSeries()
data = QScatterDataArray()
data << QScatterDataItem(0.5f, 0.5f, 0.5f) << QScatterDataItem(-0.3f, -0.5f, -0.4f)
     << QScatterDataItem(0.0f, -0.3f, 0.2f)
series.dataProxy().addItems(data)
scatter.addSeries(series)

Finally you will need to set it visible:

scatter.widget().show()

The complete code needed to create and display this graph is:

if __name__ == "__main__":

    app = QApplication([])
    quickWidget = QQuickWidget()
    scatter = Q3DScatterWidgetItem()
    scatter.setWidget(quickWidget)
    scatter.widget().setMinimumSize(QSize(256, 256))
    series = QScatter3DSeries()
    data = QScatterDataArray()
    data << QScatterDataItem(0.5f, 0.5f, 0.5f) << QScatterDataItem(-0.3f, -0.5f, -0.4f)
         << QScatterDataItem(0.0f, -0.3f, 0.2f)
    series.dataProxy().addItems(data)
    scatter.addSeries(series)
    scatter.widget().show()
    sys.exit(app.exec())

And this is what those few lines of code produce:

../../_images/q3dscatter-minimal.png

The scene can be rotated, zoomed into, and an item can be selected to view its position, but no other interactions are included in this minimal code example. You can learn more by familiarizing yourself with the examples provided, like the Simple Scatter Graph .

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property axisXᅟ: QValue3DAxis

This property holds The active x-axis..

Sets axis as the active x-axis. Implicitly calls addAxis() to transfer the ownership of the axis to this graph.

If axis is null, a temporary default axis with no labels and an automatically adjusting range is created. This temporary axis is destroyed if another axis is set explicitly to the same orientation.

Access functions:
property axisYᅟ: QValue3DAxis

This property holds The active y-axis..

Sets axis as the active y-axis. Implicitly calls addAxis() to transfer the ownership of the axis to this graph.

If axis is null, a temporary default axis with no labels and an automatically adjusting range is created. This temporary axis is destroyed if another axis is set explicitly to the same orientation.

Access functions:
property axisZᅟ: QValue3DAxis

This property holds The active z-axis..

Sets axis as the active z-axis. Implicitly calls addAxis() to transfer the ownership of the axis to this graph.

If axis is null, a temporary default axis with no labels and an automatically adjusting range is created. This temporary axis is destroyed if another axis is set explicitly to the same orientation.

Access functions:
property selectedSeriesᅟ: QScatter3DSeries

This property holds The selected series or null..

Access functions:
__init__([parent=None])
Parameters:

parent – QObject

Constructs a new 3D scatter graph with the optional parent.

addAxis(axis)
Parameters:

axis – QValue3DAxis

Adds axis to the graph. The axes added via addAxis are not yet taken to use, addAxis is simply used to give the ownership of the axis to the graph. The axis must not be null or added to another graph.

addSeries(series)
Parameters:

series – QScatter3DSeries

Adds the series to the graph. A graph can contain multiple series, but has only one set of axes. If the newly added series has specified a selected item, it will be highlighted and any existing selection will be cleared. Only one added series can have an active selection.

See also

hasSeries()

axes()
Return type:

.list of QValue3DAxis

Returns the list of all added axes.

See also

addAxis()

axisX()
Return type:

QValue3DAxis

See also

setAxisX()

Getter of property axisXᅟ .

axisXChanged(axis)
Parameters:

axis – QValue3DAxis

Notification signal of property axisXᅟ .

axisY()
Return type:

QValue3DAxis

See also

setAxisY()

Getter of property axisYᅟ .

axisYChanged(axis)
Parameters:

axis – QValue3DAxis

Notification signal of property axisYᅟ .

axisZ()
Return type:

QValue3DAxis

See also

setAxisZ()

Getter of property axisZᅟ .

axisZChanged(axis)
Parameters:

axis – QValue3DAxis

Notification signal of property axisZᅟ .

releaseAxis(axis)
Parameters:

axis – QValue3DAxis

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

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

removeSeries(series)
Parameters:

series – QScatter3DSeries

Removes the series from the graph.

See also

hasSeries()

selectedSeries()
Return type:

QScatter3DSeries

Getter of property selectedSeriesᅟ .

selectedSeriesChanged(series)
Parameters:

series – QScatter3DSeries

Notification signal of property selectedSeriesᅟ .

seriesList()
Return type:

.list of QScatter3DSeries

Returns the list of series added to this graph.

See also

hasSeries()

setAxisX(axis)
Parameters:

axis – QValue3DAxis

See also

axisX()

Setter of property axisXᅟ .

setAxisY(axis)
Parameters:

axis – QValue3DAxis

See also

axisY()

Setter of property axisYᅟ .

setAxisZ(axis)
Parameters:

axis – QValue3DAxis

See also

axisZ()

Setter of property axisZᅟ .