<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qmaterial.cpp --> <title>QMaterial 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 >QMaterial</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="#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">QMaterial Class</h1> <span class="small-subtitle">(<a href="qt3drender-qmaterial.html">Qt3DRender::QMaterial</a>)<br/></span> <!-- $$$QMaterial-brief --> <p>Provides an abstract class that should be the base of all material component classes in a scene. <a href="#details">More...</a></p> <!-- @@@QMaterial --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QMaterial></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-material.html">Material</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><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qt3dextras-qdiffusemapmaterial.html">Qt3DExtras::QDiffuseMapMaterial</a>, <a href="qt3dextras-qdiffusespecularmapmaterial.html">Qt3DExtras::QDiffuseSpecularMapMaterial</a>, <a href="qt3dextras-qgoochmaterial.html">Qt3DExtras::QGoochMaterial</a>, <a href="qt3dextras-qmetalroughmaterial.html">Qt3DExtras::QMetalRoughMaterial</a>, <a href="qt3dextras-qmorphphongmaterial.html">Qt3DExtras::QMorphPhongMaterial</a>, <a href="qt3dextras-qnormaldiffusemapmaterial.html">Qt3DExtras::QNormalDiffuseMapMaterial</a>, <a href="qt3dextras-qnormaldiffusespecularmapmaterial.html">Qt3DExtras::QNormalDiffuseSpecularMapMaterial</a>, <a href="qt3dextras-qpervertexcolormaterial.html">Qt3DExtras::QPerVertexColorMaterial</a>, <a href="qt3dextras-qphongalphamaterial.html">Qt3DExtras::QPhongAlphaMaterial</a>, <a href="qt3dextras-qphongmaterial.html">Qt3DExtras::QPhongMaterial</a>, <a href="qt3dextras-qtexturedmetalroughmaterial.html">Qt3DExtras::QTexturedMetalRoughMaterial</a>, and <a href="qt3dextras-qtexturematerial.html">Qt3DExtras::QTextureMaterial</a></p> </td></tr></table></div><ul> <li><a href="qt3drender-qmaterial-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-qmaterial.html#effect-prop">effect</a></b> : Qt3DRender::QEffect *</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> </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-qmaterial.html#QMaterial">QMaterial</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qmaterial.html#dtor.QMaterial">~QMaterial</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qmaterial.html#addParameter">addParameter</a></b>(QParameter *<i>parameter</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QEffect *</td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qmaterial.html#effect-prop">effect</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVector<QParameter *> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qmaterial.html#parameters">parameters</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qmaterial.html#removeParameter">removeParameter</a></b>(QParameter *<i>parameter</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">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-qmaterial.html#effect-prop">setEffect</a></b>(QEffect *<i>effect</i>)</td></tr> </table></div> <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> </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-qmaterial.html#effect-prop">effectChanged</a></b>(QEffect *<i>effect</i>)</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> </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-qmaterial.html#QMaterial-1">QMaterial</a></b>(QMaterialPrivate &<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> <!-- $$$QMaterial-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Provides an abstract class that should be the base of all material component classes in a scene.</p> <p><a href="qt3drender-qmaterial.html">QMaterial</a> provides a way to specify the rendering of an <a href="qt3dcore-qentity.html">entity</a>. Any aspect can define its own subclass of <a href="qt3drender-qmaterial.html">QMaterial</a> so that a Material can be used to describe a visual element; for example, the way sound should reflect off an element, the temperature of a surface, and so on.</p> <p>In itself, a <a href="qt3drender-qmaterial.html">QMaterial</a> doesn't do anything. It's only when it references a <a href="qt3drender-qeffect.html">QEffect</a> node that a <a href="qt3drender-qmaterial.html">QMaterial</a> becomes useful.</p> <p>In practice, it often happens that a single <a href="qt3drender-qeffect.html">QEffect</a> is being referenced by several <a href="qt3drender-qmaterial.html">QMaterial</a> components. This allows to only create the effect, techniques, passes and shaders once while allowing to specify the material by adding <a href="qt3drender-qparameter.html">QParameter</a> instances.</p> <p>A <a href="qt3drender-qparameter.html">QParameter</a> defined on a <a href="qt3drender-qmaterial.html">QMaterial</a> is overridden by a <a href="qt3drender-qparameter.html">QParameter</a> (of the same name) defined in a <a href="qt3drender-qtechniquefilter.html">QTechniqueFilter</a> or a <a href="qt3drender-qrenderpassfilter.html">QRenderPassFilter</a>.</p> <pre class="cpp"> <span class="type"><a href="qt3drender-qmaterial.html#QMaterial">QMaterial</a></span> <span class="operator">*</span>material1 <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qmaterial.html#QMaterial">QMaterial</a></span>(); <span class="type"><a href="qt3drender-qmaterial.html#QMaterial">QMaterial</a></span> <span class="operator">*</span>material2 <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qmaterial.html#QMaterial">QMaterial</a></span>(); <span class="comment">// Create effect, technique, render pass and shader</span> <span class="type"><a href="qt3drender-qeffect.html">QEffect</a></span> <span class="operator">*</span>effect <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qeffect.html">QEffect</a></span>(); <span class="type"><a href="qt3drender-qtechnique.html">QTechnique</a></span> <span class="operator">*</span>gl3Technique <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qtechnique.html">QTechnique</a></span>(); <span class="type"><a href="qt3drender-qrenderpass.html">QRenderPass</a></span> <span class="operator">*</span>gl3Pass <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qrenderpass.html">QRenderPass</a></span>(); <span class="type"><a href="qt3drender-qshaderprogram.html">QShaderProgram</a></span> <span class="operator">*</span>glShader <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qshaderprogram.html">QShaderProgram</a></span>(); <span class="comment">// Set the shader on the render pass</span> gl3Pass<span class="operator">-</span><span class="operator">></span>setShaderProgram(glShader); <span class="comment">// Add the pass to the technique</span> gl3Technique<span class="operator">-</span><span class="operator">></span>addRenderPass(gl3Pass); <span class="comment">// Set the targeted GL version for the technique</span> gl3Technique<span class="operator">-</span><span class="operator">></span>graphicsApiFilter()<span class="operator">-</span><span class="operator">></span>setApi(<span class="type"><a href="qt3drender-qgraphicsapifilter.html">QGraphicsApiFilter</a></span><span class="operator">::</span>OpenGL); gl3Technique<span class="operator">-</span><span class="operator">></span>graphicsApiFilter()<span class="operator">-</span><span class="operator">></span>setMajorVersion(<span class="number">3</span>); gl3Technique<span class="operator">-</span><span class="operator">></span>graphicsApiFilter()<span class="operator">-</span><span class="operator">></span>setMinorVersion(<span class="number">1</span>); gl3Technique<span class="operator">-</span><span class="operator">></span>graphicsApiFilter()<span class="operator">-</span><span class="operator">></span>setProfile(<span class="type"><a href="qt3drender-qgraphicsapifilter.html">QGraphicsApiFilter</a></span><span class="operator">::</span>CoreProfile); <span class="comment">// Add the technique to the effect</span> effect<span class="operator">-</span><span class="operator">></span>addTechnique(gl3Technique); <span class="comment">// Set the effect on the materials</span> material1<span class="operator">-</span><span class="operator">></span>setEffect(effect); material2<span class="operator">-</span><span class="operator">></span>setEffect(effect); <span class="comment">// Set different parameters on the materials</span> <span class="keyword">const</span> <span class="type">QString</span> parameterName <span class="operator">=</span> <span class="type">QStringLiteral</span>(<span class="string">"color"</span>); material1<span class="operator">-</span><span class="operator">></span>addParameter(<span class="keyword">new</span> <span class="type"><a href="qt3drender-qparameter.html">QParameter</a></span>(parameterName<span class="operator">,</span> <span class="type">QColor</span><span class="operator">::</span>fromRgbF(<span class="number">0.0f</span><span class="operator">,</span> <span class="number">1.0f</span><span class="operator">,</span> <span class="number">0.0f</span><span class="operator">,</span> <span class="number">1.0f</span>); material2<span class="operator">-</span><span class="operator">></span>addParameter(<span class="keyword">new</span> <span class="type"><a href="qt3drender-qparameter.html">QParameter</a></span>(parameterName<span class="operator">,</span> <span class="type">QColor</span><span class="operator">::</span>fromRgbF(<span class="number">1.0f</span><span class="operator">,</span> <span class="number">1.0f</span><span class="operator">,</span> <span class="number">1.0f</span><span class="operator">,</span> <span class="number">1.0f</span>); </pre> </div> <p><b>See also </b><a href="qt3drender-qeffect.html">QEffect</a>, <a href="qt3drender-qtechnique.html">QTechnique</a>, and <a href="qt3drender-qparameter.html">QParameter</a>.</p> <!-- @@@QMaterial --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$effect-prop$$$effect$$$setEffectQEffect*$$$effectChangedQEffect* --> <h3 class="fn" id="effect-prop"><a name="effect-prop"></a><span class="name">effect</span> : <span class="type">Qt3DRender::QEffect</span> *</h3> <p>Specifies the effect to be used with the material.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QEffect *</td><td class="memItemRight bottomAlign"><span class="name"><b>effect</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setEffect</b></span>(QEffect *<i>effect</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>effectChanged</b></span>(QEffect *<i>effect</i>)</td></tr> </table></div> <!-- @@@effect --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QMaterial[overload1]$$$QMaterialQt3DCore::QNode* --> <h3 class="fn" id="QMaterial"><a name="QMaterial"></a>QMaterial::<span class="name">QMaterial</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QMaterial.</p><!-- @@@QMaterial --> <!-- $$$QMaterial$$$QMaterialQMaterialPrivate&Qt3DCore::QNode* --> <h3 class="fn" id="QMaterial-1"><a name="QMaterial-1"></a><code>[protected] </code>QMaterial::<span class="name">QMaterial</span>(<span class="type">QMaterialPrivate</span> &<i>dd</i>, <span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Copy constructor.</p><!-- @@@QMaterial --> <!-- $$$~QMaterial[overload1]$$$~QMaterial --> <h3 class="fn" id="dtor.QMaterial"><a name="dtor.QMaterial"></a>QMaterial::<span class="name">~QMaterial</span>()</h3> <p>Destroys the instance of QMaterial.</p><!-- @@@~QMaterial --> <!-- $$$addParameter[overload1]$$$addParameterQParameter* --> <h3 class="fn" id="addParameter"><a name="addParameter"></a><span class="type">void</span> QMaterial::<span class="name">addParameter</span>(<span class="type"><a href="qt3drender-qparameter.html">QParameter</a></span> *<i>parameter</i>)</h3> <p>Add a <i>parameter</i> to the material's parameters.</p> <!-- @@@addParameter --> <!-- $$$parameters[overload1]$$$parameters --> <h3 class="fn" id="parameters"><a name="parameters"></a><span class="type">QVector</span><<span class="type"><a href="qt3drender-qparameter.html">QParameter</a></span> *> QMaterial::<span class="name">parameters</span>() const</h3> <p>Returns a vector of the material's current parameters</p> <!-- @@@parameters --> <!-- $$$removeParameter[overload1]$$$removeParameterQParameter* --> <h3 class="fn" id="removeParameter"><a name="removeParameter"></a><span class="type">void</span> QMaterial::<span class="name">removeParameter</span>(<span class="type"><a href="qt3drender-qparameter.html">QParameter</a></span> *<i>parameter</i>)</h3> <p>Remove a <i>parameter</i> from the material's parameters.</p> <!-- @@@removeParameter --> </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>