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

#include <qquick3druntimeloader_p.h>

+ Inheritance diagram for QQuick3DRuntimeLoader:
+ Collaboration diagram for QQuick3DRuntimeLoader:

Public Types

enum class  Status { Empty , Success , Error }
 
- Public Types inherited from QQuick3DNode
enum  TransformSpace { LocalSpace , ParentSpace , SceneSpace }
 
enum  StaticFlags { None }
 

Signals

void sourceChanged ()
 
void statusChanged ()
 
void errorStringChanged ()
 
void boundsChanged ()
 
void instancingChanged ()
 
- 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

 QQuick3DRuntimeLoader (QQuick3DNode *parent=nullptr)
 \qmltype RuntimeLoader \inherits Node \inqmlmodule QtQuick3D.AssetUtils
 
QUrl source () const
 
void setSource (const QUrl &newSource)
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
 Q_REVISION (6, 7) static QStringList supportedExtensions()
 
 Q_REVISION (6, 7) static QList< QMimeType > supportedMimeTypes()
 
Status status () const
 
QString errorString () const
 
const QQuick3DBounds3bounds () const
 
QQuick3DInstancinginstancing () const
 
void setInstancing (QQuick3DInstancing *newInstancing)
 
- 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 ()
 

Protected Member Functions

QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) override
 
- Protected Member Functions inherited from QQuick3DNode
void connectNotify (const QMetaMethod &signal) override
 
void disconnectNotify (const QMetaMethod &signal) override
 
 QQuick3DNode (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
 
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.
 
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)
 

Properties

QUrl source
 
Status status
 
QString errorString
 
QQuick3DBounds3 bounds
 
QQuick3DInstancinginstancing
 
QStringList supportedExtensions
 
QList< QMimeTypesupportedMimeTypes
 
- 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 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 Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 29 of file qquick3druntimeloader_p.h.

Member Enumeration Documentation

◆ Status

enum class QQuick3DRuntimeLoader::Status
strong
Enumerator
Empty 
Success 
Error 

Definition at line 53 of file qquick3druntimeloader_p.h.

Constructor & Destructor Documentation

◆ QQuick3DRuntimeLoader()

QT_BEGIN_NAMESPACE QQuick3DRuntimeLoader::QQuick3DRuntimeLoader ( QQuick3DNode * parent = nullptr)
explicit

\qmltype RuntimeLoader \inherits Node \inqmlmodule QtQuick3D.AssetUtils

Since
6.2

Imports a 3D asset at runtime.

The RuntimeLoader type provides a way to load a 3D asset directly from source at runtime, without converting it to QtQuick3D's internal format first.

RuntimeLoader supports .obj and glTF version 2.0 files in both in text (.gltf) and binary (.glb) formats.

\qmlproperty url RuntimeLoader::source

This property holds the location of the source file containing the 3D asset. Changing this property will unload the current asset and attempt to load an asset from the given URL.

The success or failure of the load operation is indicated by \l status.

\qmlproperty enumeration RuntimeLoader::status

This property holds the status of the latest load operation.

\value RuntimeLoader.Empty No URL was specified. \value RuntimeLoader.Success The load operation was successful. \value RuntimeLoader.Error The load operation failed. A human-readable error message is provided by \l errorString.

\readonly

\qmlproperty string RuntimeLoader::errorString

This property holds a human-readable string indicating the status of the latest load operation.

\readonly

\qmlproperty Bounds RuntimeLoader::bounds

This property describes the extents of the bounding volume around the imported model.

Note
The value may not be available before the first render

\readonly

\qmlproperty Instancing RuntimeLoader::instancing

If this property is set, the imported model will not be rendered normally. Instead, a number of instances will be rendered, as defined by the instance table.

See the \l{Instanced Rendering} overview documentation for more information.

Definition at line 81 of file qquick3druntimeloader.cpp.

Member Function Documentation

◆ bounds()

const QQuick3DBounds3 & QQuick3DRuntimeLoader::bounds ( ) const

Definition at line 282 of file qquick3druntimeloader.cpp.

◆ boundsChanged

void QQuick3DRuntimeLoader::boundsChanged ( )
signal

Referenced by updateSpatialNode().

+ Here is the caller graph for this function:

◆ componentComplete()

void QQuick3DRuntimeLoader::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.

Reimplemented from QQuick3DNode.

Definition at line 110 of file qquick3druntimeloader.cpp.

References QQuick3DNode::componentComplete().

+ Here is the call graph for this function:

◆ errorString()

QString QQuick3DRuntimeLoader::errorString ( ) const

Definition at line 259 of file qquick3druntimeloader.cpp.

◆ errorStringChanged

void QQuick3DRuntimeLoader::errorStringChanged ( )
signal

◆ instancing()

QQuick3DInstancing * QQuick3DRuntimeLoader::instancing ( ) const

Definition at line 293 of file qquick3druntimeloader.cpp.

◆ instancingChanged

void QQuick3DRuntimeLoader::instancingChanged ( )
signal

Referenced by setInstancing().

+ Here is the caller graph for this function:

◆ Q_REVISION() [1/2]

QQuick3DRuntimeLoader::Q_REVISION ( 6 ,
7  )

◆ Q_REVISION() [2/2]

QQuick3DRuntimeLoader::Q_REVISION ( 6 ,
7  )

◆ setInstancing()

void QQuick3DRuntimeLoader::setInstancing ( QQuick3DInstancing * newInstancing)

Definition at line 298 of file qquick3druntimeloader.cpp.

References QQuick3DObjectPrivate::attachWatcher(), emit, instancingChanged(), and setInstancing().

Referenced by setInstancing().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSource()

void QQuick3DRuntimeLoader::setSource ( const QUrl & newSource)

Definition at line 92 of file qquick3druntimeloader.cpp.

References context, emit, QQuick3DObject::isComponentComplete(), qmlContext(), resolvedUrl(), and sourceChanged().

+ Here is the call graph for this function:

◆ source()

QUrl QQuick3DRuntimeLoader::source ( ) const

Definition at line 87 of file qquick3druntimeloader.cpp.

◆ sourceChanged

void QQuick3DRuntimeLoader::sourceChanged ( )
signal

Referenced by setSource().

+ Here is the caller graph for this function:

◆ status()

QQuick3DRuntimeLoader::Status QQuick3DRuntimeLoader::status ( ) const

Definition at line 254 of file qquick3druntimeloader.cpp.

◆ statusChanged

void QQuick3DRuntimeLoader::statusChanged ( )
signal

◆ updateSpatialNode()

QSSGRenderGraphObject * QQuick3DRuntimeLoader::updateSpatialNode ( QSSGRenderGraphObject * node)
overrideprotectedvirtual

Reimplemented from QQuick3DNode.

Definition at line 264 of file qquick3druntimeloader.cpp.

References boundsChanged(), QMetaObject::invokeMethod(), Qt::QueuedConnection, and QQuick3DNode::updateSpatialNode().

+ Here is the call graph for this function:

Property Documentation

◆ bounds

QQuick3DBounds3 QQuick3DRuntimeLoader::bounds
read

Definition at line 39 of file qquick3druntimeloader_p.h.

◆ errorString

QString QQuick3DRuntimeLoader::errorString
read

Definition at line 38 of file qquick3druntimeloader_p.h.

◆ instancing

QQuick3DInstancing * QQuick3DRuntimeLoader::instancing
readwrite

Definition at line 40 of file qquick3druntimeloader_p.h.

◆ source

QUrl QQuick3DRuntimeLoader::source
readwrite

Definition at line 36 of file qquick3druntimeloader_p.h.

◆ status

Status QQuick3DRuntimeLoader::status
read

Definition at line 37 of file qquick3druntimeloader_p.h.

◆ supportedExtensions

QStringList QQuick3DRuntimeLoader::supportedExtensions
read

Definition at line 41 of file qquick3druntimeloader_p.h.

◆ supportedMimeTypes

QList< QMimeType > QQuick3DRuntimeLoader::supportedMimeTypes
read

Definition at line 42 of file qquick3druntimeloader_p.h.


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