QQmlAspectEngine Class

(Qt3DCore::Quick::QQmlAspectEngine)

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

Header: #include <Qt3DQuick/QQmlAspectEngine>
qmake: QT += 3dcore
Inherits: QObject

Public Types

enum Status { Null, Ready, Loading, Error }

Public Functions

QQmlAspectEngine(QObject *parent = nullptr)
QAspectEngine *aspectEngine() const
QQmlEngine *qmlEngine() const
void setSource(const QUrl &source)
Status status() const
  • 32 public functions inherited from QObject

Signals

void sceneCreated(QObject *rootObject)
void statusChanged(Status status)

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 11 static public members inherited from QObject
  • 9 protected functions inherited from QObject

Detailed Description

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

Member Type Documentation

enum QQmlAspectEngine::Status

The status of the engine.

ConstantValue
Qt3DCore::Quick::QQmlAspectEngine::Null0
Qt3DCore::Quick::QQmlAspectEngine::Ready1
Qt3DCore::Quick::QQmlAspectEngine::Loading2
Qt3DCore::Quick::QQmlAspectEngine::Error3

Member Function Documentation

QQmlAspectEngine::QQmlAspectEngine(QObject *parent = nullptr)

Constructs a new QQmlAspectEngine with parent.

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.

Status QQmlAspectEngine::status() const

Returns the status.

[signal] void QQmlAspectEngine::statusChanged(Status status)

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

© 2017 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.