<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlayerfilter.cpp -->
<title>QLayerFilter Class | Qt 3D 5.9</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.9</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QLayerFilter</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</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="#protected-functions">Protected Functions</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">QLayerFilter Class</h1>
<span class="small-subtitle">(<a href="qt3drender-qlayerfilter.html">Qt3DRender::QLayerFilter</a>)<br/></span>
<!-- $$$QLayerFilter-brief -->
<p>Controls layers Drawn in a frame graph branch. <a href="#details">More...</a></p>
<!-- @@@QLayerFilter -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QLayerFilter></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3drender</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-render-layerfilter.html">LayerFilter</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3drender-qframegraphnode.html">Qt3DRender::QFrameGraphNode</a></td></tr></table></div><ul>
<li><a href="qt3drender-qlayerfilter-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="qt3drender-qlayerfilter.html#QLayerFilter">QLayerFilter</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qlayerfilter.html#addLayer">addLayer</a></b>(QLayer *<i>layer</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVector<QLayer *> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qlayerfilter.html#layers">layers</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qlayerfilter.html#removeLayer">removeLayer</a></b>(QLayer *<i>layer</i>)</td></tr>
</table></div>
<ul>
<li class="fn">1 public function inherited from <a href="qt3drender-qframegraphnode.html#public-functions">Qt3DRender::QFrameGraphNode</a></li>
<li class="fn">11 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qlayerfilter.html#QLayerFilter-1">QLayerFilter</a></b>(QLayerFilterPrivate &<i>dd</i>, Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
</table></div>
<ul>
<li class="fn">1 protected function inherited from <a href="qt3drender-qframegraphnode.html#protected-functions">Qt3DRender::QFrameGraphNode</a></li>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<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>
</ul>
<a name="details"></a>
<!-- $$$QLayerFilter-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Controls layers Drawn in a frame graph branch.</p>
<p>A <a href="qt3drender-qlayerfilter.html">Qt3DRender::QLayerFilter</a> can be used to instruct the renderer as to which layer(s) to draw in that branch of the frame graph. The <a href="qt3drender-qlayerfilter.html">Qt3DRender::QLayerFilter</a> selects which entities to draw based on the <a href="qt3drender-qlayer.html">Qt3DRender::QLayer</a> instances added to the <a href="qt3drender-qlayerfilter.html">QLayerFilter</a> and as components to the <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a>.</p>
</div>
<!-- @@@QLayerFilter -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLayerFilter[overload1]$$$QLayerFilterQt3DCore::QNode* -->
<h3 class="fn" id="QLayerFilter"><a name="QLayerFilter"></a>QLayerFilter::<span class="name">QLayerFilter</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3>
<p>Default constructs an instance of QLayerFilter.</p><!-- @@@QLayerFilter -->
<!-- $$$QLayerFilter$$$QLayerFilterQLayerFilterPrivate&Qt3DCore::QNode* -->
<h3 class="fn" id="QLayerFilter-1"><a name="QLayerFilter-1"></a><code>[protected] </code>QLayerFilter::<span class="name">QLayerFilter</span>(<span class="type">QLayerFilterPrivate</span> &<i>dd</i>, <span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3>
<p>Copy constructor.</p><!-- @@@QLayerFilter -->
<!-- $$$addLayer[overload1]$$$addLayerQLayer* -->
<h3 class="fn" id="addLayer"><a name="addLayer"></a><span class="type">void</span> QLayerFilter::<span class="name">addLayer</span>(<span class="type"><a href="qt3drender-qlayer.html">QLayer</a></span> *<i>layer</i>)</h3>
<p>Add <i>layer</i> to the current list of layers</p>
<!-- @@@addLayer -->
<!-- $$$layers[overload1]$$$layers -->
<h3 class="fn" id="layers"><a name="layers"></a><span class="type">QVector</span><<span class="type"><a href="qt3drender-qlayer.html">QLayer</a></span> *> QLayerFilter::<span class="name">layers</span>() const</h3>
<p>Returns the current list of layers</p>
<!-- @@@layers -->
<!-- $$$removeLayer[overload1]$$$removeLayerQLayer* -->
<h3 class="fn" id="removeLayer"><a name="removeLayer"></a><span class="type">void</span> QLayerFilter::<span class="name">removeLayer</span>(<span class="type"><a href="qt3drender-qlayer.html">QLayer</a></span> *<i>layer</i>)</h3>
<p>Remove <i>layer</i> from the current list of layers</p>
<!-- @@@removeLayer -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 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>
