<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qcallbackmapping.cpp --> <title>QCallbackMapping 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 >QCallbackMapping</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">QCallbackMapping Class</h1> <span class="small-subtitle">(<a href="qt3danimation-qcallbackmapping.html">Qt3DAnimation::QCallbackMapping</a>)<br/></span> <!-- $$$QCallbackMapping-brief --> <p>Allows to map the channels within the clip onto an invocation of a callback object. <a href="#details">More...</a></p> <!-- @@@QCallbackMapping --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCallbackMapping></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"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3danimation-qabstractchannelmapping.html">Qt3DAnimation::QAbstractChannelMapping</a></td></tr></table></div><ul> <li><a href="qt3danimation-qcallbackmapping-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-qcallbackmapping.html#channelName-prop">channelName</a></b> : QString</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-qcallbackmapping.html#QCallbackMapping">QCallbackMapping</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qcallbackmapping.html#dtor.QCallbackMapping">~QCallbackMapping</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt3DAnimation::QAnimationCallback *</td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qcallbackmapping.html#callback">callback</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qcallbackmapping.html#channelName-prop">channelName</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qcallbackmapping.html#setCallback">setCallback</a></b>(int <i>type</i>, Qt3DAnimation::QAnimationCallback *<i>callback</i>, QAnimationCallback::Flags <i>flags</i>)</td></tr> </table></div> <ul> <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="qt3danimation-qcallbackmapping.html#channelName-prop">setChannelName</a></b>(const QString &<i>channelName</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-qcallbackmapping.html#channelName-prop">channelNameChanged</a></b>(QString <i>channelName</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="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="qt3danimation-qcallbackmapping.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="qt3danimation-qcallbackmapping.html#QCallbackMapping-1">QCallbackMapping</a></b>(Qt3DAnimation::QCallbackMappingPrivate &<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> <!-- $$$QCallbackMapping-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Allows to map the channels within the clip onto an invocation of a callback object.</p> </div> <!-- @@@QCallbackMapping --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$channelName-prop$$$channelName$$$setChannelNameconstQString&$$$channelNameChangedQString --> <h3 class="fn" id="channelName-prop"><a name="channelName-prop"></a><span class="name">channelName</span> : <span class="type">QString</span></h3> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>channelName</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setChannelName</b></span>(const QString &<i>channelName</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>channelNameChanged</b></span>(QString <i>channelName</i>)</td></tr> </table></div> <!-- @@@channelName --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QCallbackMapping[overload1]$$$QCallbackMappingQt3DCore::QNode* --> <h3 class="fn" id="QCallbackMapping"><a name="QCallbackMapping"></a>QCallbackMapping::<span class="name">QCallbackMapping</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QCallbackMapping.</p><!-- @@@QCallbackMapping --> <!-- $$$QCallbackMapping$$$QCallbackMappingQt3DAnimation::QCallbackMappingPrivate&Qt3DCore::QNode* --> <h3 class="fn" id="QCallbackMapping-1"><a name="QCallbackMapping-1"></a><code>[protected] </code>QCallbackMapping::<span class="name">QCallbackMapping</span>(<span class="type">Qt3DAnimation::QCallbackMappingPrivate</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 QCallbackMapping.</p><!-- @@@QCallbackMapping --> <!-- $$$~QCallbackMapping[overload1]$$$~QCallbackMapping --> <h3 class="fn" id="dtor.QCallbackMapping"><a name="dtor.QCallbackMapping"></a><code>[virtual] </code>QCallbackMapping::<span class="name">~QCallbackMapping</span>()</h3> <p>Destroys the instance of QCallbackMapping. The destructor is virtual.</p><!-- @@@~QCallbackMapping --> <!-- $$$callback[overload1]$$$callback --> <h3 class="fn" id="callback"><a name="callback"></a><span class="type"><a href="qt3danimation-qanimationcallback.html">Qt3DAnimation::QAnimationCallback</a></span> *QCallbackMapping::<span class="name">callback</span>() const</h3> <p><b>See also </b><a href="qt3danimation-qcallbackmapping.html#setCallback">setCallback</a>().</p> <!-- @@@callback --> <!-- $$$setCallback[overload1]$$$setCallbackintQt3DAnimation::QAnimationCallback*QAnimationCallback::Flags --> <h3 class="fn" id="setCallback"><a name="setCallback"></a><span class="type">void</span> QCallbackMapping::<span class="name">setCallback</span>(<span class="type">int</span> <i>type</i>, <span class="type"><a href="qt3danimation-qanimationcallback.html">Qt3DAnimation::QAnimationCallback</a></span> *<i>callback</i>, <span class="type"><a href="qt3danimation-qanimationcallback.html#Flag-enum">QAnimationCallback::Flags</a></span> <i>flags</i>)</h3> <p>Associates a <i>callback</i> object with this channel mapping.</p> <p>Such mappings do not have to have a target object and property name. When the <i>callback</i> object is set, every change in the animated value will lead to invoking the callback's <a href="qt3danimation-qanimationcallback.html#valueChanged">valueChanged</a> function either on the gui/main thread, or directly on one of the thread pool's worker thread. This is controlled by <i>flags</i>.</p> <p><i>type</i> specifies the type (for example, QVariant::Vector3D, QVariant::Color, or QMetaType::Float) of the animated value. When animating node properties this does not need to be provided separately, however it becomes important to supply this when there is only a callback.</p> <p><b>Note: </b>A mapping can be associated both with a node property and a callback. It is important however that <i>type</i> matches the type of the property in this case. Note also that for properties of type QVariant (for example, QParameter::value), the <i>type</i> is the type of the value stored in the QVariant.</p><p><b>Note: </b>The <i>callback</i> pointer is expected to stay valid while any associated animators are running.</p><p><b>See also </b><a href="qt3danimation-qcallbackmapping.html#callback">callback</a>().</p> <!-- @@@setCallback --> </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>