<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qentity.cpp -->
<title>QEntity 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 >QEntity</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="#related-non-members">Related Non-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">QEntity Class</h1>
<span class="small-subtitle">(<a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a>)<br/></span>
<!-- $$$QEntity-brief -->
<p><a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> is a <a href="qt3dcore-qnode.html">Qt3DCore::QNode</a> subclass that can aggregate several <a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a> instances that will specify its behavior. <a href="#details">More...</a></p>
<!-- @@@QEntity -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QEntity></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-entity.html">Entity</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="qt3dextras-qabstractcameracontroller.html">Qt3DExtras::QAbstractCameraController</a>, <a href="qt3dextras-qskyboxentity.html">Qt3DExtras::QSkyboxEntity</a>, <a href="qt3dextras-qtext2dentity.html">Qt3DExtras::QText2DEntity</a>, and <a href="qt3drender-qcamera.html">Qt3DRender::QCamera</a></p>
</td></tr></table></div><ul>
<li><a href="qt3dcore-qentity-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-qentity.html#QEntity">QEntity</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-qentity.html#dtor.QEntity">~QEntity</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qentity.html#addComponent">addComponent</a></b>(Qt3DCore::QComponent *<i>comp</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DCore::QComponentVector </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qentity.html#components">components</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DCore::QEntity *</td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qentity.html#parentEntity">parentEntity</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qentity.html#removeComponent">removeComponent</a></b>(Qt3DCore::QComponent *<i>comp</i>)</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="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-qentity.html#staticMetaObject-var">staticMetaObject</a></b></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-qentity.html#QComponentVector-typedef">QComponentVector</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</a></li>
<li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li>
<li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QEntity-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p><a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> is a <a href="qt3dcore-qnode.html">Qt3DCore::QNode</a> subclass that can aggregate several <a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a> instances that will specify its behavior.</p>
<p>By itself a <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> is an empty shell. The behavior of a <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> object is defined by the <a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a> objects it references. Each Qt3D backend aspect will be able to interpret and process an Entity by recognizing which components it is made up of. One aspect may decide to only process entities composed of a single <a href="qt3dcore-qtransform.html">Qt3DCore::QTransform</a> component whilst another may focus on <a href="qt3dinput-qmousehandler.html">Qt3DInput::QMouseHandler</a>.</p>
</div>
<p><b>See also </b><a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a> and <a href="qt3dcore-qtransform.html">Qt3DCore::QTransform</a>.</p>
<!-- @@@QEntity -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QEntity[overload1]$$$QEntityQt3DCore::QNode* -->
<h3 class="fn" id="QEntity"><a name="QEntity"></a>QEntity::<span class="name">QEntity</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-qentity.html">Qt3DCore::QEntity</a> instance with <i>parent</i> as parent.</p>
<!-- @@@QEntity -->
<!-- $$$~QEntity[overload1]$$$~QEntity -->
<h3 class="fn" id="dtor.QEntity"><a name="dtor.QEntity"></a><code>[virtual] </code>QEntity::<span class="name">~QEntity</span>()</h3>
<p>Destroys the instance of QEntity. The destructor is virtual.</p><!-- @@@~QEntity -->
<!-- $$$addComponent[overload1]$$$addComponentQt3DCore::QComponent* -->
<h3 class="fn" id="addComponent"><a name="addComponent"></a><span class="type">void</span> QEntity::<span class="name">addComponent</span>(<span class="type"><a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a></span> *<i>comp</i>)</h3>
<p>Adds a new reference to the component <i>comp</i>.</p>
<p><b>Note: </b>If the <a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a> has no parent, the <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> will set itself as its parent thereby taking ownership of the component.</p><!-- @@@addComponent -->
<!-- $$$components[overload1]$$$components -->
<h3 class="fn" id="components"><a name="components"></a><span class="type"><a href="qt3dcore-qentity.html#QComponentVector-typedef">Qt3DCore::QComponentVector</a></span> QEntity::<span class="name">components</span>() const</h3>
<p>Returns the list of <a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a> instances the entity is referencing.</p>
<!-- @@@components -->
<!-- $$$parentEntity[overload1]$$$parentEntity -->
<h3 class="fn" id="parentEntity"><a name="parentEntity"></a><span class="type"><a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a></span> *QEntity::<span class="name">parentEntity</span>() const</h3>
<p>Returns the parent <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> instance of this entity. If the immediate parent isn't a <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a>, this function traverses up the scene hierarchy until a parent <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> is found. If no <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> parent can be found, returns null.</p>
<!-- @@@parentEntity -->
<!-- $$$removeComponent[overload1]$$$removeComponentQt3DCore::QComponent* -->
<h3 class="fn" id="removeComponent"><a name="removeComponent"></a><span class="type">void</span> QEntity::<span class="name">removeComponent</span>(<span class="type"><a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a></span> *<i>comp</i>)</h3>
<p>Removes the reference to <i>comp</i>.</p>
<!-- @@@removeComponent -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$QComponentVector -->
<h3 class="fn" id="QComponentVector-typedef"><a name="QComponentVector-typedef"></a>typedef Qt3DCore::<span class="name">QComponentVector</span></h3>
<p>List of <a href="qt3dcore-qcomponent.html">QComponent</a> pointers.</p>
<!-- @@@QComponentVector -->
</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>
