<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qabstractaspect.cpp -->
<title>QAbstractAspect Class | Qt 3D 5.12.2</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QAbstractAspect</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#related-non-members">Related Non-Members</a></li>
<li class="level1"><a href="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QAbstractAspect Class</h1>
<span class="small-subtitle">(<a href="qt3dcore-qabstractaspect.html">Qt3DCore::QAbstractAspect</a>)<br/></span>
<!-- $$$QAbstractAspect-brief -->
<p><a href="qt3dcore-qabstractaspect.html">QAbstractAspect</a> is the base class for aspects that provide a vertical slice of behavior. <a href="#details">More...</a></p>
<!-- @@@QAbstractAspect -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Qt3DCore/QAbstractAspect></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dcore</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qt3danimation-qanimationaspect.html">Qt3DAnimation::QAnimationAspect</a>, <a href="qt3dinput-qinputaspect.html">Qt3DInput::QInputAspect</a>, <a href="qt3dlogic-qlogicaspect.html">Qt3DLogic::QLogicAspect</a>, and <a href="qt3drender-qrenderaspect.html">Qt3DRender::QRenderAspect</a></p>
</td></tr></table></div><ul>
<li><a href="qt3dcore-qabstractaspect-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#QAbstractAspect">QAbstractAspect</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#scheduleSingleShotJob">scheduleSingleShotJob</a></b>(const Qt3DCore::QAspectJobPtr &<i>job</i>)</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#registerBackendType">registerBackendType</a></b>(const Qt3DCore::QBackendNodeMapperPtr &<i>functor</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#registerBackendType-1">registerBackendType</a></b>(const QMetaObject &<i>obj</i>, const Qt3DCore::QBackendNodeMapperPtr &<i>functor</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DCore::QNodeId </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#rootEntityId">rootEntityId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#unregisterBackendType">unregisterBackendType</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#unregisterBackendType-1">unregisterBackendType</a></b>(<i>const QMetaObject &</i>)</td></tr>
</table></div>
<a name="related-non-members"></a>
<h2 id="related-non-members">Related Non-Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#QAspectJobPtr-typedef">QAspectJobPtr</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#QBackendNodeMapperPtr-typedef">QBackendNodeMapperPtr</a></b></td></tr>
</table></div>
<a name="macros"></a>
<h2 id="macros">Macros</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qabstractaspect.html#QT3D_REGISTER_ASPECT">QT3D_REGISTER_ASPECT</a></b>(<i>name</i>, <i>AspectType</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QAbstractAspect-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p><a href="qt3dcore-qabstractaspect.html">QAbstractAspect</a> is the base class for aspects that provide a vertical slice of behavior.</p>
</div>
<!-- @@@QAbstractAspect -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAbstractAspect[overload1]$$$QAbstractAspectQObject* -->
<h3 class="fn" id="QAbstractAspect"><a name="QAbstractAspect"></a>QAbstractAspect::<span class="name">QAbstractAspect</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new <a href="qt3dcore-qabstractaspect.html">QAbstractAspect</a> with <i>parent</i></p>
<!-- @@@QAbstractAspect -->
<!-- $$$registerBackendType[overload1]$$$registerBackendTypeconstQt3DCore::QBackendNodeMapperPtr& -->
<h3 class="fn" id="registerBackendType"><a name="registerBackendType"></a><code>[protected] </code><span class="type">void</span> QAbstractAspect::<span class="name">registerBackendType</span>(const <span class="type"><a href="qt3dcore-qabstractaspect.html#QBackendNodeMapperPtr-typedef">Qt3DCore::QBackendNodeMapperPtr</a></span> &<i>functor</i>)</h3>
<!-- @@@registerBackendType -->
<!-- $$$registerBackendType$$$registerBackendTypeconstQMetaObject&constQt3DCore::QBackendNodeMapperPtr& -->
<h3 class="fn" id="registerBackendType-1"><a name="registerBackendType-1"></a><code>[protected] </code><span class="type">void</span> QAbstractAspect::<span class="name">registerBackendType</span>(const <span class="type">QMetaObject</span> &<i>obj</i>, const <span class="type"><a href="qt3dcore-qabstractaspect.html#QBackendNodeMapperPtr-typedef">Qt3DCore::QBackendNodeMapperPtr</a></span> &<i>functor</i>)</h3>
<p>Registers backend with <i>obj</i> and <i>functor</i>.</p>
<!-- @@@registerBackendType -->
<!-- $$$rootEntityId[overload1]$$$rootEntityId -->
<h3 class="fn" id="rootEntityId"><a name="rootEntityId"></a><code>[protected] </code><span class="type"><a href="qt3dcore-qnodeid.html">Qt3DCore::QNodeId</a></span> QAbstractAspect::<span class="name">rootEntityId</span>() const</h3>
<p>Returns root entity node id.</p>
<!-- @@@rootEntityId -->
<!-- $$$scheduleSingleShotJob[overload1]$$$scheduleSingleShotJobconstQt3DCore::QAspectJobPtr& -->
<h3 class="fn" id="scheduleSingleShotJob"><a name="scheduleSingleShotJob"></a><span class="type">void</span> QAbstractAspect::<span class="name">scheduleSingleShotJob</span>(const <span class="type"><a href="qt3dcore-qabstractaspect.html#QAspectJobPtr-typedef">Qt3DCore::QAspectJobPtr</a></span> &<i>job</i>)</h3>
<!-- @@@scheduleSingleShotJob -->
<!-- $$$unregisterBackendType[overload1]$$$unregisterBackendType -->
<h3 class="fn" id="unregisterBackendType"><a name="unregisterBackendType"></a><code>[protected] </code><span class="type">void</span> QAbstractAspect::<span class="name">unregisterBackendType</span>()</h3>
<!-- @@@unregisterBackendType -->
<!-- $$$unregisterBackendType$$$unregisterBackendTypeconstQMetaObject& -->
<h3 class="fn" id="unregisterBackendType-1"><a name="unregisterBackendType-1"></a><code>[protected] </code><span class="type">void</span> QAbstractAspect::<span class="name">unregisterBackendType</span>(<i>const QMetaObject &</i>)</h3>
<!-- @@@unregisterBackendType -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$QAspectJobPtr -->
<h3 class="fn" id="QAspectJobPtr-typedef"><a name="QAspectJobPtr-typedef"></a>typedef Qt3DCore::<span class="name">QAspectJobPtr</span></h3>
<p>A shared pointer for <a href="qt3dcore-qaspectjob.html">QAspectJob</a>.</p>
<!-- @@@QAspectJobPtr -->
<!-- $$$QBackendNodeMapperPtr -->
<h3 class="fn" id="QBackendNodeMapperPtr-typedef"><a name="QBackendNodeMapperPtr-typedef"></a>typedef Qt3DCore::<span class="name">QBackendNodeMapperPtr</span></h3>
<p>A shared pointer for <a href="qt3dcore-qbackendnodemapper.html">QBackendNodeMapper</a>.</p>
<!-- @@@QBackendNodeMapperPtr -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QT3D_REGISTER_ASPECT[overload1]$$$QT3D_REGISTER_ASPECT -->
<h3 class="fn" id="QT3D_REGISTER_ASPECT"><a name="QT3D_REGISTER_ASPECT"></a><span class="name">QT3D_REGISTER_ASPECT</span>(<i>name</i>, <i>AspectType</i>)</h3>
<p>Convenience macro for registering <i>AspectType</i> for instantiation by the currently set Qt3DCore::QAspectFactory. This makes it possible to create an instance of <i>AspectType</i> in the aspect thread by later passing <i>name</i> to <a href="qt3dcore-qaspectengine.html#registerAspect">Qt3DCore::QAspectEngine::registerAspect</a>(const QString &name).</p>
<p><b>Note: </b>It is also possible to register a new aspect without using this macro by instead using <a href="qt3dcore-qaspectengine.html#registerAspect">Qt3DCore::QAspectEngine::registerAspect</a>(QAbstractAspect *aspect) which will handle moving a previously created aspect instance to the aspect thread context.</p><p>KDAB has published a few articles about writing custom Qt3D aspects <a href="https://www.kdab.com/writing-custom-qt-3d-aspect/">on their blog</a>. These provide an excellent starting point if you wish to learn more about it.</p>
<!-- @@@QT3D_REGISTER_ASPECT -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> 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. </p>
</div>
</body>
</html>
