<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qadditiveclipblend.cpp --> <title>QAdditiveClipBlend 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 >QAdditiveClipBlend</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">QAdditiveClipBlend Class</h1> <span class="small-subtitle">(<a href="qt3danimation-qadditiveclipblend.html">Qt3DAnimation::QAdditiveClipBlend</a>)<br/></span> <!-- $$$QAdditiveClipBlend-brief --> <p>Performs an additive blend of two animation clips based on an additive factor. <a href="#details">More...</a></p> <!-- @@@QAdditiveClipBlend --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAdditiveClipBlend></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3danimation</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"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-animation-additiveclipblend.html">AdditiveClipBlend</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3danimation-qabstractclipblendnode.html">Qt3DAnimation::QAbstractClipBlendNode</a></td></tr></table></div><ul> <li><a href="qt3danimation-qadditiveclipblend-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="qt3danimation-qadditiveclipblend.html#additiveClip-prop">additiveClip</a></b> : Qt3DAnimation::QAbstractClipBlendNode *</li> <li class="fn"><b><a href="qt3danimation-qadditiveclipblend.html#additiveFactor-prop">additiveFactor</a></b> : float</li> <li class="fn"><b><a href="qt3danimation-qadditiveclipblend.html#baseClip-prop">baseClip</a></b> : Qt3DAnimation::QAbstractClipBlendNode *</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="qt3danimation-qadditiveclipblend.html#QAdditiveClipBlend">QAdditiveClipBlend</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qadditiveclipblend.html#dtor.QAdditiveClipBlend">~QAdditiveClipBlend</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt3DAnimation::QAbstractClipBlendNode *</td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qadditiveclipblend.html#additiveClip-prop">additiveClip</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qadditiveclipblend.html#additiveFactor-prop">additiveFactor</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt3DAnimation::QAbstractClipBlendNode *</td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qadditiveclipblend.html#baseClip-prop">baseClip</a></b>() const</td></tr> </table></div> <ul> <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="qt3danimation-qadditiveclipblend.html#additiveClip-prop">setAdditiveClip</a></b>(Qt3DAnimation::QAbstractClipBlendNode *<i>additiveClip</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qadditiveclipblend.html#additiveFactor-prop">setAdditiveFactor</a></b>(float <i>additiveFactor</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qadditiveclipblend.html#baseClip-prop">setBaseClip</a></b>(Qt3DAnimation::QAbstractClipBlendNode *<i>baseClip</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="qt3danimation-qadditiveclipblend.html#additiveClip-prop">additiveClipChanged</a></b>(Qt3DAnimation::QAbstractClipBlendNode *<i>additiveClip</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qadditiveclipblend.html#additiveFactor-prop">additiveFactorChanged</a></b>(float <i>additiveFactor</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qadditiveclipblend.html#baseClip-prop">baseClipChanged</a></b>(Qt3DAnimation::QAbstractClipBlendNode *<i>baseClip</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="qt3danimation-qadditiveclipblend.html#QAdditiveClipBlend-1">QAdditiveClipBlend</a></b>(QAdditiveClipBlendPrivate &<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> <!-- $$$QAdditiveClipBlend-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Performs an additive blend of two animation clips based on an additive factor.</p> <p><a href="qt3danimation-qadditiveclipblend.html">QAdditiveClipBlend</a> can be useful to create advanced animation effects based on individual animation clips. For example, if you:</p> <ul> <li>set the <a href="qt3danimation-qadditiveclipblend.html#baseClip-prop">baseClip</a> property to a normal walk cycle animation clip and</li> <li>set the <a href="qt3danimation-qadditiveclipblend.html#additiveClip-prop">additiveClip</a> property to a shaking head difference clip,</li> </ul> <p>then adjusting the <a href="qt3danimation-qadditiveclipblend.html#additiveFactor-prop">additiveFactor</a> property will control how much of the <a href="qt3danimation-qadditiveclipblend.html#additiveClip-prop">additiveClip</a> gets added on to the <a href="qt3danimation-qadditiveclipblend.html#baseClip-prop">baseClip</a>. This has he effect that with an <a href="qt3danimation-qadditiveclipblend.html#additiveFactor-prop">additiveFactor</a> of zero, this blend node will yield the original walk cycle clip. With an <a href="qt3danimation-qadditiveclipblend.html#additiveFactor-prop">additiveFactor</a> of 1, it will yield the walk cycle including a shaking head animation.</p> <p>The blending operation implemented by this class is:</p> <pre class="cpp plain"> resultClip = baseClip + additiveFactor * additiveClip </pre> <p>There is nothing stopping you from using values for the additiveFacor property outside the 0 to 1 range, but please be aware that the input animation clips may not be authored in such a way for this to make sense.</p> </div> <p><b>See also </b><a href="qt3danimation-qblendedclipanimator.html">QBlendedClipAnimator</a>.</p> <!-- @@@QAdditiveClipBlend --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$additiveClip-prop$$$additiveClip$$$setAdditiveClipQt3DAnimation::QAbstractClipBlendNode*$$$additiveClipChangedQt3DAnimation::QAbstractClipBlendNode* --> <h3 class="fn" id="additiveClip-prop"><a name="additiveClip-prop"></a><span class="name">additiveClip</span> : <span class="type">Qt3DAnimation::QAbstractClipBlendNode</span> *</h3> <p>This property holds the additive clip to be blended with the <a href="qt3danimation-qadditiveclipblend.html#baseClip-prop">baseClip</a>. The amount of blending is controlled by the <a href="qt3danimation-qadditiveclipblend.html#additiveFactor-prop">additiveFactor</a> property.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt3DAnimation::QAbstractClipBlendNode *</td><td class="memItemRight bottomAlign"><span class="name"><b>additiveClip</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAdditiveClip</b></span>(Qt3DAnimation::QAbstractClipBlendNode *<i>additiveClip</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>additiveClipChanged</b></span>(Qt3DAnimation::QAbstractClipBlendNode *<i>additiveClip</i>)</td></tr> </table></div> <!-- @@@additiveClip --> <!-- $$$additiveFactor-prop$$$additiveFactor$$$setAdditiveFactorfloat$$$additiveFactorChangedfloat --> <h3 class="fn" id="additiveFactor-prop"><a name="additiveFactor-prop"></a><span class="name">additiveFactor</span> : <span class="type">float</span></h3> <p>Specifies the blending factor, typically between 0 and 1, to control the blending of two animation clips.</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>additiveFactor</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAdditiveFactor</b></span>(float <i>additiveFactor</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>additiveFactorChanged</b></span>(float <i>additiveFactor</i>)</td></tr> </table></div> <!-- @@@additiveFactor --> <!-- $$$baseClip-prop$$$baseClip$$$setBaseClipQt3DAnimation::QAbstractClipBlendNode*$$$baseClipChangedQt3DAnimation::QAbstractClipBlendNode* --> <h3 class="fn" id="baseClip-prop"><a name="baseClip-prop"></a><span class="name">baseClip</span> : <span class="type">Qt3DAnimation::QAbstractClipBlendNode</span> *</h3> <p>This property holds the base animation clip. When the <a href="qt3danimation-qadditiveclipblend.html#additiveFactor-prop">additiveFactor</a> is zero the baseClip will also be the resulting clip of this blend node.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt3DAnimation::QAbstractClipBlendNode *</td><td class="memItemRight bottomAlign"><span class="name"><b>baseClip</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBaseClip</b></span>(Qt3DAnimation::QAbstractClipBlendNode *<i>baseClip</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>baseClipChanged</b></span>(Qt3DAnimation::QAbstractClipBlendNode *<i>baseClip</i>)</td></tr> </table></div> <!-- @@@baseClip --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QAdditiveClipBlend[overload1]$$$QAdditiveClipBlendQt3DCore::QNode* --> <h3 class="fn" id="QAdditiveClipBlend"><a name="QAdditiveClipBlend"></a>QAdditiveClipBlend::<span class="name">QAdditiveClipBlend</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QAdditiveClipBlend.</p><!-- @@@QAdditiveClipBlend --> <!-- $$$QAdditiveClipBlend$$$QAdditiveClipBlendQAdditiveClipBlendPrivate&Qt3DCore::QNode* --> <h3 class="fn" id="QAdditiveClipBlend-1"><a name="QAdditiveClipBlend-1"></a><code>[protected] </code>QAdditiveClipBlend::<span class="name">QAdditiveClipBlend</span>(<span class="type">QAdditiveClipBlendPrivate</span> &<i>dd</i>, <span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Copy constructor.</p><!-- @@@QAdditiveClipBlend --> <!-- $$$~QAdditiveClipBlend[overload1]$$$~QAdditiveClipBlend --> <h3 class="fn" id="dtor.QAdditiveClipBlend"><a name="dtor.QAdditiveClipBlend"></a>QAdditiveClipBlend::<span class="name">~QAdditiveClipBlend</span>()</h3> <p>Destroys the instance of QAdditiveClipBlend.</p><!-- @@@~QAdditiveClipBlend --> </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>