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
QOpenXRItem Class Reference

#include <qopenxritem_p.h>

+ Inheritance diagram for QOpenXRItem:
+ Collaboration diagram for QOpenXRItem:

Classes

struct  TouchState
 

Signals

void contentItemChanged ()
 
void pixelsPerUnitChanged ()
 
void uiScaleChanged ()
 
void flagsChanged ()
 
void manualPixelsPerUnitChanged ()
 
void widthChanged ()
 
void heightChanged ()
 
void colorChanged ()
 
- 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 ()
 
- 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

 QOpenXRItem (QQuick3DNode *parent=nullptr)
 \qmltype XrItem \inqmlmodule QtQuick3D.Xr \inherits Node
 
 ~QOpenXRItem () override
 
QQuickItemcontentItem () const
 \qmlproperty Item XrItem::contentItem
 
void setContentItem (QQuickItem *newContentItem)
 
qreal pixelsPerUnit () const
 \qmlproperty real XrItem::pixelsPerUnit
 
void setPixelsPerUnit (qreal newPixelsPerUnit)
 
QQuickScaleuiScale () const
 
void setUiScale (QQuickScale *newUiScale)
 
bool manualPixelsPerUnit () const
 \qmlproperty bool XrItem::manualPixelsPerUnit
 
void setManualPixelsPerUnit (bool newManualPixelsPerUnit)
 
qreal width () const
 \qmlproperty real XrItem::width
 
void setWidth (qreal newWidth)
 
qreal height () const
 \qmlproperty real XrItem::height
 
void setHeight (qreal newHeight)
 
QColor color () const
 \qmlproperty color XrItem::color
 
void setColor (const QColor &newColor)
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
bool handleVirtualTouch (QOpenXRView *view, const QVector3D &pos, TouchState *touchState, QVector3D *offset)
 
- 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
 
QQuick3DNodeparentNode () 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
 
- 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Properties

QQuickItemcontentItem
 
qreal pixelsPerUnit
 
bool manualPixelsPerUnit
 
qreal width
 
qreal height
 
QColor color
 
- 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
 
- Properties inherited from QQuick3DObject
QQuick3DObjectparent
 \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 Types inherited from QQuick3DNode
enum  TransformSpace { LocalSpace , ParentSpace , SceneSpace }
 
enum  StaticFlags { None }
 
- 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)
 
- 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)
 
QSSGRenderGraphObjectupdateSpatialNode (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
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.
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 28 of file qopenxritem_p.h.

Constructor & Destructor Documentation

◆ QOpenXRItem()

QOpenXRItem::QOpenXRItem ( QQuick3DNode * parent = nullptr)
explicit

\qmltype XrItem \inqmlmodule QtQuick3D.Xr \inherits Node

A virtual surface in 3D space that can hold 2D user interface content

The XrItem type is a Qt Quick 3D \l Node that represents a rectangle with \l width and \l height. It holds one Qt Quick \l Item, specified by \l contentItem, and scales it to fit. This gives a convenient way to take traditional 2D user interfaces and display them on a virtual surface that has a real world size.

Any other children of the XrItem will be treated as normal children of a Node, and will not be scaled.

For example the following code will create a virtual surface that's 1 meter by 1 meter and with a content item that's 600 pixels by 600 pixels. Note that the effect here is achieved by scaling the content item and not by rendering the content item at a higher resolution.

XrItem {
width: 100
height: 100
contentItem: Rectangle {
width: 600
height: 600
color: "red"
}
}
QQuickItem * contentItem

Definition at line 133 of file qopenxritem.cpp.

◆ ~QOpenXRItem()

QOpenXRItem::~QOpenXRItem ( )
override

Definition at line 138 of file qopenxritem.cpp.

References d.

Member Function Documentation

◆ color()

QColor QOpenXRItem::color ( ) const

\qmlproperty color XrItem::color

This property defines the background color of the XrItem.

\default "white"

Definition at line 424 of file qopenxritem.cpp.

References d.

◆ colorChanged

void QOpenXRItem::colorChanged ( )
signal

Referenced by setColor().

+ Here is the caller graph for this function:

◆ componentComplete()

void QOpenXRItem::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 145 of file qopenxritem.cpp.

References QQuick3DNode::componentComplete(), d, QQuick3DObject::parent, QQuick3DNode::parentNode(), and qWarning.

+ Here is the call graph for this function:

◆ contentItem()

QQuickItem * QOpenXRItem::contentItem ( ) const

\qmlproperty Item XrItem::contentItem

This property holds the content item that will be displayed on the virtual surface. The content item's size will be used to calculate the pixels per unit value and scale based on this item's size.

See also
pixelsPerUnit

Definition at line 175 of file qopenxritem.cpp.

References d.

◆ contentItemChanged

void QOpenXRItem::contentItemChanged ( )
signal

Referenced by setContentItem().

+ Here is the caller graph for this function:

◆ flagsChanged

void QOpenXRItem::flagsChanged ( )
signal

◆ handleVirtualTouch()

bool QOpenXRItem::handleVirtualTouch ( QOpenXRView * view,
const QVector3D & pos,
TouchState * touchState,
QVector3D * offset )

Definition at line 301 of file qopenxritem.cpp.

References QDateTime::currentMSecsSinceEpoch(), d, height, QQuick3DNode::mapPositionFromScene(), now, pos, qMin(), QQuick3DNode::sceneRotation, view, width, QPointF::x(), QPointF::y(), and QQuick3DNode::z.

+ Here is the call graph for this function:

◆ height()

qreal QOpenXRItem::height ( ) const

\qmlproperty real XrItem::height

This property defines the height of the XrItem in the 3D coordinate system.

See also
width

Definition at line 280 of file qopenxritem.cpp.

References d.

◆ heightChanged

void QOpenXRItem::heightChanged ( )
signal

◆ manualPixelsPerUnit()

bool QOpenXRItem::manualPixelsPerUnit ( ) const

\qmlproperty bool XrItem::manualPixelsPerUnit

If this property is true, the ratio between the contentItems's 2D coordinate system and this XrItem's 3D coordinate system is defined by the value of \l pixelsPerUnit. If this property is false, the ratio is calculated based on the content item's size and the size of the XrItem.

\default false

See also
pixelsPerUnit

Definition at line 233 of file qopenxritem.cpp.

References d.

◆ manualPixelsPerUnitChanged

void QOpenXRItem::manualPixelsPerUnitChanged ( )
signal

Referenced by setManualPixelsPerUnit().

+ Here is the caller graph for this function:

◆ pixelsPerUnit()

qreal QOpenXRItem::pixelsPerUnit ( ) const

\qmlproperty real XrItem::pixelsPerUnit

This property determines how many pixels in the contentItems's 2D coordinate system will fit in one unit of the XrItem's 3D coordinate system. By default, this is calculated based on the content item's size and the size of the XrItem.

Set \l manualPixelsPerUnit to disable the default behavior and set the pixels per unit value manually.

See also
manualPixelsPerUnit

Definition at line 202 of file qopenxritem.cpp.

References d.

◆ pixelsPerUnitChanged

void QOpenXRItem::pixelsPerUnitChanged ( )
signal

Referenced by setPixelsPerUnit().

+ Here is the caller graph for this function:

◆ setColor()

void QOpenXRItem::setColor ( const QColor & newColor)

Definition at line 430 of file qopenxritem.cpp.

References colorChanged(), d, and emit.

+ Here is the call graph for this function:

◆ setContentItem()

void QOpenXRItem::setContentItem ( QQuickItem * newContentItem)

Definition at line 181 of file qopenxritem.cpp.

References contentItemChanged(), d, and emit.

+ Here is the call graph for this function:

◆ setHeight()

void QOpenXRItem::setHeight ( qreal newHeight)

Definition at line 286 of file qopenxritem.cpp.

References d, emit, and widthChanged().

+ Here is the call graph for this function:

◆ setManualPixelsPerUnit()

void QOpenXRItem::setManualPixelsPerUnit ( bool newManualPixelsPerUnit)

Definition at line 239 of file qopenxritem.cpp.

References d, emit, and manualPixelsPerUnitChanged().

+ Here is the call graph for this function:

◆ setPixelsPerUnit()

void QOpenXRItem::setPixelsPerUnit ( qreal newPixelsPerUnit)

Definition at line 208 of file qopenxritem.cpp.

References d, emit, pixelsPerUnitChanged(), and qFuzzyCompare().

+ Here is the call graph for this function:

◆ setUiScale()

void QOpenXRItem::setUiScale ( QQuickScale * newUiScale)

◆ setWidth()

void QOpenXRItem::setWidth ( qreal newWidth)

Definition at line 262 of file qopenxritem.cpp.

References d, emit, and widthChanged().

+ Here is the call graph for this function:

◆ uiScale()

QQuickScale * QOpenXRItem::uiScale ( ) const

◆ uiScaleChanged

void QOpenXRItem::uiScaleChanged ( )
signal

◆ width()

qreal QOpenXRItem::width ( ) const

\qmlproperty real XrItem::width

This property defines the width of the XrItem in the 3D coordinate system.

See also
height

Definition at line 256 of file qopenxritem.cpp.

References d.

◆ widthChanged

void QOpenXRItem::widthChanged ( )
signal

Referenced by setHeight(), and setWidth().

+ Here is the caller graph for this function:

Property Documentation

◆ color

QColor QOpenXRItem::color
readwrite

Definition at line 38 of file qopenxritem_p.h.

◆ contentItem

QQuickItem * QOpenXRItem::contentItem
readwrite

Definition at line 33 of file qopenxritem_p.h.

◆ height

qreal QOpenXRItem::height
readwrite

Definition at line 37 of file qopenxritem_p.h.

Referenced by handleVirtualTouch().

◆ manualPixelsPerUnit

bool QOpenXRItem::manualPixelsPerUnit
readwrite

Definition at line 35 of file qopenxritem_p.h.

◆ pixelsPerUnit

qreal QOpenXRItem::pixelsPerUnit
readwrite

Definition at line 34 of file qopenxritem_p.h.

◆ width

qreal QOpenXRItem::width
readwrite

Definition at line 36 of file qopenxritem_p.h.

Referenced by handleVirtualTouch().


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