QFlexibleJoint Class Reference

#include <qflexiblejoint_p.h>

Inheritance diagram for QFlexibleJoint:

Collaboration diagram for QFlexibleJoint:

Signals
	Q_REVISION (6, 13) void stiffnessChanged()
	Q_REVISION (6, 13) void dampingChanged()
Signals inherited from QPhysicsJoint
	Q_REVISION (6, 12) void bodyAChanged()
	Q_REVISION (6, 12) void bodyBChanged()
	Q_REVISION (6, 12) void positionAChanged()
	Q_REVISION (6, 12) void positionBChanged()
	Q_REVISION (6, 12) void orientationAChanged()
	Q_REVISION (6, 12) void orientationBChanged()
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	Q_REVISION (6, 13) float stiffness() const
	Q_REVISION (6, 13) void setStiffness(float stiffness)
	Q_REVISION (6, 13) float damping() const
	Q_REVISION (6, 13) void setDamping(float damping)
Public Member Functions inherited from QPhysicsJoint
	QPhysicsJoint ()
	\qmltype PhysicsJoint \inqmlmodule QtQuick3D.Physics
	~QPhysicsJoint ()
	Q_REVISION (6, 12) QAbstractPhysicsBody *bodyA() const
	Q_REVISION (6, 12) void setBodyA(QAbstractPhysicsBody *newBodyA)
	Q_REVISION (6, 12) QAbstractPhysicsBody *bodyB() const
	Q_REVISION (6, 12) void setBodyB(QAbstractPhysicsBody *newBodyB)
	Q_REVISION (6, 12) QVector3D positionA() const
	Q_REVISION (6, 12) void setPositionA(const QVector3D &newPositionA)
	Q_REVISION (6, 12) QVector3D positionB() const
	Q_REVISION (6, 12) void setPositionB(const QVector3D &newPositionB)
	Q_REVISION (6, 12) QQuaternion orientationA() const
	Q_REVISION (6, 12) void setOrientationA(const QQuaternion &newOrientationA)
	Q_REVISION (6, 12) QQuaternion orientationB() const
	Q_REVISION (6, 12) void setOrientationB(const QQuaternion &newOrientationB)
void	updatePhysXBackend ()
physx::PxJoint *	getPhysXBackend () const
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject *watched, QEvent *event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false.
bool	isWindowType () const
	Returns true if the object is a window; otherwise returns false.
bool	isQuickItemType () const
	Returns true if the object is a QQuickItem; otherwise returns false.
bool	isQmlExposed () const noexcept
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns true if signals are blocked; otherwise returns false.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns true on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject *receiver, const char *member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Protected Attributes
float	m_stiffness = 0.0f
float	m_damping = 0.0f
Protected Attributes inherited from QPhysicsJoint
QAbstractPhysicsBody *	m_bodyA = nullptr
QAbstractPhysicsBody *	m_bodyB = nullptr
QVector3D	m_positionA
QVector3D	m_positionB
QQuaternion	m_orientationA
QQuaternion	m_orientationB
physx::PxJoint *	m_joint = nullptr
bool	m_needsRebuild = false
bool	m_dirtyProperties = false
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties
float	stiffness
	\qmltype FlexibleJoint \inqmlmodule QtQuick3D.Physics
float	damping
Properties inherited from QPhysicsJoint
QAbstractPhysicsBody *	bodyA
QAbstractPhysicsBody *	bodyB
QVector3D	positionA
QVector3D	positionB
QQuaternion	orientationA
QQuaternion	orientationB
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
	\threadsafe
static bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool	disconnect (QMetaObject::Connection &)
static bool	disconnect (QMetaObject::Connection &&conn)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Member Functions inherited from QPhysicsJoint
virtual physx::PxJoint *	createPhysxJoint (physx::PxRigidActor *actorA, physx::PxRigidActor *actorB, const physx::PxTransform &trfA, const physx::PxTransform &trfB)=0
virtual void	setJointProperties ()=0
void	onBodyDestroyed (QObject *body)
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 23 of file qflexiblejoint_p.h.

Member Function Documentation

Q_REVISION() [1/6]

QFlexibleJoint::Q_REVISION	(	6	,
		13	) const

Q_REVISION() [2/6]

QFlexibleJoint::Q_REVISION	(	6	,
		13	) const

Q_REVISION [3/6]

QFlexibleJoint::Q_REVISION ( 6 , 13  )

signal

Q_REVISION() [4/6]

QFlexibleJoint::Q_REVISION	(	6	,
		13	)

Q_REVISION() [5/6]

QFlexibleJoint::Q_REVISION	(	6	,
		13	)

Q_REVISION [6/6]

QFlexibleJoint::Q_REVISION ( 6 , 13  )

signal

Member Data Documentation

m_damping

float QFlexibleJoint::m_damping = 0.0f

protected

Definition at line 47 of file qflexiblejoint_p.h.

m_stiffness

float QFlexibleJoint::m_stiffness = 0.0f

protected

Definition at line 46 of file qflexiblejoint_p.h.

Property Documentation

damping

float QFlexibleJoint::damping

readwrite

Definition at line 28 of file qflexiblejoint_p.h.

stiffness

QT_BEGIN_NAMESPACE float QFlexibleJoint::stiffness

readwrite

\qmltype FlexibleJoint \inqmlmodule QtQuick3D.Physics

Since

6.13 \inherits PhysicsJoint

Base type for flexible joints with configurable spring stiffness and damping.

This is the abstract base type for all joints that support customizable spring stiffness and damping factors for soft constraints and joint limits.

Whether a joint limit is hard or soft, and how it behaves when soft, depends on the combination of \l stiffness and \l damping, as seen in the following table:

\table \header

• \l stiffness
• \l damping
• Behavior \row
• 0.0
• 0.0
• Hard constraint: the limit cannot be penetrated (the default). \row
• greater than 0.0
• 0.0
• Soft spring, undamped: the body bounces against the limit indefinitely. \row
• greater than 0.0
• greater than 0.0
• Soft spring, damped: the body bounces against the limit and settles. \row
• 0.0
• greater than 0.0
• Soft, viscous drag only: motion is resisted, but no positional restoring force is applied. \endtable

Note

At least one of the connected bodies needs to be dynamic.

See also

{FixedJoint}

{DistanceJoint}

{PrismaticJoint}

{RevoluteJoint}

{SphericalJoint}

{D6Joint}

\qmlproperty real FlexibleJoint::stiffness

Since

6.13 \default 0.0

This property holds the spring stiffness for joint limits. See the table above for how it combines with \l damping to determine whether the limit is hard or soft.

When greater than 0.0, the higher the value, the stronger the restorative force pulling the body back once it crosses the limit boundary, and the less penetration is allowed before the body is pushed back. The right value depends on the mass and geometry of the connected bodies. A value that feels stiff for a light body with a short lever arm may feel soft for a heavier body or a longer lever arm, so start from a small value and increase it until the limit feels sufficiently rigid for your scene.

Range: {[0, \inf)}

See also

damping, PhysicsWorld::typicalLength, PhysicsWorld::defaultDensity

\qmlproperty real FlexibleJoint::damping

Since

6.13 \default 0.0

This property holds the energy dissipation (damping factor) for soft joint limits. See the table above for how it combines with \l stiffness to determine whether the limit is hard or soft.

When \l stiffness is greater than 0.0, this property controls how quickly oscillations around the limit boundary settle: with 0.0 (the default), no energy is lost and the body bounces indefinitely; increasing the value suppresses the bounce, though too little leaves the body oscillating before it settles, while too much makes the motion near the limit feel heavy or sluggish.

When \l stiffness is 0.0, this property instead applies a resistive (viscous) force with no positional restoring effect.

Range: {[0, \inf)}

See also

stiffness, PhysicsWorld::typicalLength, PhysicsWorld::defaultDensity

Definition at line 27 of file qflexiblejoint_p.h.

---

The documentation for this class was generated from the following files:

• qtquick3dphysics/src/quick3dphysics/joints/qflexiblejoint_p.h (d2413d93ff7eb83bb02718dc151d8fbaf6335360)
• qtquick3dphysics/src/quick3dphysics/joints/qflexiblejoint.cpp (d2413d93ff7eb83bb02718dc151d8fbaf6335360)