<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaxisaccumulator.cpp -->
<title>AxisAccumulator QML Type | Qt 3D 5.12.2</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-qml.html">QML Types</a></td><td >AxisAccumulator QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">AxisAccumulator QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AxisAccumulator-brief -->
<p>QML frontend for the <a href="qt3dinput-qaxisaccumulator.html">Qt3DInput::QAxisAccumulator</a> C++ class. <a href="#details">More...</a></p>
<!-- @@@AxisAccumulator -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt3D.Input 2.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.8</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-input-axisaccumulator.html"><a href="qt3dinput-qaxisaccumulator.html">QAxisAccumulator</a></td></tr></table></div><ul>
<li><a href="qml-qt3d-input-axisaccumulator-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><b><a href="qml-qt3d-input-axisaccumulator.html#sourceAxis-prop">sourceAxis</a></b></b> : Axis</li>
<li class="fn"><b><b><a href="qml-qt3d-input-axisaccumulator.html#sourceAxisType-prop">sourceAxisType</a></b></b> : SourceAxisType</li>
<li class="fn"><b><b><a href="qml-qt3d-input-axisaccumulator.html#value-prop">value</a></b></b> : real</li>
</ul>
<!-- $$$AxisAccumulator-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>An Axis reports the current position of an axis on an input device. When the axis is returned to its neutral position the value of that axis returns to 0. Often, it is required to have the input from an axis control a variable in other ways, for example treating the value from the Axis as a velocity (first derivative with respect to time) or as an acceleration (second derivative with respect to time). This can be done with user code or with a <a href="qml-qt3d-logic-frameaction.html">FrameAction</a> but those approached are not ideal as they add more work to the main thread and are inherently imperative. The <a href="qml-qt3d-input-axisaccumulator.html">AxisAccumulator</a> class allows for this common task to be performed on the Qt 3D backend and be specified in a declarative manner.</p>
<!-- @@@AxisAccumulator -->
<h2>Property Documentation</h2>
<!-- $$$sourceAxis -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sourceAxis-prop">
<td class="tblQmlPropNode"><p>
<a name="sourceAxis-prop"></a><span class="name">sourceAxis</span> : <span class="type"><a href="qml-qt3d-input-axis.html">Axis</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The Axis for which the accumulator should integrate axis values.</p>
</div></div><!-- @@@sourceAxis -->
<br/>
<!-- $$$sourceAxisType -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sourceAxisType-prop">
<td class="tblQmlPropNode"><p>
<a name="sourceAxisType-prop"></a><span class="name">sourceAxisType</span> : <span class="type">SourceAxisType</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The sourceAxisType property specifies how the accumulator treats the values from the source axis.</p>
</div></div><!-- @@@sourceAxisType -->
<br/>
<!-- $$$value -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="value-prop">
<td class="tblQmlPropNode"><p>
<a name="value-prop"></a><span class="name">value</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The amount to scale the axis value by when accumulating. This can be thought of as the maximum velocity or acceleration the axis can control.</p>
</div></div><!-- @@@value -->
<br/>
</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>
