QQmlAspectEngine Class

class Qt3DCore::Quick::QQmlAspectEngine

The QQmlAspectEngine provides an environment for the QAspectEngine and a method for instantiating QML components. More...

Header:	#include <Qt3DQuick/QQmlAspectEngine>
CMake:	find_package(Qt6 REQUIRED COMPONENTS 3dcore) target_link_libraries(mytarget PRIVATE Qt6::3dcore)
qmake:	QT += 3dcore
Inherits:	QObject

List of all members, including inherited members

Public Types

enum	Status { Null, Ready, Loading, Error }

Public Functions

	QQmlAspectEngine(QObject *parent = nullptr)
Qt3DCore::QAspectEngine *	aspectEngine() const
QQmlEngine *	qmlEngine() const
void	setSource(const QUrl &source)
Qt3DCore::Quick::QQmlAspectEngine::Status	status() const

Signals

void	sceneCreated(QObject *rootObject)
void	statusChanged(Qt3DCore::Quick::QQmlAspectEngine::Status status)

Detailed Description

Member Type Documentation

enum QQmlAspectEngine::Status

The status of the engine.

Constant	Value
`Qt3DCore::Quick::QQmlAspectEngine::Null`	`0`
`Qt3DCore::Quick::QQmlAspectEngine::Ready`	`1`
`Qt3DCore::Quick::QQmlAspectEngine::Loading`	`2`
`Qt3DCore::Quick::QQmlAspectEngine::Error`	`3`

Member Function Documentation

`[explicit]` QQmlAspectEngine::QQmlAspectEngine(QObject **parent* = nullptr)

Constructs a new QQmlAspectEngine with parent.

Qt3DCore::QAspectEngine *QQmlAspectEngine::aspectEngine() const

Returns the aspectEngine.

QQmlEngine *QQmlAspectEngine::qmlEngine() const

Returns the engine.

`[signal]` void QQmlAspectEngine::sceneCreated(QObject **rootObject*)

This signal is emitted with rootObject when the scene has been instantiated. This provides a chance to manipulate the scene before passing it over to the aspect engine. Useful for convenience window classes to set up cameras and surfaces on the framegraph and event sources for the input aspect etc.

void QQmlAspectEngine::setSource(const QUrl &source)

Sets source as a source for the QML component to be created.

Qt3DCore::Quick::QQmlAspectEngine::Status QQmlAspectEngine::status() const

Returns the status.

`[signal]` void QQmlAspectEngine::statusChanged(Qt3DCore::Quick::QQmlAspectEngine::Status status)

This signal is emitted with status when the status of the engine changes.

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.