<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qsortpolicy.cpp --> <title>QSortPolicy Class | Qt 3D 5.9</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.9</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QSortPolicy</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 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="#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="#public-slots">Public Slots</a></li> <li class="level1"><a href="#signals">Signals</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">QSortPolicy Class</h1> <span class="small-subtitle">(<a href="qt3drender-qsortpolicy.html">Qt3DRender::QSortPolicy</a>)<br/></span> <!-- $$$QSortPolicy-brief --> <p>Provides storage for the sort types to be used <a href="#details">More...</a></p> <!-- @@@QSortPolicy --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QSortPolicy></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.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-sortpolicy.html">SortPolicy</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-qsortpolicy-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-qsortpolicy.html#SortType-enum">SortType</a></b> { StateChangeCost, BackToFront, Material, FrontToBack }</td></tr> </table></div> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><a href="qt3drender-qsortpolicy.html#sortTypes-prop">sortTypes</a></b> : QVector<int></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-qsortpolicy.html#QSortPolicy">QSortPolicy</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVector<SortType> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qsortpolicy.html#sortTypes">sortTypes</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVector<int> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qsortpolicy.html#sortTypes-prop">sortTypesInt</a></b>() const</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">11 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-qsortpolicy.html#sortTypes-prop">setSortTypes</a></b>(const QVector<SortType> &<i>sortTypes</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qsortpolicy.html#sortTypes-prop">setSortTypes</a></b>(const QVector<int> &<i>sortTypesInt</i>)</td></tr> </table></div> <ul> <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-qsortpolicy.html#sortTypes-prop">sortTypesChanged</a></b>(const QVector<SortType> &<i>sortTypes</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qsortpolicy.html#sortTypes-prop">sortTypesChanged</a></b>(const QVector<int> &<i>sortTypes</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="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-qsortpolicy.html#QSortPolicy-1">QSortPolicy</a></b>(QSortPolicyPrivate &<i>dd</i>, Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> </table></div> <ul> <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> <!-- $$$QSortPolicy-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Provides storage for the sort types to be used</p> <p>A <a href="qt3drender-qsortpolicy.html">Qt3DRender::QSortPolicy</a> class stores the sorting type used by the FrameGraph. The sort types determine how drawable entities are sorted before drawing to determine the drawing order. When <a href="qt3drender-qsortpolicy.html">QSortPolicy</a> is present in the FrameGraph, the sorting mechanism is determined by the SortTypes list. Multiple sort types can be used simultaneously. If <a href="qt3drender-qsortpolicy.html">QSortPolicy</a> is not present in the FrameGraph, entities are drawn in the order they appear in the entity hierarchy.</p> </div> <!-- @@@QSortPolicy --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$SortType$$$StateChangeCost$$$BackToFront$$$Material --> <h3 class="fn" id="SortType-enum"><a name="SortType-enum"></a>enum QSortPolicy::<span class="name">SortType</span></h3> <p>This enum type describes the available sort types.</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::QSortPolicy::StateChangeCost</code></td><td class="topAlign tblval"><code>( 1<<0 )</code></td><td class="topAlign">sort the objects so as to minimize the cost of changing from the currently rendered state</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QSortPolicy::BackToFront</code></td><td class="topAlign tblval"><code>( 1<<1 )</code></td><td class="topAlign">sort the objects from back to front based on inverted z order. More accurately, the sorting key is the z component of the projection of the camera-to-object-center vector onto the camera's view vector.</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QSortPolicy::Material</code></td><td class="topAlign tblval"><code>( 1<<2 )</code></td><td class="topAlign">sort the objects based on their material value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QSortPolicy::FrontToBack</code></td><td class="topAlign tblval">?</td><td class="topAlign">sort the objects from front to back. The opposite of BackToFront.</td></tr> </table></div> <!-- @@@SortType --> </div> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$sortTypes-prop$$$sortTypesInt$$$setSortTypesconstQVector<SortType>&$$$setSortTypesconstQVector<int>&$$$sortTypesChangedconstQVector<SortType>&$$$sortTypesChangedconstQVector<int>& --> <h3 class="fn" id="sortTypes-prop"><a name="sortTypes-prop"></a><span class="name">sortTypes</span> : <span class="type">QVector</span><<span class="type">int</span>></h3> <p>Specifies the sorting types to be used.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QVector<int> </td><td class="memItemRight bottomAlign"><span class="name"><b>sortTypesInt</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSortTypes</b></span>(const QVector<SortType> &<i>sortTypes</i>)</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSortTypes</b></span>(const QVector<int> &<i>sortTypesInt</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>sortTypesChanged</b></span>(const QVector<SortType> &<i>sortTypes</i>)</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>sortTypesChanged</b></span>(const QVector<int> &<i>sortTypes</i>)</td></tr> </table></div> <!-- @@@sortTypes --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QSortPolicy[overload1]$$$QSortPolicyQt3DCore::QNode* --> <h3 class="fn" id="QSortPolicy"><a name="QSortPolicy"></a>QSortPolicy::<span class="name">QSortPolicy</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QSortPolicy.</p><!-- @@@QSortPolicy --> <!-- $$$QSortPolicy$$$QSortPolicyQSortPolicyPrivate&Qt3DCore::QNode* --> <h3 class="fn" id="QSortPolicy-1"><a name="QSortPolicy-1"></a><code>[protected] </code>QSortPolicy::<span class="name">QSortPolicy</span>(<span class="type">QSortPolicyPrivate</span> &<i>dd</i>, <span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Copy constructor.</p><!-- @@@QSortPolicy --> <!-- $$$sortTypes[overload1]$$$sortTypes --> <h3 class="fn" id="sortTypes"><a name="sortTypes"></a><span class="type">QVector</span><<span class="type"><a href="qt3drender-qsortpolicy.html#SortType-enum">SortType</a></span>> QSortPolicy::<span class="name">sortTypes</span>() const</h3> <p>Returns the current sort types in use</p> <p><b>See also </b><a href="qt3drender-qsortpolicy.html#sortTypes-prop">setSortTypes</a>().</p> <!-- @@@sortTypes --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2017 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>