diff options
Diffstat (limited to 'src/core/aspects/qabstractaspect.cpp')
| -rw-r--r-- | src/core/aspects/qabstractaspect.cpp | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/core/aspects/qabstractaspect.cpp b/src/core/aspects/qabstractaspect.cpp index e793eebca..7b08dec81 100644 --- a/src/core/aspects/qabstractaspect.cpp +++ b/src/core/aspects/qabstractaspect.cpp @@ -101,6 +101,26 @@ void QAbstractAspectPrivate::unregisterBackendType(const QMetaObject &mo) */ /*! + * \macro QT3D_REGISTER_ASPECT(name, AspectType) + * \relates Qt3DCore::QAbstractAspect + * + * Convenience macro for registering \a AspectType for instantiation by the + * currently set Qt3DCore::QAspectFactory. This makes it possible to create an + * instance of \a AspectType in the aspect thread by later passing \a name to + * Qt3DCore::QAspectEngine::registerAspect(const QString &name). + * + * \note It is also possible to register a new aspect without using this macro + * by instead using Qt3DCore::QAspectEngine::registerAspect(QAbstractAspect *aspect) + * which will handle moving a previously created aspect instance to the aspect + * thread context. + * + * KDAB has published a few articles about writing custom Qt3D aspects + * \l {https://www.kdab.com/writing-custom-qt-3d-aspect/}{on their blog}. These + * provide an excellent starting point if you wish to learn more about it. + */ + + +/*! * Constructs a new QAbstractAspect with \a parent */ QAbstractAspect::QAbstractAspect(QObject *parent) |