Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Signals | Public Member Functions | Properties | List of all members
QQuick3DXrInputAction Class Reference

#include <qquick3dxractionmapper_p.h>

+ Inheritance diagram for QQuick3DXrInputAction:
+ Collaboration diagram for QQuick3DXrInputAction:

Public Types

enum  Hand : quint8 { Unknown = 0 , LeftHand , RightHand }
 
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 ()
 
- 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)
 
float value () const
 \qmlproperty float XrInputAction::value
 
void setValue (float newValue)
 \qmltype XrInputAction \inherits Item \inqmlmodule QtQuick3D.Xr
 
bool pressed () const
 \qmlproperty bool XrInputAction::pressed
 
void setPressed (bool newPressed)
 
QString actionName () const
 \qmlproperty string QQuick3DXrInputAction::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
 
void setHand (Hand newHand)
 
- 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
 
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
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \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 53 of file qquick3dxractionmapper_p.h.

◆ Hand

enum QQuick3DXrInputAction::Hand : quint8
Enumerator
Unknown 
LeftHand 
RightHand 

Definition at line 46 of file qquick3dxractionmapper_p.h.

Constructor & Destructor Documentation

◆ QQuick3DXrInputAction()

QQuick3DXrInputAction::QQuick3DXrInputAction ( QObject * parent = nullptr)
explicit

Definition at line 150 of file qquick3dxractionmapper.cpp.

Member Function Documentation

◆ actionId()

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

\qmlproperty List<enumeration> XrInputAction::actionId

The value associated with the input action.

Holds a List of InputActions Ids, that can be of the following values:

\value XrActionmappter.CustomAction Represents a custom action with a value of -1. \value XrActionmappter.Button1Pressed Indicates that Button 1 is pressed. \value XrActionMapper.Button1Touched Indicates that Button 1 is touched. \value XrActionMapper.Button2Pressed Indicates that Button 2 is pressed. \value XrActionMapper.Button2Touched Indicates that Button 2 is touched. \value XrActionMapper.ButtonMenuPressed Indicates that the menu button is pressed. \value XrActionMapper.ButtonMenuTouched Indicates that the menu button is touched. \value XrActionMapper.ButtonSystemPressed Indicates that the system button is pressed. \value XrActionMapper.ButtonSystemTouched Indicates that the system button is touched. \value XrActionMapper.SqueezeValue Represents the squeeze value in a controller. \value XrActionMapper.SqueezeForce Represents the force of a squeeze action. \value XrActionMapper.SqueezePressed Indicates that the squeeze action is pressed. \value XrActionMapper.TriggerValue Represents the value of the trigger (for example, how much it's pressed). \value XrActionMapper.TriggerPressed Indicates that the trigger is pressed. \value XrActionMapper.TriggerTouched Indicates that the trigger is touched. \value XrActionMapper.ThumbstickX Represents the X-axis value of the thumbstick. \value XrActionMapper.ThumbstickY Represents the Y-axis value of the thumbstick. \value XrActionMapper.ThumbstickPressed Indicates that the thumbstick is pressed. \value XrActionMapper.ThumbstickTouched Indicates that the thumbstick is touched. \value XrActionMapper.ThumbrestTouched Indicates that the thumbrest is touched. \value XrActionMapper.TrackpadX Represents the X-axis value of the trackpad. \value XrActionMapper.TrackpadY Represents the Y-axis value of the trackpad. \value XrActionMapper.TrackpadForce Represents the force applied on the trackpad. \value XrActionMapper.TrackpadTouched Indicates that the trackpad is touched. \value XrActionMapper.TrackpadPressed Indicates that the trackpad is pressed. \value XrActionMapper.IndexFingerPinch Indicates that the index finger is pinched. \value XrActionMapper.MiddleFingerPinch Indicates that the middle finger is pinched. \value XrActionMapper.RingFingerPinch Indicates that the ring finger is pinched. \value XrActionMapper.LittleFingerPinch Indicates that the little finger is pinched. \value XrActionMapper.HandTrackingMenuPress Indicates a menu press in hand tracking. \value XrActionMapper.NumHandActions Represents the total number of hand actions. \value XrActionMapper.NumActions Number of actions.

Definition at line 237 of file qquick3dxractionmapper.cpp.

◆ actionIdChanged

void QQuick3DXrInputAction::actionIdChanged ( )
signal

Referenced by setActionId().

+ Here is the caller graph for this function:

◆ actionName()

QString QQuick3DXrInputAction::actionName ( ) const

\qmlproperty string QQuick3DXrInputAction::actionName

The name of the input action.

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

Definition at line 132 of file qquick3dxractionmapper.cpp.

◆ actionNameChanged

void QQuick3DXrInputAction::actionNameChanged ( )
signal

Referenced by setActionName().

+ Here is the caller graph for this function:

◆ classBegin()

void QQuick3DXrInputAction::classBegin ( )
overridevirtual

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

Implements QQmlParserStatus.

Definition at line 168 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 172 of file qquick3dxractionmapper.cpp.

References QQuick3DXrActionMapper::registerAction().

+ Here is the call graph for this function:

◆ hand()

QQuick3DXrInputAction::Hand QQuick3DXrInputAction::hand ( ) const

Definition at line 259 of file qquick3dxractionmapper.cpp.

◆ handChanged

void QQuick3DXrInputAction::handChanged ( )
signal

Referenced by setHand().

+ Here is the caller graph for this function:

◆ 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 110 of file qquick3dxractionmapper.cpp.

◆ pressedChanged

void QQuick3DXrInputAction::pressedChanged ( )
signal

Referenced by setPressed().

+ Here is the caller graph for this function:

◆ setActionId()

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

Definition at line 242 of file qquick3dxractionmapper.cpp.

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

+ Here is the call graph for this function:

◆ setActionName()

void QQuick3DXrInputAction::setActionName ( const QString & newActionName)

Definition at line 137 of file qquick3dxractionmapper.cpp.

References actionNameChanged(), emit, QList< T >::isEmpty(), QQuick3DXrActionMapper::registerAction(), and QQuick3DXrActionMapper::removeAction().

+ Here is the call graph for this function:

◆ setHand()

void QQuick3DXrInputAction::setHand ( Hand newHand)

Definition at line 264 of file qquick3dxractionmapper.cpp.

References emit, and handChanged().

+ Here is the call graph for this function:

◆ setPressed()

void QQuick3DXrInputAction::setPressed ( bool newPressed)

Definition at line 115 of file qquick3dxractionmapper.cpp.

References emit, pressedChanged(), and triggered().

+ Here is the call graph for this function:

◆ setValue()

void QQuick3DXrInputAction::setValue ( float newValue)

\qmltype XrInputAction \inherits Item \inqmlmodule QtQuick3D.Xr

Maps input actions to corresponding actions.

Definition at line 94 of file qquick3dxractionmapper.cpp.

References emit, qFuzzyCompare(), and valueChanged().

+ Here is the call graph for this function:

◆ triggered

void QQuick3DXrInputAction::triggered ( )
signal

Referenced by setPressed().

+ Here is the caller graph for this function:

◆ value()

float QQuick3DXrInputAction::value ( ) const

\qmlproperty float XrInputAction::value

The value associated with 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 163 of file qquick3dxractionmapper.cpp.

◆ valueChanged

void QQuick3DXrInputAction::valueChanged ( )
signal

Referenced by setValue().

+ Here is the caller graph for this function:

Property Documentation

◆ actionId

QList<Action> QQuick3DXrInputAction::actionId
readwrite

Definition at line 39 of file qquick3dxractionmapper_p.h.

Referenced by QQuick3DXrActionMapper::registerAction(), and QQuick3DXrActionMapper::removeAction().

◆ actionName

QString QQuick3DXrInputAction::actionName
readwrite

Definition at line 38 of file qquick3dxractionmapper_p.h.

Referenced by QQuick3DXrActionMapper::registerAction(), and QQuick3DXrActionMapper::removeAction().

◆ hand

Hand QQuick3DXrInputAction::hand
readwrite

Definition at line 41 of file qquick3dxractionmapper_p.h.

Referenced by QQuick3DXrActionMapper::registerAction(), and QQuick3DXrActionMapper::removeAction().

◆ 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: