Sophie

Sophie

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

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" />
<!-- qlevelofdetail.cpp -->
  <title>LevelOfDetail QML Type | 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-qml.html">QML Types</a></td><td >LevelOfDetail QML Type</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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">LevelOfDetail QML Type</h1>
<span class="subtitle"></span>
<!-- $$$LevelOfDetail-brief -->
<p><a href="qml-qt3d-render-levelofdetail.html">LevelOfDetail</a> provides a way of controlling the complexity of rendered entities based on their size on the screen. <a href="#details">More...</a></p>
<!-- @@@LevelOfDetail -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt3D.Render 2.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.9</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-levelofdetail.html"><a href="qt3drender-qlevelofdetail.html">QLevelOfDetail</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt3d-core-component3d.html">Component3D</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qt3d-render-levelofdetail-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><b><a href="qml-qt3d-render-levelofdetail.html#ThresholdType-prop">ThresholdType</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qt3d-render-levelofdetail.html#camera-prop">camera</a></b></b> : Camera</li>
<li class="fn"><b><b><a href="qml-qt3d-render-levelofdetail.html#currentIndex-prop">currentIndex</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt3d-render-levelofdetail.html#thresholdType-propx">thresholdType</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt3d-render-levelofdetail.html#thresholds-prop">thresholds</a></b></b> : QVector&lt;qreal&gt;</li>
<li class="fn"><b><b><a href="qml-qt3d-render-levelofdetail.html#volumeOverride-prop">volumeOverride</a></b></b> : int</li>
</ul>
<!-- $$$LevelOfDetail-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qt3d-render-levelofdetail.html">LevelOfDetail</a> can be used to control the representation of an entity based on distance from the observer or size on the screen.</p>
<p>In order to improve rendering performance, objects that are very small can be rendered using far fewer details, in geometry or texture.</p>
<p>The component is controlled by specifying thresholds of values which are interpreted as either distances from the camera or screen size.</p>
<p>As the point of view changes, the <a href="qml-qt3d-render-levelofdetail.html#currentIndex-prop">currentIndex</a> property will change to reflect matching value in the range array.</p>
<p>The <a href="qml-qt3d-render-levelofdetail.html#currentIndex-prop">currentIndex</a> property can then be used, for example, to enable or disable entities, change source in an <a href="qml-qt3d-core-entityloader.html">EntityLoader</a>, or material.</p>
<p>The <a href="qml-qt3d-render-levelofdetail.html">LevelOfDetail</a> component is not shareable between multiple Entity's.</p>
<pre class="cpp">

  import Qt3D<span class="operator">.</span>Core <span class="number">2.0</span>
  import Qt3D<span class="operator">.</span>Render <span class="number">2.0</span>

  Entity {
      id: root

      <span class="comment">// Scene</span>
      Camera { id: mainCamera }

      LevelOfDetail {
          id: lod
          camera: mainCamera
          thresholds: <span class="operator">[</span><span class="number">20</span><span class="operator">,</span> <span class="number">35</span><span class="operator">,</span> <span class="number">50</span><span class="operator">,</span> <span class="number">65</span><span class="operator">]</span>
          thresholdType: LevelOfDetail<span class="operator">.</span>DistanceToCameraThreshold
      }

      CylinderMesh {
          id: mesh

          property var sliceValues: <span class="operator">[</span><span class="number">20</span><span class="operator">,</span> <span class="number">10</span><span class="operator">,</span> <span class="number">6</span><span class="operator">,</span> <span class="number">4</span><span class="operator">]</span>
          slices: sliceValues<span class="operator">[</span>lod<span class="operator">.</span>currentIndex<span class="operator">]</span>
      }

      Entity {
          id: renderableEntity
          components: <span class="operator">[</span> mesh<span class="operator">,</span> lod <span class="operator">]</span>
      }
  }

</pre>
<!-- @@@LevelOfDetail -->
<h2>Property Documentation</h2>
<!-- $$$ThresholdType -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="ThresholdType-prop">
<td class="tblQmlPropNode"><p>
<a name="ThresholdType-prop"></a><span class="name">ThresholdType</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Specifies how the values in the thresholds are interpreted</p>
<ul>
<li>DistanceToCameraThreshold Distance from the entity to the selected camera</li>
<li>ProjectedScreenPixelSizeThreshold Size of the entity when projected on the screen as seen from the selected camera, expressed in number of pixels on the side of the bounding square in screen space.</li>
</ul>
<p><b>See also </b><a href="qt3drender-qlevelofdetail.html#ThresholdType-enum">Qt3DRender::QLevelOfDetail::ThresholdType</a>.</p>
</div></div><!-- @@@ThresholdType -->
<br/>
<!-- $$$camera -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="camera-prop">
<td class="tblQmlPropNode"><p>
<a name="camera-prop"></a><span class="name">camera</span> : <span class="type"><a href="qml-qt3d-render-camera.html">Camera</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the id of the camera that is used to compute the actual distance or the screen size.</p>
</div></div><!-- @@@camera -->
<br/>
<!-- $$$currentIndex -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="currentIndex-prop">
<td class="tblQmlPropNode"><p>
<a name="currentIndex-prop"></a><span class="name">currentIndex</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The index in the range array which matches the current distance to the camera or screen size.</p>
</div></div><!-- @@@currentIndex -->
<br/>
<!-- $$$thresholdType -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="thresholdType-propx">
<td class="tblQmlPropNode"><p>
<a name="thresholdType-propx"></a><span class="name">thresholdType</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Specifies how range values are interpreted.</p>
</div></div><!-- @@@thresholdType -->
<br/>
<!-- $$$thresholds -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="thresholds-prop">
<td class="tblQmlPropNode"><p>
<a name="thresholds-prop"></a><span class="name">thresholds</span> : <span class="type">QVector</span>&lt;<span class="type">qreal</span>&gt;</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Array of range values as float point numbers. The value for the most detailed representation should be specified first.</p>
<p>If <a href="qml-qt3d-render-levelofdetail.html#thresholdType-propx">LevelOfDetail::thresholdType</a> is set to <a href="qml-qt3d-render-levelofdetail.html">LevelOfDetail</a>.DistanceToCameraThreshold, values should be specified in ascending order, in camera space coordinates</p>
<p>If <a href="qml-qt3d-render-levelofdetail.html#thresholdType-propx">LevelOfDetail::thresholdType</a> is set to <a href="qml-qt3d-render-levelofdetail.html">LevelOfDetail</a>.ProjectedScreenPixelSizeThreshold, values should be specified in descending order, in screen space pixels.</p>
</div></div><!-- @@@thresholds -->
<br/>
<!-- $$$volumeOverride -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="volumeOverride-prop">
<td class="tblQmlPropNode"><p>
<a name="volumeOverride-prop"></a><span class="name">volumeOverride</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Specifies what is used to evaluate the distance or screen size.</p>
<p>The default is a sphere of radius 1 and centered at the local origin of the entity. This proxy volume is used to compute the distance to the camera or the size of the screen projection.</p>
<p>If this value to null, the bounding volume of the entity is used. Care must be taken that this bounding volume never becomes invalid.</p>
<p><b>See also </b><a href="qt3drender-qlevelofdetailboundingsphere.html">Qt3DRender::QLevelOfDetailBoundingSphere</a>.</p>
</div></div><!-- @@@volumeOverride -->
<br/>
        </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>