#include <qquick3dxractionmapper_p.h>

Inheritance diagram for QQuick3DXrHapticFeedback:

Collaboration diagram for QQuick3DXrHapticFeedback:

Public Types
enum class	Controller : quint8 { LeftController = 0 , RightController , UnknownController }
enum class	Condition : quint8 { RisingEdge = 0 , TrailingEdge }

Public Slots
void	start ()
	\qmlmethod void XrHapticFeedback::start
void	stop ()
	\qmlmethod void XrHapticFeedback::stop
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	controllerChanged ()
void	hapticEffectChanged ()
void	triggerChanged ()
void	conditionChanged ()
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
	QQuick3DXrHapticFeedback (QObject *parent=nullptr)
	\qmltype XrHapticFeedback \inherits QtObject \inqmlmodule QtQuick3D.Xr
	~QQuick3DXrHapticFeedback () override
void	classBegin () override
	Invoked after class creation, but before any properties have been set.
void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.
QQuick3DXrAbstractHapticEffect *	hapticEffect () const
	\qmlproperty XrHapticEffect XrHapticFeedback::hapticEffect
void	setHapticEffect (QQuick3DXrAbstractHapticEffect *newHapticEffect)
Controller	controller () const
	\qmlproperty enumeration QtQuick3D.Xr::XrHapticFeedback::controller
void	setController (Controller newController)
bool	trigger ()
void	setTrigger (bool newTrigger)
enum Condition	condition () const
	\qmlproperty enumeration QtQuick3D.Xr::XrHapticFeedback::condition
void	setCondition (enum Condition newCondition)
bool	testAndClear ()
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	isQmlObjectType () const
	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`.
Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()
virtual	~QQmlParserStatus ()

Properties
Controller	controller
QQuick3DXrAbstractHapticEffect *	hapticEffect
bool	trigger
	\qmlproperty bool XrHapticFeedback::trigger
Condition	condition
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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 &)
	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 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)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
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 146 of file qquick3dxractionmapper_p.h.

Member Enumeration Documentation

◆ Condition

enum class QQuick3DXrHapticFeedback::Condition : quint8

strong

Enumerator
RisingEdge
TrailingEdge

Definition at line 168 of file qquick3dxractionmapper_p.h.

◆ Controller

enum class QQuick3DXrHapticFeedback::Controller : quint8

strong

Enumerator
LeftController
RightController
UnknownController

Definition at line 161 of file qquick3dxractionmapper_p.h.

Constructor & Destructor Documentation

◆ QQuick3DXrHapticFeedback()

QQuick3DXrHapticFeedback::QQuick3DXrHapticFeedback ( QObject * parent = nullptr )

explicit

\qmltype XrHapticFeedback \inherits QtObject \inqmlmodule QtQuick3D.Xr

Controls haptic feedback for an XR controller.

Since: 6.9

Haptic feedback typically involves applying a short vibration to a controller to provide a tactile experience when an event happens. This can give the illusion of touching a button, for example.

There are two ways of using XrHapticFeedback:

\list

Imperatively, by calling the \l start function
Declaratively, by specifying \l trigger and \l condition \endlist

The following code makes the right-hand controller vibrate when the value of the someObject.hit property changes from false to true:

\qml XrHapticFeedback { controller: XrHapticFeedback.RightController condition: XrHapticFeedback.RisingEdge trigger: someObject.hit hapticEffect: XrSimpleHapticEffect { amplitude: 0.5 duration: 300 frequency: 3000 } } \endqml

Definition at line 399 of file qquick3dxractionmapper.cpp.

◆ ~QQuick3DXrHapticFeedback()

QQuick3DXrHapticFeedback::~QQuick3DXrHapticFeedback ( )

override

Definition at line 404 of file qquick3dxractionmapper.cpp.

References QQuick3DXrActionMapper::removeHapticEffect().

Here is the call graph for this function:

Member Function Documentation

◆ classBegin()

void QQuick3DXrHapticFeedback::classBegin ( )

overridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 409 of file qquick3dxractionmapper.cpp.

◆ componentComplete()

void QQuick3DXrHapticFeedback::componentComplete ( )

overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 413 of file qquick3dxractionmapper.cpp.

◆ condition()

enum QQuick3DXrHapticFeedback::Condition QQuick3DXrHapticFeedback::condition ( ) const

\qmlproperty enumeration QtQuick3D.Xr::XrHapticFeedback::condition

The condition for triggering this haptic feedback. \default XrHapticFeedback.RisingEdge

This property specifies how the \l trigger property is interpreted

It can be one of:

\value XrHapticFeedback.RisingEdge The haptic effect starts when \l trigger changes from false to true. \value XrHapticFeedback.TrailingEdge The haptic effect starts when \l trigger changes from true to false.

Definition at line 508 of file qquick3dxractionmapper.cpp.

◆ conditionChanged

void QQuick3DXrHapticFeedback::conditionChanged ( )

signal

◆ controller()

QQuick3DXrHapticFeedback::Controller QQuick3DXrHapticFeedback::controller ( ) const

\qmlproperty enumeration QtQuick3D.Xr::XrHapticFeedback::controller

The Controller that this haptic feedback will apply to.

It can be one of:

\value XrHapticFeedback.LeftController \value XrHapticFeedback.RightController \value XrHapticFeedback.UnknownController

Definition at line 430 of file qquick3dxractionmapper.cpp.

◆ controllerChanged

void QQuick3DXrHapticFeedback::controllerChanged ( )

signal

◆ hapticEffect()

QQuick3DXrAbstractHapticEffect * QQuick3DXrHapticFeedback::hapticEffect ( ) const

\qmlproperty XrHapticEffect XrHapticFeedback::hapticEffect

This property describes the effect that is applied to the controller when the haptic feedback is triggered.

Definition at line 483 of file qquick3dxractionmapper.cpp.

◆ hapticEffectChanged

void QQuick3DXrHapticFeedback::hapticEffectChanged ( )

signal

◆ setCondition()

void QQuick3DXrHapticFeedback::setCondition ( enum Condition newCondition )

Definition at line 513 of file qquick3dxractionmapper.cpp.

◆ setController()

void QQuick3DXrHapticFeedback::setController ( Controller newController )

Definition at line 435 of file qquick3dxractionmapper.cpp.

◆ setHapticEffect()

void QQuick3DXrHapticFeedback::setHapticEffect ( QQuick3DXrAbstractHapticEffect * newHapticEffect )

Definition at line 488 of file qquick3dxractionmapper.cpp.

◆ setTrigger()

void QQuick3DXrHapticFeedback::setTrigger ( bool newTrigger )

Definition at line 457 of file qquick3dxractionmapper.cpp.

◆ start

void QQuick3DXrHapticFeedback::start ( )

slot

\qmlmethod void XrHapticFeedback::start

Starts the haptic feedback effect

Definition at line 525 of file qquick3dxractionmapper.cpp.

◆ stop

void QQuick3DXrHapticFeedback::stop ( )

slot

\qmlmethod void XrHapticFeedback::stop

Stops the haptic feedback effect

Definition at line 534 of file qquick3dxractionmapper.cpp.

◆ testAndClear()

bool QQuick3DXrHapticFeedback::testAndClear ( )

Definition at line 539 of file qquick3dxractionmapper.cpp.

◆ trigger()

bool QQuick3DXrHapticFeedback::trigger ( )

◆ triggerChanged

void QQuick3DXrHapticFeedback::triggerChanged ( )

signal

Property Documentation

◆ condition

Condition QQuick3DXrHapticFeedback::condition

readwrite

Definition at line 156 of file qquick3dxractionmapper_p.h.

◆ controller

Controller QQuick3DXrHapticFeedback::controller

readwrite

Definition at line 153 of file qquick3dxractionmapper_p.h.

◆ hapticEffect

QQuick3DXrAbstractHapticEffect * QQuick3DXrHapticFeedback::hapticEffect

readwrite

Definition at line 154 of file qquick3dxractionmapper_p.h.

◆ trigger

bool QQuick3DXrHapticFeedback::trigger

readwrite

\qmlproperty bool XrHapticFeedback::trigger

Trigger for the haptic feedback

This property defines what the haptic effect will react to. The \l condition property determines how the trigger is interpreted.

See also: start condition

Definition at line 155 of file qquick3dxractionmapper_p.h.

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

qtquick3d/src/xr/quick3dxr/qquick3dxractionmapper_p.h (4a1b2d9ba822fef7e361fc1702e1dfe0e8f2b7ce)
qtquick3d/src/xr/quick3dxr/qquick3dxractionmapper.cpp (4a1b2d9ba822fef7e361fc1702e1dfe0e8f2b7ce)

Public Types

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Condition

◆ Controller

Constructor & Destructor Documentation

◆ QQuick3DXrHapticFeedback()

◆ ~QQuick3DXrHapticFeedback()

Member Function Documentation

◆ classBegin()

◆ componentComplete()

◆ condition()

◆ conditionChanged

◆ controller()

◆ controllerChanged

◆ hapticEffect()

◆ hapticEffectChanged

◆ setCondition()

◆ setController()

◆ setHapticEffect()

◆ setTrigger()

◆ start

◆ stop

◆ testAndClear()

◆ trigger()

◆ triggerChanged

Property Documentation

◆ condition

◆ controller

◆ hapticEffect

◆ trigger