#include <qquick3dxrcontroller_p.h>

Inheritance diagram for QQuick3DXrController:

Collaboration diagram for QQuick3DXrController:

Public Types
enum	Controller { ControllerLeft = 0 , ControllerRight = 1 , ControllerNone = 2 , LeftController = ControllerLeft , RightController = ControllerRight , LeftHand = ControllerLeft , RightHand = ControllerRight , UnknownController = ControllerNone }
enum class	HandPoseSpace { GripPose , AimPose }
Public Types inherited from QQuick3DNode
enum	TransformSpace { LocalSpace , ParentSpace , SceneSpace }
enum	StaticFlags { None }

Signals
void	controllerChanged ()
void	actionMapperChanged ()
void	poseSpaceChanged ()
void	pokePositionChanged ()
void	jointPositionsChanged ()
void	jointRotationsChanged ()
void	jointDataUpdated ()
void	isActiveChanged ()
Signals inherited from QQuick3DNode
void	xChanged ()
void	yChanged ()
void	zChanged ()
void	rotationChanged ()
void	eulerRotationChanged ()
void	positionChanged ()
void	scaleChanged ()
void	pivotChanged ()
void	localOpacityChanged ()
void	visibleChanged ()
void	forwardChanged ()
void	upChanged ()
void	rightChanged ()
void	sceneTransformChanged ()
void	scenePositionChanged ()
void	sceneRotationChanged ()
void	sceneScaleChanged ()
void	staticFlagsChanged ()
void	layersChanged ()
Signals inherited from QQuick3DObject
void	parentChanged ()
void	childrenChanged ()
void	stateChanged ()
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
	QQuick3DXrController ()
	\qmltype XrController \inherits Node \inqmlmodule QtQuick3D.Xr
QQuick3DXrController::Controller	controller () const
	\qmlproperty enumeration QtQuick3D.Xr::XrController::controller
void	setController (QQuick3DXrController::Controller newController)
QQuick3DXrHandInput *	handInput () const
HandPoseSpace	poseSpace () const
	\qmlproperty enumeration XrController::poseSpace
void	setPoseSpace (HandPoseSpace newPoseSpace)
QVector3D	pokePosition () const
	\qmlproperty vector3d XrController::pokePosition
QList< QVector3D >	jointPositions () const
	\qmlproperty list<vector3d> XrController::jointPositions
QList< QQuaternion >	jointRotations () const
	\qmlproperty list<quaternion> XrController::jointRotations
bool	isActive () const
	\qmlproperty bool XrController::isActive
Public Member Functions inherited from QQuick3DNode
	QQuick3DNode (QQuick3DNode *parent=nullptr)
	\qmltype Node \inherits Object3D \inqmlmodule QtQuick3D
	~QQuick3DNode () override
float	x () const
	\qmlproperty real QtQuick3D::Node::x
float	y () const
	\qmlproperty real QtQuick3D::Node::y
float	z () const
	\qmlproperty real QtQuick3D::Node::z
QQuaternion	rotation () const
	\qmlproperty quaternion QtQuick3D::Node::rotation
QVector3D	eulerRotation () const
	\qmlproperty vector3d QtQuick3D::Node::eulerRotation
QVector3D	position () const
	\qmlproperty vector3d QtQuick3D::Node::position
QVector3D	scale () const
	\qmlproperty vector3d QtQuick3D::Node::scale
QVector3D	pivot () const
	\qmlproperty vector3d QtQuick3D::Node::pivot
float	localOpacity () const
	\qmlproperty real QtQuick3D::Node::opacity
bool	visible () const
	\qmlproperty bool QtQuick3D::Node::visible
int	staticFlags () const
	\qmlproperty int QtQuick3D::Node::staticFlags
QQuick3DNode *	parentNode () const
QVector3D	forward () const
	\qmlproperty vector3d QtQuick3D::Node::forward \readonly
QVector3D	up () const
	\qmlproperty vector3d QtQuick3D::Node::up \readonly
QVector3D	right () const
	\qmlproperty vector3d QtQuick3D::Node::right \readonly
QVector3D	scenePosition () const
	\qmlproperty vector3d QtQuick3D::Node::scenePosition \readonly
QQuaternion	sceneRotation () const
	\qmlproperty quaternion QtQuick3D::Node::sceneRotation \readonly
QVector3D	sceneScale () const
	\qmlproperty vector3d QtQuick3D::Node::sceneScale \readonly
QMatrix4x4	sceneTransform () const
	\qmlproperty matrix4x4 QtQuick3D::Node::sceneTransform \readonly
Q_INVOKABLE void	rotate (qreal degrees, const QVector3D &axis, QQuick3DNode::TransformSpace space)
	\qmlmethod QtQuick3D::Node::rotate(real degrees, vector3d axis, enumeration space)
Q_INVOKABLE QVector3D	mapPositionToScene (const QVector3D &localPosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionToScene(vector3d localPosition)
Q_INVOKABLE QVector3D	mapPositionFromScene (const QVector3D &scenePosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionFromScene(vector3d scenePosition)
Q_INVOKABLE QVector3D	mapPositionToNode (const QQuick3DNode *node, const QVector3D &localPosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionToNode(QtQuick3D::Node node, vector3d localPosition)
Q_INVOKABLE QVector3D	mapPositionFromNode (const QQuick3DNode *node, const QVector3D &localPosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionFromNode(QtQuick3D::Node node, vector3d localPosition)
Q_INVOKABLE QVector3D	mapDirectionToScene (const QVector3D &localDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionToScene(vector3d localDirection)
Q_INVOKABLE QVector3D	mapDirectionFromScene (const QVector3D &sceneDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionFromScene(vector3d sceneDirection)
Q_INVOKABLE QVector3D	mapDirectionToNode (const QQuick3DNode *node, const QVector3D &localDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionToNode(QtQuick3D::Node node, vector3d localDirection)
Q_INVOKABLE QVector3D	mapDirectionFromNode (const QQuick3DNode *node, const QVector3D &localDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionFromNode(QtQuick3D::Node node, vector3d localDirection)
void	markAllDirty () override
int	layers () const
	\qmlproperty int QtQuick3D::Node::layers
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
bool	isActive
HandPoseSpace	poseSpace
QVector3D	pokePosition
QList< QVector3D >	jointPositions
QList< QQuaternion >	jointRotations
Properties inherited from QQuick3DNode
float	x
float	y
float	z
QQuaternion	rotation
QVector3D	eulerRotation
QVector3D	position
QVector3D	scale
QVector3D	pivot
float	opacity
bool	visible
QVector3D	forward
QVector3D	up
QVector3D	right
QVector3D	scenePosition
QQuaternion	sceneRotation
QVector3D	sceneScale
QMatrix4x4	sceneTransform
int	staticFlags
int	layers
Properties inherited from QQuick3DObject
QQuick3DObject *	parent
	\qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene.
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QQuick3DNode
void	setX (float x)
void	setY (float y)
void	setZ (float z)
void	setRotation (const QQuaternion &rotation)
void	setEulerRotation (const QVector3D &eulerRotation)
void	setPosition (const QVector3D &position)
void	setScale (const QVector3D &scale)
void	setPivot (const QVector3D &pivot)
void	setLocalOpacity (float opacity)
void	setVisible (bool visible)
void	setStaticFlags (int staticFlags)
void	setLayers (int newLayers)
Public Slots inherited from QQuick3DObject
void	update ()
void	setParentItem (QQuick3DObject *parentItem)
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 QQuick3DNode
void	connectNotify (const QMetaMethod &signal) override
void	disconnectNotify (const QMetaMethod &signal) override
void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.
	QQuick3DNode (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node) override
virtual void	itemChange (ItemChange, const ItemChangeData &) override
Protected Member Functions inherited from QQuick3DObject
	QQuick3DObject (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
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.
bool	isComponentComplete () const
virtual void	preSync ()
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.
	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 qquick3dxrcontroller_p.h.

Member Enumeration Documentation

◆ Controller

enum QQuick3DXrController::Controller

Enumerator
ControllerLeft
ControllerRight
ControllerNone
LeftController
RightController
LeftHand
RightHand
UnknownController

Definition at line 43 of file qquick3dxrcontroller_p.h.

◆ HandPoseSpace

enum class QQuick3DXrController::HandPoseSpace

strong

Enumerator
GripPose
AimPose

Definition at line 55 of file qquick3dxrcontroller_p.h.

Constructor & Destructor Documentation

◆ QQuick3DXrController()

QT_BEGIN_NAMESPACE QQuick3DXrController::QQuick3DXrController ( )

\qmltype XrController \inherits Node \inqmlmodule QtQuick3D.Xr

A tracked spatial node that tracks the position and orientation of an input controller.

The XrController is a tracked spatial node that tracks the position and orientation of an input controller.

Since this is a tracked node, its spatial properties should be considered read-only.

See also: XrInputAction

Definition at line 32 of file qquick3dxrcontroller.cpp.

Member Function Documentation

◆ actionMapperChanged

void QQuick3DXrController::actionMapperChanged ( )

signal

◆ controller()

QQuick3DXrController::Controller QQuick3DXrController::controller ( ) const

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

Specifies the controller to track.

It can be one of: \value XrController.LeftController \value XrController.RightController \value XrController.UnknownController \value XrController.LeftHand (alias for LeftController) \value XrController.RightHand (alias for RightController)

Definition at line 50 of file qquick3dxrcontroller.cpp.

◆ controllerChanged

void QQuick3DXrController::controllerChanged ( )

signal

◆ handInput()

QQuick3DXrHandInput * QQuick3DXrController::handInput ( ) const

Definition at line 82 of file qquick3dxrcontroller.cpp.

◆ isActive()

bool QQuick3DXrController::isActive ( ) const

\qmlproperty bool XrController::isActive

Indicates whether the controller is providing input.

\readonly This property is true if the corresponding physical controller is present and tracking.

Definition at line 179 of file qquick3dxrcontroller.cpp.

◆ isActiveChanged

void QQuick3DXrController::isActiveChanged ( )

signal

◆ jointDataUpdated

void QQuick3DXrController::jointDataUpdated ( )

signal

◆ jointPositions()

QList< QVector3D > QQuick3DXrController::jointPositions ( ) const

\qmlproperty list<vector3d> XrController::jointPositions

\readonly When using hand tracking, this property holds the positions of all the bones in the hand.

See also: jointRotations, XrHandModel

Definition at line 146 of file qquick3dxrcontroller.cpp.

◆ jointPositionsChanged

void QQuick3DXrController::jointPositionsChanged ( )

signal

◆ jointRotations()

QList< QQuaternion > QQuick3DXrController::jointRotations ( ) const

\qmlproperty list<quaternion> XrController::jointRotations

\readonly When using hand tracking, this property holds the orientation of all the bones in the hand.

See also: jointPositions, XrHandModel

Definition at line 162 of file qquick3dxrcontroller.cpp.

◆ jointRotationsChanged

void QQuick3DXrController::jointRotationsChanged ( )

signal

◆ pokePosition()

QVector3D QQuick3DXrController::pokePosition ( ) const

\qmlproperty vector3d XrController::pokePosition

\readonly This property holds the position to be used for touch interactions. Typically, it will be the tip of the index finger when tracking a hand.

See also: XrView::processTouch, XrView::setTouchpoint

Definition at line 130 of file qquick3dxrcontroller.cpp.

◆ pokePositionChanged

void QQuick3DXrController::pokePositionChanged ( )

signal

◆ poseSpace()

QQuick3DXrController::HandPoseSpace QQuick3DXrController::poseSpace ( ) const

\qmlproperty enumeration XrController::poseSpace

Specifies the pose of the controller to track, that is, the orientation and position relative to the physical controller.

It can be one of: \value XrController.AimPose Used when aiming at something, such as with \l XrVirtualMouse. \value XrController.GripPose Used when grabbing something, such as when holding an object in the hand. \default XrController.AimPose

Definition at line 106 of file qquick3dxrcontroller.cpp.

◆ poseSpaceChanged

void QQuick3DXrController::poseSpaceChanged ( )

signal

◆ setController()

void QQuick3DXrController::setController ( QQuick3DXrController::Controller newController )

Definition at line 55 of file qquick3dxrcontroller.cpp.

◆ setPoseSpace()

void QQuick3DXrController::setPoseSpace ( HandPoseSpace newPoseSpace )

Definition at line 111 of file qquick3dxrcontroller.cpp.

Property Documentation

◆ controller

Controller QQuick3DXrController::controller

readwrite

Definition at line 32 of file qquick3dxrcontroller_p.h.

◆ isActive

bool QQuick3DXrController::isActive

read

Definition at line 33 of file qquick3dxrcontroller_p.h.

◆ jointPositions

QList<QVector3D> QQuick3DXrController::jointPositions

read

Definition at line 37 of file qquick3dxrcontroller_p.h.

◆ jointRotations

QList<QQuaternion> QQuick3DXrController::jointRotations

read

Definition at line 38 of file qquick3dxrcontroller_p.h.

◆ pokePosition

QVector3D QQuick3DXrController::pokePosition

read

Definition at line 36 of file qquick3dxrcontroller_p.h.

◆ poseSpace

HandPoseSpace QQuick3DXrController::poseSpace

readwrite

Definition at line 34 of file qquick3dxrcontroller_p.h.

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

qtquick3d/src/xr/quick3dxr/qquick3dxrcontroller_p.h (c4beeea9b72574e8a6e3781731ddf6080df5849f)
qtquick3d/src/xr/quick3dxr/qquick3dxrcontroller.cpp (c4beeea9b72574e8a6e3781731ddf6080df5849f)

Public Types

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Controller

◆ HandPoseSpace

Constructor & Destructor Documentation

◆ QQuick3DXrController()

Member Function Documentation

◆ actionMapperChanged

◆ controller()

◆ controllerChanged

◆ handInput()

◆ isActive()

◆ isActiveChanged

◆ jointDataUpdated

◆ jointPositions()

◆ jointPositionsChanged

◆ jointRotations()

◆ jointRotationsChanged

◆ pokePosition()

◆ pokePositionChanged

◆ poseSpace()

◆ poseSpaceChanged

◆ setController()

◆ setPoseSpace()

Property Documentation

◆ controller

◆ isActive

◆ jointPositions

◆ jointRotations

◆ pokePosition

◆ poseSpace