PySide6.QtGraphs.QCustom3DItem¶

class QCustom3DItem¶

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

Inherited by: QCustom3DVolume, QCustom3DLabel

Synopsis¶

Properties¶

meshFileᅟ - Item mesh file name
positionᅟ - Item position as a QVector3D
positionAbsoluteᅟ - Whether item position is to be handled in data coordinates or in absolute coordinates
rotationᅟ - Item rotation as a QQuaternion
scalingᅟ - Item scaling as a QVector3D
scalingAbsoluteᅟ - Whether item scaling is to be handled in data values or in absolute values
shadowCastingᅟ - Whether shadow casting for the item is enabled
textureFileᅟ - Texture file name for the item
visibleᅟ - Visibility of the item

Methods¶

def __init__()
def isPositionAbsolute()
def isScalingAbsolute()
def isShadowCasting()
def isVisible()
def meshFile()
def position()
def rotation()
def scaling()
def setMeshFile()
def setPosition()
def setPositionAbsolute()
def setRotation()
def setRotationAxisAndAngle()
def setScaling()
def setScalingAbsolute()
def setShadowCasting()
def setTextureFile()
def setTextureImage()
def setVisible()
def textureFile()

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¶

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

See also

addCustomItem()

Note

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

property meshFileᅟ: str¶

This property holds The item mesh file name..

The item in the file must be in mesh format. The other types can be converted by Balsam asset import tool. The mesh files are recommended to include vertices, normals, and UVs.

Access functions:

meshFile()
setMeshFile()
Signal meshFileChanged()

property positionᅟ: 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

Access functions:

position()
setPosition()
Signal positionChanged()

property 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

Access functions:

isPositionAbsolute()
setPositionAbsolute()
Signal positionAbsoluteChanged()

property rotationᅟ: QQuaternion¶

This property holds The item rotation as a QQuaternion..

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

Access functions:

rotation()
setRotation()
Signal rotationChanged()

property scalingᅟ: 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

Access functions:

scaling()
setScaling()
Signal scalingChanged()

property 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

Access functions:

isScalingAbsolute()
setScalingAbsolute()
Signal scalingAbsoluteChanged()

property shadowCastingᅟ: 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 Q3DGraphsWidgetItem::ShadowQuality.

Access functions:

isShadowCasting()
setShadowCasting()
Signal shadowCastingChanged()

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

Access functions:

textureFile()
setTextureFile()
Signal textureFileChanged()

property visibleᅟ: bool¶

This property holds The visibility of the item..

Defaults to true.

Access functions:

isVisible()
setVisible()
Signal visibleChanged()

__init__([parent=None])¶

Parameters:: parent – QObject

Constructs a custom 3D item with the specified parent.

__init__(meshFile, position, scaling, rotation, texture[, parent=None])

Parameters:

meshFile – str
position – QVector3D
scaling – QVector3D
rotation – QQuaternion
texture – QImage
parent – QObject

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

isPositionAbsolute()¶

Return type:: bool

Getter of property positionAbsoluteᅟ .

isScalingAbsolute()¶

Return type:: bool

Getter of property scalingAbsoluteᅟ .

isShadowCasting()¶

Return type:: bool

Getter of property shadowCastingᅟ .

isVisible()¶

Return type:: bool

Getter of property visibleᅟ .

meshFile()¶

Return type:: str

See also

setMeshFile()

Getter of property meshFileᅟ .

meshFileChanged(meshFile)¶

Parameters:: meshFile – str

Notification signal of property meshFileᅟ .

needUpdate()¶

position()¶

Return type:: QVector3D

See also

setPosition()

Getter of property positionᅟ .

positionAbsoluteChanged(positionAbsolute)¶

Parameters:: positionAbsolute – bool

Notification signal of property positionAbsoluteᅟ .

positionChanged(position)¶

Parameters:: position – QVector3D

Notification signal of property positionᅟ .

rotation()¶

Return type:: QQuaternion

See also

setRotation()

Getter of property rotationᅟ .

rotationChanged(rotation)¶

Parameters:: rotation – QQuaternion

Notification signal of property rotationᅟ .

scaling()¶

Return type:: QVector3D

See also

setScaling()

Getter of property scalingᅟ .

scalingAbsoluteChanged(scalingAbsolute)¶

Parameters:: scalingAbsolute – bool

Notification signal of property scalingAbsoluteᅟ .

scalingChanged(scaling)¶

Parameters:: scaling – QVector3D

Notification signal of property scalingᅟ .

setMeshFile(meshFile)¶

Parameters:: meshFile – str

See also

meshFile()

Setter of property meshFileᅟ .

setPosition(position)¶

Parameters:: position – QVector3D

See also

position()

Setter of property positionᅟ .

setPositionAbsolute(positionAbsolute)¶

Parameters:: positionAbsolute – bool

See also

isPositionAbsolute()

Setter of property positionAbsoluteᅟ .

setRotation(rotation)¶

Parameters:: rotation – QQuaternion

See also

rotation()

Setter of property rotationᅟ .

setRotationAxisAndAngle(axis, angle)¶

Parameters:

axis – QVector3D
angle – float

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

See also

rotation

setScaling(scaling)¶

Parameters:: scaling – QVector3D

See also

scaling()

Setter of property scalingᅟ .

setScalingAbsolute(scalingAbsolute)¶

Parameters:: scalingAbsolute – bool

See also

isScalingAbsolute()

Setter of property scalingAbsoluteᅟ .

setShadowCasting(enabled)¶

Parameters:: enabled – bool

See also

isShadowCasting()

Setter of property shadowCastingᅟ .

setTextureFile(textureFile)¶

Parameters:: textureFile – str

See also

textureFile()

Setter of property textureFileᅟ .

setTextureImage(textureImage)¶

Parameters:: textureImage – 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.

setVisible(visible)¶

Parameters:: visible – bool

See also

isVisible()

Setter of property visibleᅟ .

shadowCastingChanged(shadowCasting)¶

Parameters:: shadowCasting – bool

Notification signal of property shadowCastingᅟ .

textureFile()¶

Return type:: str

See also

setTextureFile()

Getter of property textureFileᅟ .

textureFileChanged(textureFile)¶

Parameters:: textureFile – str

Notification signal of property textureFileᅟ .

visibleChanged(visible)¶

Parameters:: visible – bool

Notification signal of property visibleᅟ .