<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcomponent.cpp -->
<title>QComponent 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 >QComponent</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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QComponent Class</h1>
<span class="small-subtitle">(<a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a>)<br/></span>
<!-- $$$QComponent-brief -->
<p>The base class of scene nodes that can be aggregated by <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> instances as a component. <a href="#details">More...</a></p>
<!-- @@@QComponent -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QComponent></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"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.5</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-core-component3d.html">Component3D</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qt3danimation-qabstractclipanimator.html">Qt3DAnimation::QAbstractClipAnimator</a>, <a href="qt3dcore-qarmature.html">Qt3DCore::QArmature</a>, <a href="qt3dcore-qtransform.html">Qt3DCore::QTransform</a>, <a href="qt3dinput-qaxisaccumulator.html">Qt3DInput::QAxisAccumulator</a>, <a href="qt3dinput-qinputsettings.html">Qt3DInput::QInputSettings</a>, <a href="qt3dinput-qkeyboardhandler.html">Qt3DInput::QKeyboardHandler</a>, <a href="qt3dinput-qlogicaldevice.html">Qt3DInput::QLogicalDevice</a>, <a href="qt3dinput-qmousehandler.html">Qt3DInput::QMouseHandler</a>, <a href="qt3dlogic-qframeaction.html">Qt3DLogic::QFrameAction</a>, <a href="qt3drender-qabstractlight.html">Qt3DRender::QAbstractLight</a>, <a href="qt3drender-qabstractraycaster.html">Qt3DRender::QAbstractRayCaster</a>, <a href="qt3drender-qcameralens.html">Qt3DRender::QCameraLens</a>, <a href="qt3drender-qcomputecommand.html">Qt3DRender::QComputeCommand</a>, <a href="qt3drender-qenvironmentlight.html">Qt3DRender::QEnvironmentLight</a>, <a href="qt3drender-qgeometryrenderer.html">Qt3DRender::QGeometryRenderer</a>, <a href="qt3drender-qlayer.html">Qt3DRender::QLayer</a>, <a href="qt3drender-qlevelofdetail.html">Qt3DRender::QLevelOfDetail</a>, <a href="qt3drender-qmaterial.html">Qt3DRender::QMaterial</a>, <a href="qt3drender-qobjectpicker.html">Qt3DRender::QObjectPicker</a>, <a href="qt3drender-qrendersettings.html">Qt3DRender::QRenderSettings</a>, <a href="qt3drender-qrendertarget.html">Qt3DRender::QRenderTarget</a>, <a href="qt3drender-qsceneloader.html">Qt3DRender::QSceneLoader</a>, and <a href="qt3drender-qshaderdata.html">Qt3DRender::QShaderData</a></p>
</td></tr></table></div><ul>
<li><a href="qt3dcore-qcomponent-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qt3dcore-qcomponent.html#isShareable-prop">isShareable</a></b> : bool</li>
</ul>
<ul>
<li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</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-qcomponent.html#QComponent">QComponent</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qcomponent.html#dtor.QComponent">~QComponent</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVector<Qt3DCore::QEntity *> </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qcomponent.html#entities">entities</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qcomponent.html#isShareable-prop">isShareable</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qcomponent.html#isShareable-prop">setShareable</a></b>(bool <i>isShareable</i>)</td></tr>
</table></div>
<ul>
<li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qcomponent.html#addedToEntity">addedToEntity</a></b>(Qt3DCore::QEntity *<i>entity</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qcomponent.html#removedFromEntity">removedFromEntity</a></b>(Qt3DCore::QEntity *<i>entity</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qcomponent.html#isShareable-prop">shareableChanged</a></b>(bool <i>isShareable</i>)</td></tr>
</table></div>
<ul>
<li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li>
</ul>
<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-qcomponent.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QComponent-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The base class of scene nodes that can be aggregated by <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> instances as a component.</p>
<p>A <a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a> provides a vertical slice of behavior that can be assigned to and sometimes shared across <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> instances.</p>
<p><a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a> subclasses are often aggregated in groups that impart useful behavior to the aggregating entity. For example, to have an Entity that gets drawn by the Qt3D renderer aspect, an entity would most likely aggregate <a href="qt3dcore-qtransform.html">Qt3DCore::QTransform</a>, <a href="qt3drender-qmesh.html">Qt3DRender::QMesh</a>, and <a href="qt3drender-qmaterial.html">Qt3DRender::QMaterial</a> components.</p>
</div>
<p><b>See also </b><a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a>.</p>
<!-- @@@QComponent -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$isShareable-prop$$$isShareable$$$setShareablebool$$$shareableChangedbool -->
<h3 class="fn" id="isShareable-prop"><a name="isShareable-prop"></a><span class="name">isShareable</span> : <span class="type">bool</span></h3>
<p>Holds the shareable flag of the <a href="qt3dcore-qcomponent.html">QComponent</a>. The <a href="qt3dcore-qcomponent.html">QComponent</a> can be shared across several entities if <code>true</code>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isShareable</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setShareable</b></span>(bool <i>isShareable</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>shareableChanged</b></span>(bool <i>isShareable</i>)</td></tr>
</table></div>
<!-- @@@isShareable -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QComponent[overload1]$$$QComponentQt3DCore::QNode* -->
<h3 class="fn" id="QComponent"><a name="QComponent"></a>QComponent::<span class="name">QComponent</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new <a href="qt3dcore-qcomponent.html">QComponent</a> instance with <i>parent</i> as the parent.</p>
<p><b>Note: </b>a <a href="qt3dcore-qcomponent.html">QComponent</a> should never be instanced directly, instance one of the subclasses instead.</p><!-- @@@QComponent -->
<!-- $$$~QComponent[overload1]$$$~QComponent -->
<h3 class="fn" id="dtor.QComponent"><a name="dtor.QComponent"></a><code>[virtual] </code>QComponent::<span class="name">~QComponent</span>()</h3>
<p>Destroys the instance of QComponent. The destructor is virtual.</p><!-- @@@~QComponent -->
<!-- $$$addedToEntity[overload1]$$$addedToEntityQt3DCore::QEntity* -->
<h3 class="fn" id="addedToEntity"><a name="addedToEntity"></a><code>[signal] </code><span class="type">void</span> QComponent::<span class="name">addedToEntity</span>(<span class="type"><a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a></span> *<i>entity</i>)</h3>
<!-- @@@addedToEntity -->
<!-- $$$entities[overload1]$$$entities -->
<h3 class="fn" id="entities"><a name="entities"></a><span class="type">QVector</span><<span class="type"><a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a></span> *> QComponent::<span class="name">entities</span>() const</h3>
<p>Returns a QVector containing all the entities that reference this component.</p>
<!-- @@@entities -->
<!-- $$$removedFromEntity[overload1]$$$removedFromEntityQt3DCore::QEntity* -->
<h3 class="fn" id="removedFromEntity"><a name="removedFromEntity"></a><code>[signal] </code><span class="type">void</span> QComponent::<span class="name">removedFromEntity</span>(<span class="type"><a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a></span> *<i>entity</i>)</h3>
<!-- @@@removedFromEntity -->
</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>
