<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qraycaster.cpp --> <title>QRayCaster Class | 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-cpp.html">C++ Classes</a></td><td >QRayCaster</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="#public-functions">Public Functions</a></li> <li class="level1"><a href="#public-slots">Public Slots</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="#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">QRayCaster Class</h1> <span class="small-subtitle">(<a href="qt3drender-qraycaster.html">Qt3DRender::QRayCaster</a>)<br/></span> <!-- $$$QRayCaster-brief --> <p><a href="qt3drender-qraycaster.html">Qt3DRender::QRayCaster</a> is used to perform ray casting tests in 3d world coordinates. <a href="#details">More...</a></p> <!-- @@@QRayCaster --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QRayCaster></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.11</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-raycaster.html">RayCaster</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3drender-qabstractraycaster.html">Qt3DRender::QAbstractRayCaster</a></td></tr></table></div><ul> <li><a href="qt3drender-qraycaster-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-qraycaster.html#direction-prop">direction</a></b> : QVector3D</li> <li class="fn"><b><a href="qt3drender-qraycaster.html#length-prop">length</a></b> : float</li> <li class="fn"><b><a href="qt3drender-qraycaster.html#origin-prop">origin</a></b> : QVector3D</li> </ul> <ul> <li class="fn">3 properties inherited from <a href="qt3drender-qabstractraycaster.html#properties">Qt3DRender::QAbstractRayCaster</a></li> <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> </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-qraycaster.html#QRayCaster">QRayCaster</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVector3D </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#direction-prop">direction</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#length-prop">length</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVector3D </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#origin-prop">origin</a></b>() const</td></tr> </table></div> <ul> <li class="fn">6 public functions inherited from <a href="qt3drender-qabstractraycaster.html#public-functions">Qt3DRender::QAbstractRayCaster</a></li> <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> </ul> <a name="public-slots"></a> <h2 id="public-slots">Public Slots</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#direction-prop">setDirection</a></b>(const QVector3D &<i>direction</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#setLength">setLength</a></b>(float <i>length</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#origin-prop">setOrigin</a></b>(const QVector3D &<i>origin</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#trigger">trigger</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#trigger-1">trigger</a></b>(const QVector3D &<i>origin</i>, const QVector3D &<i>direction</i>, float <i>length</i>)</td></tr> </table></div> <ul> <li class="fn">2 public slots inherited from <a href="qt3drender-qabstractraycaster.html#public-slots">Qt3DRender::QAbstractRayCaster</a></li> <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> </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-qraycaster.html#direction-prop">directionChanged</a></b>(const QVector3D &<i>direction</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#length-prop">lengthChanged</a></b>(float <i>length</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qraycaster.html#origin-prop">originChanged</a></b>(const QVector3D &<i>origin</i>)</td></tr> </table></div> <ul> <li class="fn">3 signals inherited from <a href="qt3drender-qabstractraycaster.html#signals">Qt3DRender::QAbstractRayCaster</a></li> <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> </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-qraycaster.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <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-qraycaster.html#QRayCaster-1">QRayCaster</a></b>(Qt3DRender::QAbstractRayCasterPrivate &<i>dd</i>, Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> </table></div> <ul> <li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li> </ul> <a name="details"></a> <!-- $$$QRayCaster-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p><a href="qt3drender-qraycaster.html">Qt3DRender::QRayCaster</a> is used to perform ray casting tests in 3d world coordinates.</p> <p>The 3d ray is defined by its origin, direction and length. It will be affected by the transformations applied to the entity it belongs to.</p> <p>Ray casting tests will be performed every frame as long as the component is enabled. The hits property will be updated with the list of intersections.</p> </div> <p><b>See also </b><a href="qt3drender-qabstractraycaster.html">QAbstractRayCaster</a> and <a href="qt3drender-qscreenraycaster.html">QScreenRayCaster</a>.</p> <!-- @@@QRayCaster --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$direction-prop$$$direction$$$setDirectionconstQVector3D&$$$directionChangedconstQVector3D& --> <h3 class="fn" id="direction-prop"><a name="direction-prop"></a><span class="name">direction</span> : <span class="type">QVector3D</span></h3> <p>Holds the direction of the 3D ray. This should be a unit vector.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QVector3D </td><td class="memItemRight bottomAlign"><span class="name"><b>direction</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setDirection</b></span>(const QVector3D &<i>direction</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>directionChanged</b></span>(const QVector3D &<i>direction</i>)</td></tr> </table></div> <!-- @@@direction --> <!-- $$$length-prop$$$length$$$setLengthfloat$$$lengthChangedfloat --> <h3 class="fn" id="length-prop"><a name="length-prop"></a><span class="name">length</span> : <span class="type">float</span></h3> <p>Holds the length of the 3D ray.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> float </td><td class="memItemRight bottomAlign"><span class="name"><b>length</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qraycaster.html#setLength">setLength</a></b></span>(float <i>length</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>lengthChanged</b></span>(float <i>length</i>)</td></tr> </table></div> <!-- @@@length --> <!-- $$$origin-prop$$$origin$$$setOriginconstQVector3D&$$$originChangedconstQVector3D& --> <h3 class="fn" id="origin-prop"><a name="origin-prop"></a><span class="name">origin</span> : <span class="type">QVector3D</span></h3> <p>Holds the origin of the 3D ray in local coordinates.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QVector3D </td><td class="memItemRight bottomAlign"><span class="name"><b>origin</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setOrigin</b></span>(const QVector3D &<i>origin</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>originChanged</b></span>(const QVector3D &<i>origin</i>)</td></tr> </table></div> <!-- @@@origin --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QRayCaster[overload1]$$$QRayCasterQt3DCore::QNode* --> <h3 class="fn" id="QRayCaster"><a name="QRayCaster"></a>QRayCaster::<span class="name">QRayCaster</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QRayCaster.</p><!-- @@@QRayCaster --> <!-- $$$QRayCaster$$$QRayCasterQt3DRender::QAbstractRayCasterPrivate&Qt3DCore::QNode* --> <h3 class="fn" id="QRayCaster-1"><a name="QRayCaster-1"></a><code>[protected] </code>QRayCaster::<span class="name">QRayCaster</span>(<span class="type">Qt3DRender::QAbstractRayCasterPrivate</span> &<i>dd</i>, <span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QRayCaster.</p><!-- @@@QRayCaster --> <!-- $$$setLength --> <h3 class="fn" id="setLength"><a name="setLength"></a><code>[slot] </code><span class="type">void</span> QRayCaster::<span class="name">setLength</span>(<span class="type">float</span> <i>length</i>)</h3> <p>Sets the length of the ray to <i>length</i>.</p> <p>If the value is less than or equal to zero, the ray is concidered to be infinite.</p> <p><b>Note:</b> Setter function for property <a href="qt3drender-qraycaster.html#length-prop">length</a>. </p><p><b>See also </b><a href="qt3drender-qraycaster.html#length-prop">length</a>().</p> <!-- @@@setLength --> <!-- $$$trigger[overload1]$$$trigger --> <h3 class="fn" id="trigger"><a name="trigger"></a><code>[slot] </code><span class="type">void</span> QRayCaster::<span class="name">trigger</span>()</h3> <p>Convenience method to enable the component and trigger tests using the current ray.</p> <!-- @@@trigger --> <!-- $$$trigger$$$triggerconstQVector3D&constQVector3D&float --> <h3 class="fn" id="trigger-1"><a name="trigger-1"></a><code>[slot] </code><span class="type">void</span> QRayCaster::<span class="name">trigger</span>(const <span class="type">QVector3D</span> &<i>origin</i>, const <span class="type">QVector3D</span> &<i>direction</i>, <span class="type">float</span> <i>length</i>)</h3> <p>Convenience method to set the ray details <i>origin</i>, <i>direction</i>, and <i>length</i>, and enable the component to trigger tests.</p> <!-- @@@trigger --> </div> </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>