PySide6.QtGraphs.QSurface3DSeries

class QSurface3DSeries

The QSurface3DSeries class represents a data series in a 3D surface graph. More…

Synopsis

Properties

• dataArrayᅟ - Data array for the series

• dataProxyᅟ - Active data proxy

• drawModeᅟ

• flatShadingSupportedᅟ - Whether surface flat shading is supported by the current system

• selectedPointᅟ - Surface grid point that is selected in the series

• shadingᅟ - Whether surface flat shading is enabled

• textureᅟ - For the surface as a QImage

• textureFileᅟ - Texture for the surface as a file

• wireframeColorᅟ - Color for the surface wireframe

Methods

• def __init__()

• def clearArray()

• def clearRow()

• def dataArray()

• def dataProxy()

• def drawMode()

• def isFlatShadingSupported()

• def selectedPoint()

• def setDataArray()

• def setDataProxy()

• def setDrawMode()

• def setSelectedPoint()

• def setShading()

• def setTexture()

• def setTextureFile()

• def setWireframeColor()

• def shading()

• def texture()

• def textureFile()

• def wireframeColor()

Signals

• def dataArrayChanged()

• def dataProxyChanged()

• def drawModeChanged()

• def flatShadingSupportedChanged()

• def selectedPointChanged()

• def shadingChanged()

• def textureChanged()

• def textureFileChanged()

• def wireframeColorChanged()

Static functions

• def invalidSelectionPosition()

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 manages the series-specific visual elements, as well as the series data (via a data proxy).

Regarding the proxy-series relationship, it is crucial to highlight a couple of key points. In this context, data is stored in series and users can access the dataset through the series. This series is controlled or represented by a proxy object. Thus, the proxy can be used to manage various operations on the data and update the actual dataset. However, it is necessary to create a series associated with this proxy to edit the dataset.

If no data proxy is set explicitly for the series, the series creates a default proxy. Setting another proxy will destroy the existing proxy and all data added to the series.

The object mesh set via the mesh property defines the selection pointer shape in a surface series.

QSurface3DSeries supports the following format tags for setItemLabelFormat() :

@xTitle	Title from x-axis
@yTitle	Title from y-axis
@zTitle	Title from z-axis
@xLabel	Item value formatted using the format of the x-axis. For more information, see labelFormat .
@yLabel	Item value formatted using the format of the y-axis. For more information, see labelFormat .
@zLabel	Item value formatted using the format of the z-axis. For more information, see labelFormat .
@seriesName	Name of the series

For example:

proxy.setItemLabelFormat("@valueTitle for (@rowLabel, @colLabel): %.1f")

See also

Qt Graphs Data Handling with 3D

class DrawFlag

(inherits enum.Flag) The drawing mode of the surface. Values of this enumeration can be combined with the OR operator.

Constant	Description
QSurface3DSeries.DrawWireframe	Only the grid is drawn.
QSurface3DSeries.DrawSurface	Only the surface is drawn.
QSurface3DSeries.DrawSurfaceAndWireframe	Both the surface and grid are drawn.

class Shading

Added in version 6.8.

Note

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

property dataArrayᅟ: list of list of QSurfaceDataItem

This property holds Data array for the series..

Holds the reference of the data array.

dataArrayChanged signal is emitted when data array is set, unless newDataArray is identical to the previous one.

Note

Before doing anything regarding the dataArray, a series must be created for the relevant proxy.

See also

clearRow(qsizetype rowIndex) clearArray()

Access functions:

• dataArray()

• setDataArray()

• Signal dataArrayChanged()

property dataProxyᅟ: QSurfaceDataProxy

This property holds The active data proxy..

The series assumes ownership of any proxy set to it and deletes any previously set proxy when a new one is added. The proxy cannot be null or set to another series.

Access functions:

• dataProxy()

• setDataProxy()

• Signal dataProxyChanged()

property drawModeᅟ: Combination of QSurface3DSeries.DrawFlag

The drawing mode.

Possible values are the values of DrawFlag . Clearing all flags is not allowed.

Access functions:

• drawMode()

• setDrawMode()

• Signal drawModeChanged()

property flatShadingSupportedᅟ: bool

This property holds Whether surface flat shading is supported by the current system..

Flat shading for surfaces requires at least GLSL version 1.2 with GL_EXT_gpu_shader4 extension. If true, flat shading for surfaces is supported.

Note

This read-only property is set to its correct value after the first render pass. Until then it is always true.

Access functions:

• isFlatShadingSupported()

• Signal flatShadingSupportedChanged()

property selectedPointᅟ: QPoint

This property holds The surface grid point that is selected in the series..

Selects a surface grid point at the position position in the data array of the series specified by a row and a column.

Only one point can be selected at a time.

To clear the selection from this series, invalidSelectionPosition() is set as position. If this series is added to a graph, the graph can adjust the selection according to user interaction or if it becomes invalid.

Removing rows from or inserting rows into the series before the row of the selected point will adjust the selection so that the same point will stay selected.

See also

clearSelection()

Access functions:

• selectedPoint()

• setSelectedPoint()

• Signal selectedPointChanged()

property shadingᅟ: QSurface3DSeries.Shading

This property holds Whether surface flat shading is enabled..

Preset to QSurface3DSeries::Shading::Flat by default.

When disabled, the normals on the surface are interpolated making the edges look round. When visible, the normals are kept the same on a triangle making the color of the triangle solid. This makes the data more readable from the model.

Note

Flat shaded surfaces require at least GLSL version 1.2 with GL_EXT_gpu_shader4 extension. The value of the flatShadingSupported property indicates whether flat shading is supported at runtime.

Access functions:

• shading()

• setShading()

• Signal shadingChanged()

property textureᅟ: QImage

This property holds The texture for the surface as a QImage..

Setting an empty QImage clears the texture.

Access functions:

• texture()

• setTexture()

• Signal textureChanged()

property textureFileᅟ: str

This property holds The texture for the surface as a file..

Setting an empty file name clears the texture.

Access functions:

• textureFile()

• setTextureFile()

• Signal textureFileChanged()

property wireframeColorᅟ: QColor

This property holds The color for the surface wireframe..

Access functions:

• wireframeColor()

• setWireframeColor()

• Signal wireframeColorChanged()

__init__([parent=None])

Parameters:

parent – QObject

Constructs a surface 3D series with the parent parent.

__init__(dataProxy[, parent=None])

Parameters:

• dataProxy – QSurfaceDataProxy

• parent – QObject

Constructs a surface 3D series with the data proxy dataProxy and the parent parent.

clearArray()

Clears the existing array.

clearRow(rowIndex)

Parameters:

rowIndex – int

Clears the existing row in the array according to given rowIndex.

dataArray()

Return type:

.list of list of QSurfaceDataItem

Getter of property dataArrayᅟ .

dataArrayChanged(array)

Parameters:

array – .list of list of QSurfaceDataItem

Notification signal of property dataArrayᅟ .

dataProxy()

Return type:

QSurfaceDataProxy

See also

setDataProxy()

Getter of property dataProxyᅟ .

dataProxyChanged(proxy)

Parameters:

proxy – QSurfaceDataProxy

Notification signal of property dataProxyᅟ .

drawMode()

Return type:

Combination of DrawFlag

See also

setDrawMode()

Getter of property drawModeᅟ .

drawModeChanged(mode)

Parameters:

mode – Combination of DrawFlag

Notification signal of property drawModeᅟ .

flatShadingSupportedChanged(enabled)

Parameters:

enabled – bool

Notification signal of property flatShadingSupportedᅟ .

static invalidSelectionPosition()

Return type:

QPoint

Returns the QPoint signifying an invalid selection position. This is set to the selectedPoint property to clear the selection from this series.

See also

clearSelection()

isFlatShadingSupported()

Return type:

bool

Getter of property flatShadingSupportedᅟ .

selectedPoint()

Return type:

QPoint

See also

setSelectedPoint()

Getter of property selectedPointᅟ .

selectedPointChanged(position)

Parameters:

position – QPoint

Notification signal of property selectedPointᅟ .

setDataArray(newDataArray)

Parameters:

newDataArray – .list of list of QSurfaceDataItem

See also

dataArray()

Setter of property dataArrayᅟ .

setDataProxy(proxy)

Parameters:

proxy – QSurfaceDataProxy

See also

dataProxy()

Setter of property dataProxyᅟ .

setDrawMode(mode)

Parameters:

mode – Combination of DrawFlag

See also

drawMode()

Setter of property drawModeᅟ .

setSelectedPoint(position)

Parameters:

position – QPoint

See also

selectedPoint()

Setter of property selectedPointᅟ .

setShading(shading)

Parameters:

shading – Shading

See also

shading()

Setter of property shadingᅟ .

setTexture(texture)

Parameters:

texture – QImage

See also

texture()

Setter of property textureᅟ .

setTextureFile(filename)

Parameters:

filename – str

See also

textureFile()

Setter of property textureFileᅟ .

setWireframeColor(color)

Parameters:

color – QColor

See also

wireframeColor()

Setter of property wireframeColorᅟ .

shading()

Return type:

Shading

See also

setShading()

Getter of property shadingᅟ .

shadingChanged(shading)

Parameters:

shading – Shading

Notification signal of property shadingᅟ .

texture()

Return type:

QImage

See also

setTexture()

Getter of property textureᅟ .

textureChanged(image)

Parameters:

image – QImage

Notification signal of property textureᅟ .

textureFile()

Return type:

str

See also

setTextureFile()

Getter of property textureFileᅟ .

textureFileChanged(filename)

Parameters:

filename – str

Notification signal of property textureFileᅟ .

wireframeColor()

Return type:

QColor

See also

setWireframeColor()

Getter of property wireframeColorᅟ .

wireframeColorChanged(color)

Parameters:

color – QColor

Notification signal of property wireframeColorᅟ .