QCustom3DItem#

The QCustom3DItem class adds a custom item to a graph. More

Inherited by: QCustom3DVolume, QCustom3DLabel

Synopsis#

Functions#

Signals#

Detailed Description#

A custom item has a custom mesh, position, scaling, rotation, and an optional texture.

See also

addCustomItem()

class PySide6.QtDataVisualization.QCustom3DItem([parent=None])#

PySide6.QtDataVisualization.QCustom3DItem(meshFile, position, scaling, rotation, texture[, parent=None])

Parameters

Constructs a custom 3D item with the specified parent.

Constructs a custom 3D item with the specified meshFile, position, scaling, rotation, texture image, and optional parent.

PySide6.QtDataVisualization.QCustom3DItem.isPositionAbsolute()#
Return type

bool

This property holds Whether item position is to be handled in data coordinates or in absolute coordinates..

Defaults to false. Items with absolute coordinates will always be rendered, whereas items with data coordinates are only rendered if they are within axis ranges.

See also

position

PySide6.QtDataVisualization.QCustom3DItem.isScalingAbsolute()#
Return type

bool

This property holds Whether item scaling is to be handled in data values or in absolute values..

Defaults to true.

Items with absolute scaling will be rendered at the same size, regardless of axis ranges. Items with data scaling will change their apparent size according to the axis ranges. If positionAbsolute is true, this property is ignored and scaling is interpreted as an absolute value. If the item has rotation, the data scaling is calculated on the unrotated item. Similarly, for QCustom3DVolume items, the range clipping is calculated on the unrotated item.

Note

Only absolute scaling is supported for QCustom3DLabel items or for custom items used in polar graphs.

Note

The custom item’s mesh must be normalized to the range [-1 ,1], or the data scaling will not be accurate.

See also

scaling positionAbsolute

PySide6.QtDataVisualization.QCustom3DItem.isShadowCasting()#
Return type

bool

This property holds Whether shadow casting for the item is enabled..

Defaults to true. If false, the item does not cast shadows regardless of ShadowQuality .

PySide6.QtDataVisualization.QCustom3DItem.isVisible()#
Return type

bool

This property holds The visibility of the item..

Defaults to true.

PySide6.QtDataVisualization.QCustom3DItem.meshFile()#
Return type

str

This property holds The item mesh file name..

The item in the file must be in Wavefront OBJ format and include vertices, normals, and UVs. It also needs to be in triangles.

PySide6.QtDataVisualization.QCustom3DItem.meshFileChanged(meshFile)#
Parameters

meshFile – str

PySide6.QtDataVisualization.QCustom3DItem.position()#
Return type

PySide6.QtGui.QVector3D

This property holds The item position as a QVector3D ..

Defaults to QVector3D(0.0, 0.0, 0.0).

Item position is specified either in data coordinates or in absolute coordinates, depending on the positionAbsolute property. When using absolute coordinates, values between -1.0...1.0 are within axis ranges.

Note

Items positioned outside any axis range are not rendered if positionAbsolute is false, unless the item is a QCustom3DVolume that would be partially visible and scalingAbsolute is also false. In that case, the visible portion of the volume will be rendered.

See also

positionAbsolute

PySide6.QtDataVisualization.QCustom3DItem.positionAbsoluteChanged(positionAbsolute)#
Parameters

positionAbsolute – bool

PySide6.QtDataVisualization.QCustom3DItem.positionChanged(position)#
Parameters

positionPySide6.QtGui.QVector3D

PySide6.QtDataVisualization.QCustom3DItem.rotation()#
Return type

PySide6.QtGui.QQuaternion

This property holds The item rotation as a QQuaternion ..

Defaults to QQuaternion(0.0, 0.0, 0.0, 0.0).

PySide6.QtDataVisualization.QCustom3DItem.rotationChanged(rotation)#
Parameters

rotationPySide6.QtGui.QQuaternion

PySide6.QtDataVisualization.QCustom3DItem.scaling()#
Return type

PySide6.QtGui.QVector3D

This property holds The item scaling as a QVector3D ..

Defaults to QVector3D(0.1, 0.1, 0.1).

Item scaling is either in data values or in absolute values, depending on the scalingAbsolute property. The default vector interpreted as absolute values sets the item to 10% of the height of the graph, provided the item mesh is normalized and the graph aspect ratios have not been changed from the defaults.

See also

scalingAbsolute

PySide6.QtDataVisualization.QCustom3DItem.scalingAbsoluteChanged(scalingAbsolute)#
Parameters

scalingAbsolute – bool

PySide6.QtDataVisualization.QCustom3DItem.scalingChanged(scaling)#
Parameters

scalingPySide6.QtGui.QVector3D

PySide6.QtDataVisualization.QCustom3DItem.setMeshFile(meshFile)#
Parameters

meshFile – str

This property holds The item mesh file name..

The item in the file must be in Wavefront OBJ format and include vertices, normals, and UVs. It also needs to be in triangles.

PySide6.QtDataVisualization.QCustom3DItem.setPosition(position)#
Parameters

positionPySide6.QtGui.QVector3D

This property holds The item position as a QVector3D ..

Defaults to QVector3D(0.0, 0.0, 0.0).

Item position is specified either in data coordinates or in absolute coordinates, depending on the positionAbsolute property. When using absolute coordinates, values between -1.0...1.0 are within axis ranges.

Note

Items positioned outside any axis range are not rendered if positionAbsolute is false, unless the item is a QCustom3DVolume that would be partially visible and scalingAbsolute is also false. In that case, the visible portion of the volume will be rendered.

See also

positionAbsolute

PySide6.QtDataVisualization.QCustom3DItem.setPositionAbsolute(positionAbsolute)#
Parameters

positionAbsolute – bool

This property holds Whether item position is to be handled in data coordinates or in absolute coordinates..

Defaults to false. Items with absolute coordinates will always be rendered, whereas items with data coordinates are only rendered if they are within axis ranges.

See also

position

PySide6.QtDataVisualization.QCustom3DItem.setRotation(rotation)#
Parameters

rotationPySide6.QtGui.QQuaternion

This property holds The item rotation as a QQuaternion ..

Defaults to QQuaternion(0.0, 0.0, 0.0, 0.0).

PySide6.QtDataVisualization.QCustom3DItem.setRotationAxisAndAngle(axis, angle)#
Parameters

A convenience function to construct the rotation quaternion from axis and angle.

See also

rotation

PySide6.QtDataVisualization.QCustom3DItem.setScaling(scaling)#
Parameters

scalingPySide6.QtGui.QVector3D

This property holds The item scaling as a QVector3D ..

Defaults to QVector3D(0.1, 0.1, 0.1).

Item scaling is either in data values or in absolute values, depending on the scalingAbsolute property. The default vector interpreted as absolute values sets the item to 10% of the height of the graph, provided the item mesh is normalized and the graph aspect ratios have not been changed from the defaults.

See also

scalingAbsolute

PySide6.QtDataVisualization.QCustom3DItem.setScalingAbsolute(scalingAbsolute)#
Parameters

scalingAbsolute – bool

This property holds Whether item scaling is to be handled in data values or in absolute values..

Defaults to true.

Items with absolute scaling will be rendered at the same size, regardless of axis ranges. Items with data scaling will change their apparent size according to the axis ranges. If positionAbsolute is true, this property is ignored and scaling is interpreted as an absolute value. If the item has rotation, the data scaling is calculated on the unrotated item. Similarly, for QCustom3DVolume items, the range clipping is calculated on the unrotated item.

Note

Only absolute scaling is supported for QCustom3DLabel items or for custom items used in polar graphs.

Note

The custom item’s mesh must be normalized to the range [-1 ,1], or the data scaling will not be accurate.

See also

scaling positionAbsolute

PySide6.QtDataVisualization.QCustom3DItem.setShadowCasting(enabled)#
Parameters

enabled – bool

This property holds Whether shadow casting for the item is enabled..

Defaults to true. If false, the item does not cast shadows regardless of ShadowQuality .

PySide6.QtDataVisualization.QCustom3DItem.setTextureFile(textureFile)#
Parameters

textureFile – str

This property holds The texture file name for the item..

If both this property and the texture image are unset, a solid gray texture will be used.

Note

To conserve memory, the QImage loaded from the file is cleared after a texture is created.

PySide6.QtDataVisualization.QCustom3DItem.setTextureImage(textureImage)#
Parameters

textureImagePySide6.QtGui.QImage

Sets the value of textureImage as a QImage for the item. The texture defaults to solid gray.

Note

To conserve memory, the given QImage is cleared after a texture is created.

PySide6.QtDataVisualization.QCustom3DItem.setVisible(visible)#
Parameters

visible – bool

This property holds The visibility of the item..

Defaults to true.

PySide6.QtDataVisualization.QCustom3DItem.shadowCastingChanged(shadowCasting)#
Parameters

shadowCasting – bool

PySide6.QtDataVisualization.QCustom3DItem.textureFile()#
Return type

str

This property holds The texture file name for the item..

If both this property and the texture image are unset, a solid gray texture will be used.

Note

To conserve memory, the QImage loaded from the file is cleared after a texture is created.

PySide6.QtDataVisualization.QCustom3DItem.textureFileChanged(textureFile)#
Parameters

textureFile – str

PySide6.QtDataVisualization.QCustom3DItem.visibleChanged(visible)#
Parameters

visible – bool