PhysicsWorld QML Type

Controls the physics simulation. More...

Import Statement: import QtQuick3D.Physics
Since: Qt 6.4



Detailed Description

The PhysicsWorld type controls the physics simulation. This node is used to create an instance of the physics world as well as define its properties. There can only be one physics world. All collision nodes in the qml will get added automatically to the physics world.

Property Documentation

defaultDensity : float

This property defines the default density of dynamic objects, measured in kilograms per cubic unit. This is equal to the weight of a cube with side 1.

The default value is 0.001, corresponding to 1 g/cm³: the density of water. If your unit of measurement is meters, a good value would be 1000. Note that only positive values are allowed.

Range: (0, inf]

enableCCD : bool

This property enables continuous collision detection. This will reduce the risk of bodies going through other bodies at high velocities (also known as tunnelling). The default value is false.

Warning: Using trigger bodies with CCD enabled is not supported and can result in missing or false trigger reports.

forceDebugDraw : bool

This property enables debug drawing of all active shapes in the physics world. The default value is false.

gravity : vector3d

This property defines the gravity vector of the physics world. The default value is (0, -981, 0). Set the value to Qt.vector3d(0, -9.81, 0) if your unit of measurement is meters and you are simulating Earth gravity.

maximumTimestep : float

This property defines the maximum simulation timestep in milliseconds. The default value is 33.333 which corresponds to 30 frames per second.

Range: [0, inf]

minimumTimestep : float

This property defines the minimum simulation timestep in milliseconds. The default value is 16.667 which corresponds to 60 frames per second.

Range: [0, maximumTimestep]

running : bool

This property starts or stops the physical simulation. The default value is true.

scene : Node

This property defines the top-most Node that contains all the nodes of the physical simulation. All physics objects that are an ancestor of this node will be seen as part of this PhysicsWorld.

Note: Using the same scene node for several PhysicsWorld is unsupported.

typicalLength : float

This property defines the approximate size of objects in the simulation. This is used to estimate certain length-related tolerances. Objects much smaller or much larger than this size may not behave properly. The default value is 100.

Range: [0, inf]

typicalSpeed : float

This property defines the typical magnitude of velocities of objects in simulation. This is used to estimate whether a contact should be treated as bouncing or resting based on its impact velocity, and a kinetic energy threshold below which the simulation may put objects to sleep.

For normal physical environments, a good choice is the approximate speed of an object falling under gravity for one second. The default value is 1000.

Range: [0, inf]

viewport : Node

This property defines the viewport where debug components will be drawn if forceDebugDraw is enabled. If unset the scene node will be used.

See also forceDebugDraw and scene.

Signal Documentation

[since 6.5] frameDone(float timestep)

This signal is emitted when the physical simulation is done simulating a frame. The timestep parameter is how long in milliseconds the timestep was in the simulation.

Note: The corresponding handler is onFrameDone.

This signal was introduced in Qt 6.5.

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