QAxisAccumulator

PyQt5.Qt3DInput.QAxisAccumulator

Inherits from QComponent.

Description

Constructs a new QAxisAccumulator instance with parent.

QAxisAccumulator processes velocity or acceleration data from a QAxis.

A QAxis 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 QAxis 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 QFrameAction but those approached are not ideal as they add more work to the main thread and are inherently imperative. The QAxisAccumulator class allows for this common task to be performed on the Qt 3D backend and be specified in a declarative manner.

Enums

SourceAxisType

Member	Value	Description
Acceleration	TODO	TODO
Velocity	TODO	TODO

Methods

__init__(parent: QNode = None)

Constructs a new QAxisAccumulator instance with parent parent.

---

scale() → float

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.

Returns the amount the input axis values are scaled by.

See also

setScale().

---

sceneChangeEvent(QSceneChange)

TODO

---

setScale(float)

See also

scale().

---

setSourceAxis(QAxis)

Sets the source axis from which the accumulator should receive values from to sourceAxis. How these values are treated is controlled by the sourceAxisType and scale properties.

See also

sourceAxis().

---

setSourceAxisType(SourceAxisType)

TODO

---

sourceAxis() → QAxis

Returns QAxis for which the accumulator should integrate axis values.

See also

setSourceAxis().

---

sourceAxisType() → SourceAxisType

Returns how the accumulator treats the value of the sourceAxis.

See also

setSourceAxisType().

---

value() → float

TODO

---

velocity() → float

Returns the velocity. If the sourceAxisType is set to Velocity this is simply the value of the source axis multiplied by the scale. If the sourceAxisType is set to Acceleration, the velocity is integrated using the source axis’ value as an acceleration.

Signals

scaleChanged(float)

TODO

---

sourceAxisChanged(QAxis)

TODO

---

sourceAxisTypeChanged(SourceAxisType)

TODO

---

valueChanged(float)

TODO

---

velocityChanged(float)

TODO