qt3drender-qlayer.html 12.4 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlayer.cpp -->
  <title>QLayer Class | Qt 3D 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QLayer</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.11.2 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="#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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QLayer Class</h1>
<span class="small-subtitle">(<a href="qt3drender-qlayer.html">Qt3DRender::QLayer</a>)<br/></span>
<!-- $$$QLayer-brief -->
<p>The <a href="qt3drender-qlayer.html">QLayer</a> class provides a way of filtering which entities will be rendered. <a href="#details">More...</a></p>
<!-- @@@QLayer -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QLayer&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-layer.html">Layer</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a></td></tr></table></div><ul>
<li><a href="qt3drender-qlayer-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="qt3drender-qlayer.html#recursive-prop">recursive</a></b> : bool</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qt3dcore-qcomponent.html#properties">Qt3DCore::QComponent</a></li>
<li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</a></li>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</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-qlayer.html#QLayer">QLayer</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qlayer.html#recursive-prop">recursive</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qlayer.html#recursive-prop">setRecursive</a></b>(bool <i>recursive</i>)</td></tr>
</table></div>
<ul>
<li class="fn">2 public functions inherited from <a href="qt3dcore-qcomponent.html#public-functions">Qt3DCore::QComponent</a></li>
<li class="fn">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li>
<li class="fn">34 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</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-qlayer.html#recursive-prop">recursiveChanged</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">3 signals inherited from <a href="qt3dcore-qcomponent.html#signals">Qt3DCore::QComponent</a></li>
<li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public slot inherited from <a href="qt3dcore-qcomponent.html#public-slots">Qt3DCore::QComponent</a></li>
<li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QLayer-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qt3drender-qlayer.html">QLayer</a> class provides a way of filtering which entities will be rendered.</p>
<p><a href="qt3drender-qlayer.html">Qt3DRender::QLayer</a> works in conjunction with the <a href="qt3drender-qlayerfilter.html">Qt3DRender::QLayerFilter</a> in the FrameGraph.</p>
<p>A <a href="qt3drender-qlayer.html">QLayer</a> can be applied to a subtree of entities by setting the recursive property to true.</p>
<pre class="cpp">

   <span class="preprocessor">#include &lt;Qt3DCore/QEntity&gt;</span>
   <span class="preprocessor">#include &lt;Qt3DRender/QGeometryRenderer&gt;</span>
   <span class="preprocessor">#include &lt;Qt3DRender/QLayer&gt;</span>
   <span class="preprocessor">#include &lt;Qt3DRender/QLayerFilter&gt;</span>
   <span class="preprocessor">#include &lt;Qt3DRender/QViewport&gt;</span>

  <span class="comment">// Scene</span>
  <span class="type">Qt3DCore</span><span class="operator">::</span><span class="type">QEntity</span> <span class="operator">*</span>rootEntity <span class="operator">=</span> <span class="keyword">new</span> <span class="type">Qt3DCore</span><span class="operator">::</span><span class="type">Qt3DCore</span><span class="operator">::</span><span class="type">QEntity</span>;

  <span class="type">Qt3DCore</span><span class="operator">::</span><span class="type">QEntity</span> <span class="operator">*</span>renderableEntity <span class="operator">=</span> <span class="keyword">new</span> <span class="type">Qt3DCore</span><span class="operator">::</span><span class="type">Qt3DCore</span><span class="operator">::</span><span class="type">QEntity</span>(rootEntity);
  <span class="type">Qt3DRender</span><span class="operator">::</span><span class="type"><a href="qt3drender-qgeometryrenderer.html">QGeometryRenderer</a></span> <span class="operator">*</span>geometryRenderer <span class="operator">=</span> <span class="keyword">new</span> <span class="type">Qt3DCore</span><span class="operator">::</span><span class="type"><a href="qt3drender-qgeometryrenderer.html">QGeometryRenderer</a></span>(renderableEntity);
  <span class="type">Qt3DRender</span><span class="operator">::</span><span class="type"><a href="qt3drender-qlayer.html#QLayer">QLayer</a></span> <span class="operator">*</span>layer1 <span class="operator">=</span> <span class="keyword">new</span> <span class="type">Qt3DCore</span><span class="operator">::</span><span class="type"><a href="qt3drender-qlayer.html#QLayer">QLayer</a></span>(renderableEntity);
  layer1<span class="operator">-</span><span class="operator">&gt;</span>setRecursive(<span class="keyword">true</span>);
  renderableEntity<span class="operator">-</span><span class="operator">&gt;</span>addComponent(geometryRenderer);
  renderableEntity<span class="operator">-</span><span class="operator">&gt;</span>addComponent(layer1);

  <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>

  <span class="comment">// FrameGraph</span>
  <span class="type">Qt3DRender</span><span class="operator">::</span><span class="type"><a href="qt3drender-qviewport.html">QViewport</a></span> <span class="operator">*</span>viewport <span class="operator">=</span> <span class="keyword">new</span> <span class="type">Qt3DRender</span><span class="operator">::</span><span class="type"><a href="qt3drender-qviewport.html">QViewport</a></span>;
  <span class="type">Qt3DRender</span><span class="operator">::</span><span class="type"><a href="qt3drender-qlayerfilter.html">QLayerFilter</a></span> <span class="operator">*</span>layerFilter <span class="operator">=</span> <span class="keyword">new</span> <span class="type">Qt3DRender</span><span class="operator">::</span><span class="type"><a href="qt3drender-qlayerfilter.html">QLayerFilter</a></span>(viewport);
  layerFilter<span class="operator">-</span><span class="operator">&gt;</span>addLayer(layer1);

  <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>

</pre>
</div>
<p><b>See also </b><a href="qt3drender-qlayerfilter.html">Qt3DRender::QLayerFilter</a>.</p>
<!-- @@@QLayer -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$recursive-prop$$$recursive$$$setRecursivebool$$$recursiveChanged -->
<h3 class="fn" id="recursive-prop"><a name="recursive-prop"></a><span class="name">recursive</span> : <span class="type">bool</span></h3>
<p>Specifies if the layer is also applied to the entity subtree.</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>recursive</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRecursive</b></span>(bool <i>recursive</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>recursiveChanged</b></span>()</td></tr>
</table></div>
<!-- @@@recursive -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLayer[overload1]$$$QLayerQt3DCore::QNode* -->
<h3 class="fn" id="QLayer"><a name="QLayer"></a>QLayer::<span class="name">QLayer</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new <a href="qt3drender-qlayer.html">QLayer</a> with the specified <i>parent</i>.</p>
<!-- @@@QLayer -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2018 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>