<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qspotlight.cpp --> <title>SpotLight QML Type | Qt 3D 5.12.6</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 >SpotLight QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.6 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">SpotLight QML Type</h1> <span class="subtitle"></span> <!-- $$$SpotLight-brief --> <p>Encapsulate a Spot Light object in a Qt 3D scene. <a href="#details">More...</a></p> <!-- @@@SpotLight --> <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.5</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-spotlight.html"><a href="qt3drender-qspotlight.html">QSpotLight</a></td></tr></table></div><ul> <li><a href="qml-qt3d-render-spotlight-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-spotlight.html#constantAttenuation-prop">constantAttenuation</a></b></b> : float</li> <li class="fn"><b><b><a href="qml-qt3d-render-spotlight.html#cutOffAngle-prop">cutOffAngle</a></b></b> : float</li> <li class="fn"><b><b><a href="qml-qt3d-render-spotlight.html#linearAttenuation-prop">linearAttenuation</a></b></b> : float</li> <li class="fn"><b><b><a href="qml-qt3d-render-spotlight.html#localDirection-prop">localDirection</a></b></b> : vector3d</li> <li class="fn"><b><b><a href="qml-qt3d-render-spotlight.html#quadraticAttenuation-prop">quadraticAttenuation</a></b></b> : float</li> </ul> <!-- $$$SpotLight-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>A spotlight is a light source that emits a cone of light in a particular direction.</p> <p>A spotlight uses three attenuation factors to describe how the intensity of the light decreases over distance. These factors are designed to be used together in calcuating total attenuation. For the materials in Qt3D Extras the following formula is used, where distance is the distance from the light to the surface being rendered:</p> <pre class="cpp"> totalAttenuation <span class="operator">=</span> <span class="number">1.0</span> <span class="operator">/</span> (constantAttenuation <span class="operator">+</span> (linearAttenuation <span class="operator">*</span> distance) <span class="operator">+</span> (quadraticAttenuation <span class="operator">*</span> distance <span class="operator">*</span> distance)); </pre> <p>Custom materials may choose to interpret these factors differently.</p> <!-- @@@SpotLight --> <h2>Property Documentation</h2> <!-- $$$constantAttenuation --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="constantAttenuation-prop"> <td class="tblQmlPropNode"><p> <a name="constantAttenuation-prop"></a><span class="name">constantAttenuation</span> : <span class="type">float</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Specifies the constant attenuation of the spot light</p> </div></div><!-- @@@constantAttenuation --> <br/> <!-- $$$cutOffAngle --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="cutOffAngle-prop"> <td class="tblQmlPropNode"><p> <a name="cutOffAngle-prop"></a><span class="name">cutOffAngle</span> : <span class="type">float</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Specifies the cut off angle of the spot light</p> </div></div><!-- @@@cutOffAngle --> <br/> <!-- $$$linearAttenuation --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="linearAttenuation-prop"> <td class="tblQmlPropNode"><p> <a name="linearAttenuation-prop"></a><span class="name">linearAttenuation</span> : <span class="type">float</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Specifies the linear attenuation of the spot light</p> </div></div><!-- @@@linearAttenuation --> <br/> <!-- $$$localDirection --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="localDirection-prop"> <td class="tblQmlPropNode"><p> <a name="localDirection-prop"></a><span class="name">localDirection</span> : <span class="type">vector3d</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Specifies the local direction of the spot light</p> </div></div><!-- @@@localDirection --> <br/> <!-- $$$quadraticAttenuation --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="quadraticAttenuation-prop"> <td class="tblQmlPropNode"><p> <a name="quadraticAttenuation-prop"></a><span class="name">quadraticAttenuation</span> : <span class="type">float</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Specifies the quadratic attenuation of the spot light</p> </div></div><!-- @@@quadraticAttenuation --> <br/> </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>