#include <qquick3dxractionmapper_p.h>

Inheritance diagram for QQuick3DXrInputAction:

Collaboration diagram for QQuick3DXrInputAction:

Public Types
enum	Hand : quint8 { LeftHand = 0 , RightHand , Unknown }

enum	Action : qint16 { CustomAction = -1 , Button1Pressed , Button1Touched , Button2Pressed , Button2Touched , ButtonMenuPressed , ButtonMenuTouched , ButtonSystemPressed , ButtonSystemTouched , SqueezeValue , SqueezeForce , SqueezePressed , TriggerValue , TriggerPressed , TriggerTouched , ThumbstickX , ThumbstickY , ThumbstickPressed , ThumbstickTouched , ThumbrestTouched , TrackpadX , TrackpadY , TrackpadForce , TrackpadTouched , TrackpadPressed , IndexFingerPinch , MiddleFingerPinch , RingFingerPinch , LittleFingerPinch , HandTrackingMenuPress , NumHandActions , NumActions }

Signals
void	valueChanged ()

void	pressedChanged ()

void	triggered ()

void	actionNameChanged ()

void	actionIdChanged ()

void	handChanged ()

void	enabledChanged ()

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
	QQuick3DXrInputAction (QObject *parent=nullptr)

	~QQuick3DXrInputAction () override

float	value () const
	\qmlproperty float XrInputAction::value

void	setValue (float newValue)
	\qmltype XrInputAction \inherits QtObject \inqmlmodule QtQuick3D.Xr

bool	pressed () const
	\qmlproperty bool XrInputAction::pressed

void	setPressed (bool newPressed)

QString	actionName () const
	\qmlproperty string XrInputAction::actionName

void	setActionName (const QString &newActionName)

QList< Action >	actionId () const
	\qmlproperty List<enumeration> XrInputAction::actionId

void	setActionId (const QList< Action > &newActionId)

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.

Hand	hand () const
	\qmlproperty enumeration QtQuick3D.Xr::XrInputAction::hand

void	setHand (Hand newHand)

bool	enabled () const
	\qmlproperty bool XrInputAction::enabled

void	setEnabled (bool newEnabled)

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	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
float	value

bool	pressed

QString	actionName

QList< Action >	actionId

bool	enabled

Hand	hand

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 &)
	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 29 of file qquick3dxractionmapper_p.h.

Member Enumeration Documentation

◆ Action

enum QQuick3DXrInputAction::Action : qint16

Enumerator
CustomAction
Button1Pressed
Button1Touched
Button2Pressed
Button2Touched
ButtonMenuPressed
ButtonMenuTouched
ButtonSystemPressed
ButtonSystemTouched
SqueezeValue
SqueezeForce
SqueezePressed
TriggerValue
TriggerPressed
TriggerTouched
ThumbstickX
ThumbstickY
ThumbstickPressed
ThumbstickTouched
ThumbrestTouched
TrackpadX
TrackpadY
TrackpadForce
TrackpadTouched
TrackpadPressed
IndexFingerPinch
MiddleFingerPinch
RingFingerPinch
LittleFingerPinch
HandTrackingMenuPress
NumHandActions
NumActions

Definition at line 54 of file qquick3dxractionmapper_p.h.

◆ Hand

enum QQuick3DXrInputAction::Hand : quint8

Enumerator
LeftHand
RightHand
Unknown

Definition at line 47 of file qquick3dxractionmapper_p.h.

Constructor & Destructor Documentation

◆ QQuick3DXrInputAction()

QQuick3DXrInputAction::QQuick3DXrInputAction ( QObject * parent = nullptr )

explicit

Definition at line 175 of file qquick3dxractionmapper.cpp.

◆ ~QQuick3DXrInputAction()

QQuick3DXrInputAction::~QQuick3DXrInputAction ( )

override

Definition at line 180 of file qquick3dxractionmapper.cpp.

References QQuick3DXrActionMapper::removeAction().

Here is the call graph for this function:

Member Function Documentation

◆ actionId()

QList< QQuick3DXrInputAction::Action > QQuick3DXrInputAction::actionId ( ) const

\qmlproperty List<enumeration> XrInputAction::actionId

Specifies the action(s) to react to

Holds a List of IDs that can be of the following values:

\value XrInputAction.Button1Pressed Button 1 is pressed. Boolean. \value XrInputAction.Button1Touched Button 1 is touched. Boolean. \value XrInputAction.Button2Pressed Button 2 is pressed. Boolean. \value XrInputAction.Button2Touched Button 2 is touched. Boolean. \value XrInputAction.ButtonMenuPressed The menu button is pressed. Boolean. \value XrInputAction.ButtonMenuTouched The menu button is touched. Boolean. \value XrInputAction.ButtonSystemPressed The system button is pressed. Boolean. \value XrInputAction.ButtonSystemTouched The system button is touched. Boolean. \value XrInputAction.SqueezeValue How far the grip button is pressed. Analog. \value XrInputAction.SqueezeForce The force applied to the grip button. Analog. \value XrInputAction.SqueezePressed The grip button is pressed. Boolean. \value XrInputAction.TriggerValue How far the trigger button is pressed. Analog. \value XrInputAction.TriggerPressed The trigger is pressed. Boolean. \value XrInputAction.TriggerTouched The trigger is touched. Boolean. \value XrInputAction.ThumbstickX The X-axis value of the thumbstick. Analog. \value XrInputAction.ThumbstickY The Y-axis value of the thumbstick. Analog. \value XrInputAction.ThumbstickPressed The thumbstick is pressed. Boolean. \value XrInputAction.ThumbstickTouched The thumbstick is touched. Boolean. \value XrInputAction.ThumbrestTouched The thumbrest is touched. Boolean. \value XrInputAction.TrackpadX The X-axis position on the trackpad. Analog. \value XrInputAction.TrackpadY The Y-axis position on the trackpad. Analog. \value XrInputAction.TrackpadForce The force applied on the trackpad. Analog. \value XrInputAction.TrackpadTouched The trackpad is touched. Boolean. \value XrInputAction.TrackpadPressed The trackpad is pressed. Boolean. \value XrInputAction.IndexFingerPinch Thumb to index finger pinch gesture. Boolean. \value XrInputAction.MiddleFingerPinch Thumb to middle finger pinch gesture. Boolean. \value XrInputAction.RingFingerPinch Thumb to ring finger pinch gesture. Boolean. \value XrInputAction.LittleFingerPinch Thumb to little finger pinch gesture. Boolean. \value XrInputAction.HandTrackingMenuPress Hand tracking menu gesture. Boolean.

Definition at line 245 of file qquick3dxractionmapper.cpp.

◆ actionIdChanged

void QQuick3DXrInputAction::actionIdChanged ( )

signal

◆ actionName()

QString QQuick3DXrInputAction::actionName ( ) const

\qmlproperty string XrInputAction::actionName

The name of the input action.

Use this property to specify the name of the custom input action you want to react to. This property does not have an effect if \l actionId is set.

Definition at line 157 of file qquick3dxractionmapper.cpp.

◆ actionNameChanged

void QQuick3DXrInputAction::actionNameChanged ( )

signal

◆ classBegin()

void QQuick3DXrInputAction::classBegin ( )

overridevirtual

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

Implements QQmlParserStatus.

Definition at line 198 of file qquick3dxractionmapper.cpp.

◆ componentComplete()

void QQuick3DXrInputAction::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 202 of file qquick3dxractionmapper.cpp.

References QQuick3DXrActionMapper::registerAction().

Here is the call graph for this function:

◆ enabled()

bool QQuick3DXrInputAction::enabled ( ) const

\qmlproperty bool XrInputAction::enabled

Since: 6.9

This property determines whether the input action will react to events. \default true

Definition at line 300 of file qquick3dxractionmapper.cpp.

◆ enabledChanged

void QQuick3DXrInputAction::enabledChanged ( )

signal

◆ hand()

QQuick3DXrInputAction::Hand QQuick3DXrInputAction::hand ( ) const

\qmlproperty enumeration QtQuick3D.Xr::XrInputAction::hand

The Hand that this input action will apply to.

Specifies the hand ro react to.

It can be one of:

\value XrInputAction.LeftHand \value XrInputAction.RightHand \value XrInputAction.Unknown

Definition at line 279 of file qquick3dxractionmapper.cpp.

◆ handChanged

void QQuick3DXrInputAction::handChanged ( )

signal

◆ pressed()

bool QQuick3DXrInputAction::pressed ( ) const

\qmlproperty bool XrInputAction::pressed

Indicates whether the input action is currently pressed.

Use this property to check if the input action (for example, a button) is currently pressed.

Definition at line 135 of file qquick3dxractionmapper.cpp.

◆ pressedChanged

void QQuick3DXrInputAction::pressedChanged ( )

signal

◆ setActionId()

void QQuick3DXrInputAction::setActionId ( const QList< Action > & newActionId )

Definition at line 250 of file qquick3dxractionmapper.cpp.

References QQuick3DXrActionMapper::registerAction(), and QQuick3DXrActionMapper::removeAction().

Here is the call graph for this function:

◆ setActionName()

void QQuick3DXrInputAction::setActionName ( const QString & newActionName )

Definition at line 162 of file qquick3dxractionmapper.cpp.

References QQuick3DXrActionMapper::registerAction(), and QQuick3DXrActionMapper::removeAction().

Here is the call graph for this function:

◆ setEnabled()

void QQuick3DXrInputAction::setEnabled ( bool newEnabled )

Definition at line 305 of file qquick3dxractionmapper.cpp.

◆ setHand()

void QQuick3DXrInputAction::setHand ( Hand newHand )

Definition at line 284 of file qquick3dxractionmapper.cpp.

◆ setPressed()

void QQuick3DXrInputAction::setPressed ( bool newPressed )

Definition at line 140 of file qquick3dxractionmapper.cpp.

◆ setValue()

void QQuick3DXrInputAction::setValue ( float newValue )

\qmltype XrInputAction \inherits QtObject \inqmlmodule QtQuick3D.Xr

Represents an action from an input controller.

Actions can be boolean, such as a button press, or analog, such as a joystick axis.

Use the \l pressed property or the \l triggered signal to react to a boolean action. An analog action will set the \l value property.

Note: For convenience, an analog property will also set the pressed property and emit the triggered signal, while a boolean property will set value to 1.0 when pressed.

The following shows how to react to either the right hand grip being pressed or to a right hand pinch gesture from hand tracking:

\qml XrInputAction { hand: XrInputAction.RightHand actionId: [XrInputAction.SqueezePressed, XrInputAction.SqueezeValue, XrInputAction.IndexFingerPinch] onTriggered: console.log("Do action here.") } \endqml

The reason for specifying both SqueezePressed and SqueezeValue is that some controllers have an analog grip button, and some controllers just have an on/off grip switch.

\qmlsignal XrInputAction::triggered()

This signal is emitted when a boolean action is activated. This happens at the same time as the \l pressed property is set to true.

Definition at line 119 of file qquick3dxractionmapper.cpp.

◆ triggered

void QQuick3DXrInputAction::triggered ( )

signal

◆ value()

float QQuick3DXrInputAction::value ( ) const

\qmlproperty float XrInputAction::value

The analog value of the input action.

For analog inputs, such as a thumbstick position, this property holds the value of the input (usually in the range [0, 1]).

Definition at line 193 of file qquick3dxractionmapper.cpp.

◆ valueChanged

void QQuick3DXrInputAction::valueChanged ( )

signal

Property Documentation

◆ actionId

QList<Action> QQuick3DXrInputAction::actionId

readwrite

Definition at line 39 of file qquick3dxractionmapper_p.h.

◆ actionName

QString QQuick3DXrInputAction::actionName

readwrite

Definition at line 38 of file qquick3dxractionmapper_p.h.

◆ enabled

bool QQuick3DXrInputAction::enabled

readwrite

Definition at line 40 of file qquick3dxractionmapper_p.h.

◆ hand

Hand QQuick3DXrInputAction::hand

readwrite

Definition at line 42 of file qquick3dxractionmapper_p.h.

◆ pressed

bool QQuick3DXrInputAction::pressed

read

Definition at line 37 of file qquick3dxractionmapper_p.h.

◆ value

float QQuick3DXrInputAction::value

read

Definition at line 36 of file qquick3dxractionmapper_p.h.

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

qtquick3d/src/xr/quick3dxr/qquick3dxractionmapper_p.h (95c2fff3692252d71bb5e08b8ca829a8b0f08872)
qtquick3d/src/xr/quick3dxr/qquick3dxractionmapper.cpp (e334c1578da9e075e3aefda790188e175fa944b4)

Public Types

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Action

◆ Hand

Constructor & Destructor Documentation

◆ QQuick3DXrInputAction()

◆ ~QQuick3DXrInputAction()

Member Function Documentation

◆ actionId()

◆ actionIdChanged

◆ actionName()

◆ actionNameChanged

◆ classBegin()

◆ componentComplete()

◆ enabled()

◆ enabledChanged

◆ hand()

◆ handChanged

◆ pressed()

◆ pressedChanged

◆ setActionId()

◆ setActionName()

◆ setEnabled()

◆ setHand()

◆ setPressed()

◆ setValue()

◆ triggered

◆ value()

◆ valueChanged

Property Documentation

◆ actionId

◆ actionName

◆ enabled

◆ hand

◆ pressed

◆ value