diff options
| author | Nico Vertriest <nico.vertriest@qt.io> | 2017-08-11 14:37:11 +0200 |
|---|---|---|
| committer | Nico Vertriest <nico.vertriest@qt.io> | 2017-10-09 13:23:54 +0000 |
| commit | c0c9b4611a97afc8c12475ece5d78a62a5794e03 (patch) | |
| tree | c32cb0f95bca7d5b1f2dd387da96351aa2bf3963 /src | |
| parent | beb2387dc9ed6e9a9fc99f0984d0cd8eef1d8bff (diff) | |
Doc: add doc to undocumented methods in qt3dwindow.cpp
Change-Id: I450cdbd7cee58ae84f45ad82c5bc15489fe61771
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/extras/defaults/qt3dwindow.cpp | 28 |
1 files changed, 27 insertions, 1 deletions
diff --git a/src/extras/defaults/qt3dwindow.cpp b/src/extras/defaults/qt3dwindow.cpp index 635d81956..baa2aeddb 100644 --- a/src/extras/defaults/qt3dwindow.cpp +++ b/src/extras/defaults/qt3dwindow.cpp @@ -125,6 +125,9 @@ Qt3DWindow::~Qt3DWindow() delete d->m_aspectEngine; } +/*! + Registers the specified \a aspect. +*/ void Qt3DWindow::registerAspect(Qt3DCore::QAbstractAspect *aspect) { Q_ASSERT(!isVisible()); @@ -132,6 +135,9 @@ void Qt3DWindow::registerAspect(Qt3DCore::QAbstractAspect *aspect) d->m_aspectEngine->registerAspect(aspect); } +/*! + Registers the specified aspect \a name. +*/ void Qt3DWindow::registerAspect(const QString &name) { Q_ASSERT(!isVisible()); @@ -139,6 +145,9 @@ void Qt3DWindow::registerAspect(const QString &name) d->m_aspectEngine->registerAspect(name); } +/*! + Sets the specified \a root entity of the scene. +*/ void Qt3DWindow::setRootEntity(Qt3DCore::QEntity *root) { Q_D(Qt3DWindow); @@ -151,18 +160,27 @@ void Qt3DWindow::setRootEntity(Qt3DCore::QEntity *root) } } +/*! + Activates the specified \a activeFrameGraph. +*/ void Qt3DWindow::setActiveFrameGraph(Qt3DRender::QFrameGraphNode *activeFrameGraph) { Q_D(Qt3DWindow); d->m_renderSettings->setActiveFrameGraph(activeFrameGraph); } +/*! + Returns the node of the active frame graph. +*/ Qt3DRender::QFrameGraphNode *Qt3DWindow::activeFrameGraph() const { Q_D(const Qt3DWindow); return d->m_renderSettings->activeFrameGraph(); } +/*! + Returns the node of the default framegraph +*/ Qt3DExtras::QForwardRenderer *Qt3DWindow::defaultFrameGraph() const { Q_D(const Qt3DWindow); @@ -175,12 +193,18 @@ Qt3DRender::QCamera *Qt3DWindow::camera() const return d->m_defaultCamera; } +/*! + Returns the render settings of the 3D Window. +*/ Qt3DRender::QRenderSettings *Qt3DWindow::renderSettings() const { Q_D(const Qt3DWindow); return d->m_renderSettings; } +/*! + Manages the display events specified in \a e. +*/ void Qt3DWindow::showEvent(QShowEvent *e) { Q_D(Qt3DWindow); @@ -194,7 +218,9 @@ void Qt3DWindow::showEvent(QShowEvent *e) QWindow::showEvent(e); } - +/*! + Resets the aspect ratio of the 3D window. +*/ void Qt3DWindow::resizeEvent(QResizeEvent *) { Q_D(Qt3DWindow); |