Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQuick3DXrVirtualMouse Class Reference

#include <qquick3dxrvirtualmouse_p.h>

+ Inheritance diagram for QQuick3DXrVirtualMouse:
+ Collaboration diagram for QQuick3DXrVirtualMouse:

Public Slots

void setRightMouseButton (bool rightMouseButton)
 
void setLeftMouseButton (bool leftMouseButton)
 
void setMiddleMouseButton (bool middleMouseButton)
 
void setScrollWheelX (float scrollWheelX)
 
void setScrollWheelY (float scrollWheelY)
 
void setScrollTimerInterval (int scrollTimerInterval)
 
void setScrollPixelDelta (int scrollPixelDelta)
 
void setSource (QQuick3DNode *source)
 
void setView (QQuick3DXrView *view)
 
void setEnabled (bool enabled)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void rightMouseButtonChanged (bool rightMouseButton)
 
void leftMouseButtonChanged (bool leftMouseButton)
 
void middleMouseButtonChanged (bool middleMouseButton)
 
void scrollWheelXChanged (float scrollWheelX)
 
void scrollWheelYChanged (float scrollWheelY)
 
void scrollTimerIntervalChanged (int scrollTimerInterval)
 
void scrollPixelDeltaChanged (int scrollPixelDelta)
 
void sourceChanged (QQuick3DNode *source)
 
void viewChanged (QQuick3DXrView *view)
 
void enabledChanged (bool enabled)
 
- 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

 QQuick3DXrVirtualMouse (QObject *parent=nullptr)
 
bool rightMouseButton () const
 \qmlproperty bool XrVirtualMouse::rightMouseButton
 
bool leftMouseButton () const
 \qmlproperty bool XrVirtualMouse::leftMouseButton
 
bool middleMouseButton () const
 \qmlproperty bool XrVirtualMouse::middleMouseButton
 
float scrollWheelX () const
 \qmlproperty float XrVirtualMouse::scrollWheelX
 
float scrollWheelY () const
 \qmlproperty float XrVirtualMouse::scrollWheelY
 
int scrollTimerInterval () const
 \qmlproperty int XrVirtualMouse::scrollTimerInterval
 
int scrollPixelDelta () const
 \qmlproperty float XrVirtualMouse::scrollPixelDelta
 
QQuick3DNodesource () const
 \qmlproperty Node XrVirtualMouse::source
 
QQuick3DXrViewview () const
 \qmlproperty XrView XrVirtualMouse::view
 
bool enabled () const
 \qmlproperty bool XrVirtualMouse::enabled
 
- 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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.
 

Properties

bool rightMouseButton
 
bool leftMouseButton
 
bool middleMouseButton
 
float scrollWheelX
 
float scrollWheelY
 
int scrollTimerInterval
 
int scrollPixelDelta
 
QQuick3DNodesource
 
QQuick3DXrViewview
 
bool enabled
 
- 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
QObjectsender () 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< QObjectDatad_ptr
 

Detailed Description

Definition at line 28 of file qquick3dxrvirtualmouse_p.h.

Constructor & Destructor Documentation

◆ QQuick3DXrVirtualMouse()

QT_BEGIN_NAMESPACE QQuick3DXrVirtualMouse::QQuick3DXrVirtualMouse ( QObject * parent = nullptr)
explicit
\qmltype XrVirtualMouse
\inherits Item
\inqmlmodule QtQuick3D.Xr
\brief Maps 3D controller input to mouse input in 2D items.

The XrVirtualMouse provides a way to interact with \l{Qt Quick 3D Scenes with 2D Content}{2D user interfaces}
in the 3D scene.

It is typically used like this:

\qml

XrView { id: xrView XrController { id: rightController XrInputAction { id: rightTrigger hand: XrInputAction.RightHand actionId: [XrInputAction.TriggerPressed, XrInputAction.TriggerValue] } XrVirtualMouse { view: xrView source: rightController leftMouseButton: rightTrigger.pressed } \endqml

Definition at line 39 of file qquick3dxrvirtualmouse.cpp.

References QObjectData::parent.

Member Function Documentation

◆ enabled()

bool QQuick3DXrVirtualMouse::enabled ( ) const

\qmlproperty bool XrVirtualMouse::enabled

Indicates whether the virtual mouse is enabled. When true, the virtual mouse sends mouse events to 2D objects in the scene.

Definition at line 169 of file qquick3dxrvirtualmouse.cpp.

◆ enabledChanged

void QQuick3DXrVirtualMouse::enabledChanged ( bool enabled)
signal

◆ leftMouseButton()

bool QQuick3DXrVirtualMouse::leftMouseButton ( ) const

\qmlproperty bool XrVirtualMouse::leftMouseButton

Sets the state of the left mouse button.

When set to true, the left mouse button is pressed.

Definition at line 65 of file qquick3dxrvirtualmouse.cpp.

◆ leftMouseButtonChanged

void QQuick3DXrVirtualMouse::leftMouseButtonChanged ( bool leftMouseButton)
signal

◆ middleMouseButton()

bool QQuick3DXrVirtualMouse::middleMouseButton ( ) const

\qmlproperty bool XrVirtualMouse::middleMouseButton

Sets the state of the middle mouse button.

When set to true, the middle mouse button is pressed.

Definition at line 77 of file qquick3dxrvirtualmouse.cpp.

◆ middleMouseButtonChanged

void QQuick3DXrVirtualMouse::middleMouseButtonChanged ( bool middleMouseButton)
signal

◆ rightMouseButton()

bool QQuick3DXrVirtualMouse::rightMouseButton ( ) const

\qmlproperty bool XrVirtualMouse::rightMouseButton

Sets the state of the right mouse button.

When set to true, the right mouse button is pressed.

Definition at line 53 of file qquick3dxrvirtualmouse.cpp.

◆ rightMouseButtonChanged

void QQuick3DXrVirtualMouse::rightMouseButtonChanged ( bool rightMouseButton)
signal

◆ scrollPixelDelta()

int QQuick3DXrVirtualMouse::scrollPixelDelta ( ) const

\qmlproperty float XrVirtualMouse::scrollPixelDelta

Defines the base distance scrolled with each scrolling event. \default 15

This is the distance scrolled when the scrolling speed is 1.

See also
scrollWheelX, scrollWheelY

Definition at line 133 of file qquick3dxrvirtualmouse.cpp.

◆ scrollPixelDeltaChanged

void QQuick3DXrVirtualMouse::scrollPixelDeltaChanged ( int scrollPixelDelta)
signal

◆ scrollTimerInterval()

int QQuick3DXrVirtualMouse::scrollTimerInterval ( ) const

\qmlproperty int XrVirtualMouse::scrollTimerInterval

Defines time in milliseconds between scrolling events sent to the system. \default 30

Definition at line 118 of file qquick3dxrvirtualmouse.cpp.

◆ scrollTimerIntervalChanged

void QQuick3DXrVirtualMouse::scrollTimerIntervalChanged ( int scrollTimerInterval)
signal

◆ scrollWheelX()

float QQuick3DXrVirtualMouse::scrollWheelX ( ) const

\qmlproperty float XrVirtualMouse::scrollWheelX

Sets the horizontal scrolling speed.

Positive values scroll right and negative values scroll left. Scroll speed increases relative to distance from zero.

See also
scrollPixelDelta

Definition at line 92 of file qquick3dxrvirtualmouse.cpp.

◆ scrollWheelXChanged

void QQuick3DXrVirtualMouse::scrollWheelXChanged ( float scrollWheelX)
signal

◆ scrollWheelY()

float QQuick3DXrVirtualMouse::scrollWheelY ( ) const

\qmlproperty float XrVirtualMouse::scrollWheelY

Sets the vertical scrolling speed.

Positive values scroll up and negative values scroll down. Scroll speed increases relative to distance from zero.

See also
scrollPixelDelta

Definition at line 107 of file qquick3dxrvirtualmouse.cpp.

◆ scrollWheelYChanged

void QQuick3DXrVirtualMouse::scrollWheelYChanged ( float scrollWheelY)
signal

◆ setEnabled

void QQuick3DXrVirtualMouse::setEnabled ( bool enabled)
slot

Definition at line 295 of file qquick3dxrvirtualmouse.cpp.

◆ setLeftMouseButton

void QQuick3DXrVirtualMouse::setLeftMouseButton ( bool leftMouseButton)
slot

Definition at line 190 of file qquick3dxrvirtualmouse.cpp.

◆ setMiddleMouseButton

void QQuick3DXrVirtualMouse::setMiddleMouseButton ( bool middleMouseButton)
slot

Definition at line 206 of file qquick3dxrvirtualmouse.cpp.

◆ setRightMouseButton

void QQuick3DXrVirtualMouse::setRightMouseButton ( bool rightMouseButton)
slot

Definition at line 174 of file qquick3dxrvirtualmouse.cpp.

◆ setScrollPixelDelta

void QQuick3DXrVirtualMouse::setScrollPixelDelta ( int scrollPixelDelta)
slot

Definition at line 261 of file qquick3dxrvirtualmouse.cpp.

◆ setScrollTimerInterval

void QQuick3DXrVirtualMouse::setScrollTimerInterval ( int scrollTimerInterval)
slot

Definition at line 250 of file qquick3dxrvirtualmouse.cpp.

◆ setScrollWheelX

void QQuick3DXrVirtualMouse::setScrollWheelX ( float scrollWheelX)
slot

Definition at line 222 of file qquick3dxrvirtualmouse.cpp.

◆ setScrollWheelY

void QQuick3DXrVirtualMouse::setScrollWheelY ( float scrollWheelY)
slot

Definition at line 236 of file qquick3dxrvirtualmouse.cpp.

◆ setSource

void QQuick3DXrVirtualMouse::setSource ( QQuick3DNode * source)
slot

Definition at line 271 of file qquick3dxrvirtualmouse.cpp.

◆ setView

void QQuick3DXrVirtualMouse::setView ( QQuick3DXrView * view)
slot

Definition at line 286 of file qquick3dxrvirtualmouse.cpp.

◆ source()

QQuick3DNode * QQuick3DXrVirtualMouse::source ( ) const

\qmlproperty Node XrVirtualMouse::source

The 3D node controlling the virtual mouse.

The source property is normally set to an \l XrController. Mouse events are generated for the position where the \l{QtQuick3D::Node::forward}{forward vector} of the source node intersects with a 2D item.

Definition at line 147 of file qquick3dxrvirtualmouse.cpp.

◆ sourceChanged

void QQuick3DXrVirtualMouse::sourceChanged ( QQuick3DNode * source)
signal

◆ view()

QQuick3DXrView * QQuick3DXrVirtualMouse::view ( ) const

\qmlproperty XrView XrVirtualMouse::view

The XR view associated with the virtual mouse. Holds the view in which the virtual mouse operates.

Definition at line 158 of file qquick3dxrvirtualmouse.cpp.

◆ viewChanged

void QQuick3DXrVirtualMouse::viewChanged ( QQuick3DXrView * view)
signal

Property Documentation

◆ enabled

bool QQuick3DXrVirtualMouse::enabled
readwrite

Definition at line 40 of file qquick3dxrvirtualmouse_p.h.

◆ leftMouseButton

bool QQuick3DXrVirtualMouse::leftMouseButton
readwrite

Definition at line 32 of file qquick3dxrvirtualmouse_p.h.

◆ middleMouseButton

bool QQuick3DXrVirtualMouse::middleMouseButton
readwrite

Definition at line 33 of file qquick3dxrvirtualmouse_p.h.

◆ rightMouseButton

bool QQuick3DXrVirtualMouse::rightMouseButton
readwrite

Definition at line 31 of file qquick3dxrvirtualmouse_p.h.

◆ scrollPixelDelta

int QQuick3DXrVirtualMouse::scrollPixelDelta
readwrite

Definition at line 37 of file qquick3dxrvirtualmouse_p.h.

◆ scrollTimerInterval

int QQuick3DXrVirtualMouse::scrollTimerInterval
readwrite

Definition at line 36 of file qquick3dxrvirtualmouse_p.h.

◆ scrollWheelX

float QQuick3DXrVirtualMouse::scrollWheelX
readwrite

Definition at line 34 of file qquick3dxrvirtualmouse_p.h.

◆ scrollWheelY

float QQuick3DXrVirtualMouse::scrollWheelY
readwrite

Definition at line 35 of file qquick3dxrvirtualmouse_p.h.

◆ source

QQuick3DNode* QQuick3DXrVirtualMouse::source
readwrite

Definition at line 38 of file qquick3dxrvirtualmouse_p.h.

◆ view

QQuick3DXrView* QQuick3DXrVirtualMouse::view
readwrite

Definition at line 39 of file qquick3dxrvirtualmouse_p.h.


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