Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-release > by-pkgid > c936229ef0138f42857f36beadbeda30 > files > 1011

qt3d5-doc-5.12.2-2.mga7.noarch.rpm

<?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.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 >QLayerFilter</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-types">Public Types</a></li>
<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="#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">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 &lt;QLayerFilter&gt;</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-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qlayerfilter.html#FilterMode-enum">FilterMode</a></b> { AcceptAnyMatchingLayers, AcceptAllMatchingLayers, DiscardAnyMatchingLayers, DiscardAllMatchingLayers }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qt3drender-qlayerfilter.html#filterMode-prop">filterMode</a></b> : FilterMode</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="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>(Qt3DRender::QLayer *<i>layer</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QLayerFilter::FilterMode </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qlayerfilter.html#filterMode-prop">filterMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVector&lt;Qt3DRender::QLayer *&gt; </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>(Qt3DRender::QLayer *<i>layer</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qlayerfilter.html#filterMode-prop">setFilterMode</a></b>(Qt3DRender::QLayerFilter::FilterMode <i>filterMode</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">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">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="qt3drender-qlayerfilter.html#filterMode-prop">filterModeChanged</a></b>(Qt3DRender::QLayerFilter::FilterMode <i>filterMode</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="qt3drender-qlayerfilter.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li>
<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>
<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. <a href="qt3drender-qlayerfilter.html">QLayerFilter</a> selects which entities to draw based on the <a href="qt3drender-qlayer.html">QLayer</a> instance(s) added to the <a href="qt3drender-qlayerfilter.html">QLayerFilter</a> and as components to <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a>.</p>
<p><a href="qt3drender-qlayerfilter.html">QLayerFilter</a> can be configured to select or discard entities with a specific <a href="qt3drender-qlayer.html">QLayer</a> depending on the <a href="qt3drender-qlayerfilter.html#filterMode-prop">filterMode</a> property. By default, entities referencing one of the <a href="qt3drender-qlayer.html">QLayer</a> objects that are also being referenced by the <a href="qt3drender-qlayerfilter.html">QLayerFilter</a> are selected (<a href="qt3drender-qlayerfilter.html#FilterMode-enum">AcceptAnyMatchingLayers</a>).</p>
<p>Within the FrameGraph tree, multiple <a href="qt3drender-qlayerfilter.html">QLayerFilter</a> nodes can be nested within a branch going from root to a leaf. In that case the filtering will first operate on all entities of the scene using the filtering method specified by the first declared <a href="qt3drender-qlayerfilter.html">QLayerFilter</a>. Then the filtered subset of entities will be filtered again based on the filtering method set on the second <a href="qt3drender-qlayerfilter.html">QLayerFilter</a> declared. This is then repeated until all <a href="qt3drender-qlayerfilter.html">QLayerFilter</a> nodes of the branch have been consumed.</p>
</div>
<!-- @@@QLayerFilter -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$FilterMode$$$AcceptAnyMatchingLayers$$$AcceptAllMatchingLayers$$$DiscardAnyMatchingLayers$$$DiscardAllMatchingLayers -->
<h3 class="fn" id="FilterMode-enum"><a name="FilterMode-enum"></a>enum QLayerFilter::<span class="name">FilterMode</span></h3>
<p>Specifies the rules for selecting entities to draw.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Qt3DRender::QLayerFilter::AcceptAnyMatchingLayers</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Accept entities that reference one or more <a href="qt3drender-qlayer.html">QLayer</a> objects added to this <a href="qt3drender-qlayerfilter.html">QLayerFilter</a>. This is the default</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QLayerFilter::AcceptAllMatchingLayers</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Accept entities that reference all the <a href="qt3drender-qlayer.html">QLayer</a> objects added to this <a href="qt3drender-qlayerfilter.html">QLayerFilter</a></td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QLayerFilter::DiscardAnyMatchingLayers</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Discard entities that reference one or more <a href="qt3drender-qlayer.html">QLayer</a> objects added to this <a href="qt3drender-qlayerfilter.html">QLayerFilter</a></td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QLayerFilter::DiscardAllMatchingLayers</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Discard entities that reference all <a href="qt3drender-qlayer.html">QLayer</a> objects added to this <a href="qt3drender-qlayerfilter.html">QLayerFilter</a></td></tr>
</table></div>
<!-- @@@FilterMode -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$filterMode-prop$$$filterMode$$$setFilterModeQt3DRender::QLayerFilter::FilterMode$$$filterModeChangedQt3DRender::QLayerFilter::FilterMode -->
<h3 class="fn" id="filterMode-prop"><a name="filterMode-prop"></a><span class="name">filterMode</span> : <span class="type"><a href="qt3drender-qlayerfilter.html#FilterMode-enum">FilterMode</a></span></h3>
<p>Holds the filter mode specifying the entities to select for drawing.</p>
<p>The default value is AcceptMatchingLayers.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QLayerFilter::FilterMode </td><td class="memItemRight bottomAlign"><span class="name"><b>filterMode</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFilterMode</b></span>(Qt3DRender::QLayerFilter::FilterMode <i>filterMode</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>filterModeChanged</b></span>(Qt3DRender::QLayerFilter::FilterMode <i>filterMode</i>)</td></tr>
</table></div>
<!-- @@@filterMode -->
</div>
<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"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>The constructor creates an instance with the specified <i>parent</i>.</p>
<!-- @@@QLayerFilter -->
<!-- $$$addLayer[overload1]$$$addLayerQt3DRender::QLayer* -->
<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">Qt3DRender::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>&lt;<span class="type"><a href="qt3drender-qlayer.html">Qt3DRender::QLayer</a></span> *&gt; QLayerFilter::<span class="name">layers</span>() const</h3>
<p>Returns the current list of layers</p>
<!-- @@@layers -->
<!-- $$$removeLayer[overload1]$$$removeLayerQt3DRender::QLayer* -->
<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">Qt3DRender::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">&copy;</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>