Back to Doc.qt.io
Contact Us Blog Download Qt

Custom3DItem QML Type

Adds a custom item to a graph. More...

Import Statement: import QtGraphs
In C++: QCustom3DItem
Inherited By:

Custom3DLabel and Custom3DVolume

Properties

Signals

Methods

Detailed Description

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

Property Documentation

meshFile : string

The item mesh file name. The item in the file must be mesh format. The mesh files are recommended to include vertices, normals, and UVs.


position : vector3d

The item position as a vector3d. Defaults to vector3d(0.0, 0.0, 0.0).

Item position is specified either in data coordinates or in absolute coordinates, depending on the value of 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 Custom3DVolume 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 and scalingAbsolute.


positionAbsolute : bool

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


rotation : quaternion

The item rotation as a quaternion. Defaults to quaternion(0.0, 0.0, 0.0, 0.0).


scaling : vector3d

The item scaling as a vector3d type. Defaults to vector3d(0.1, 0.1, 0.1).

Item scaling is specified either in data values or in absolute values, depending on the value of 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.


scalingAbsolute : bool

Defines 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 Custom3DVolume items, the range clipping is calculated on the unrotated item.

Note: Only absolute scaling is supported for Custom3DLabel 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 and positionAbsolute.


shadowCasting : bool

Defines whether shadow casting for the item is enabled. Defaults to true. If false, the item does not cast shadows regardless of ShadowQuality.


textureFile : string

The texture file name for the item. If left 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.


visible : bool

The visibility of the item. Defaults to true.


Signal Documentation

meshFileChanged(string meshFile)

This signal is emitted when meshFile changes to meshFile.

Note: The corresponding handler is onMeshFileChanged.


positionAbsoluteChanged(bool positionAbsolute)

This signal is emitted when positionAbsolute changes to positionAbsolute.

Note: The corresponding handler is onPositionAbsoluteChanged.


positionChanged(vector3d position)

This signal is emitted when item position changes to position.

Note: The corresponding handler is onPositionChanged.


rotationChanged(quaternion rotation)

This signal is emitted when rotation changes to rotation.

Note: The corresponding handler is onRotationChanged.


scalingAbsoluteChanged(bool scalingAbsolute)

This signal is emitted when scalingAbsolute changes to scalingAbsolute.

Note: The corresponding handler is onScalingAbsoluteChanged.


scalingChanged(vector3d scaling)

This signal is emitted when scaling changes to scaling.

Note: The corresponding handler is onScalingChanged.


shadowCastingChanged(bool shadowCasting)

This signal is emitted when shadowCasting changes to shadowCasting.

Note: The corresponding handler is onShadowCastingChanged.


textureFileChanged(string textureFile)

This signal is emitted when textureFile changes to textureFile.

Note: The corresponding handler is onTextureFileChanged.


visibleChanged(bool visible)

This signal is emitted when visible changes to visible.

Note: The corresponding handler is onVisibleChanged.


Method Documentation

void setRotationAxisAndAngle(vector3d axis, real angle)

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

See also rotation.


© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.