QAxisAccumulator#
QAxisAccumulator
processes velocity or acceleration data from a QAxis
. More…
Synopsis#
Properties#
Functions#
def
scale
()def
sourceAxis
()def
sourceAxisType
()def
value
()def
velocity
()
Slots#
def
setScale
(scale)def
setSourceAxis
(sourceAxis)def
setSourceAxisType
(sourceAxisType)
Signals#
def
scaleChanged
(scale)def
sourceAxisChanged
(sourceAxis)def
sourceAxisTypeChanged
(sourceAxisType)def
valueChanged
(value)def
velocityChanged
(value)
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description#
Constructs a new QAxisAccumulator
instance with parent
.
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.
- class PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator([parent=None])#
- Parameters:
parent –
PySide6.Qt3DCore.Qt3DCore.QNode
Constructs a new QAxisAccumulator
instance with parent parent
.
Note
Properties can be used directly when from __feature__ import true_property
is used or via accessor functions otherwise.
- property PᅟySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.scale: float#
- Access functions:
scale
()setScale
(scale)Signal
scaleChanged
(scale)
- property PᅟySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.sourceAxis: PySide6.Qt3DInput.Qt3DInput.QAxis#
- Access functions:
sourceAxis
()setSourceAxis
(sourceAxis)Signal
sourceAxisChanged
(sourceAxis)
- property PᅟySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.sourceAxisType: SourceAxisType#
- Access functions:
setSourceAxisType
(sourceAxisType)Signal
sourceAxisTypeChanged
(sourceAxisType)
- property PᅟySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.value: float#
Returns the accumulated (integrated) value.
- Access functions:
value
()Signal
valueChanged
(value)
- property PᅟySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.velocity: float#
- Access functions:
velocity
()Signal
velocityChanged
(value)
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.SourceAxisType#
Constant
Description
Qt3DInput.QAxisAccumulator.Velocity
Qt3DInput.QAxisAccumulator.Acceleration
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.scale()#
- Return type:
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
Getter of property scale
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.scaleChanged(scale)#
- Parameters:
scale – float
Notification signal of property scale
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.setScale(scale)#
- Parameters:
scale – float
See also
Setter of property scale
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.setSourceAxis(sourceAxis)#
- Parameters:
sourceAxis –
PySide6.Qt3DInput.Qt3DInput.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
Setter of property sourceAxis
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.setSourceAxisType(sourceAxisType)#
- Parameters:
sourceAxisType –
SourceAxisType
Sets how the accumulator treats the values originating from the sourceAxisType
.
See also
Setter of property sourceAxisType
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.sourceAxis()#
- Return type:
Returns QAxis
for which the accumulator should integrate axis values.
See also
Getter of property sourceAxis
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.sourceAxisChanged(sourceAxis)#
- Parameters:
sourceAxis –
PySide6.Qt3DInput.Qt3DInput.QAxis
Notification signal of property sourceAxis
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.sourceAxisType()#
- Return type:
Returns how the accumulator treats the value of the sourceAxis
.
See also
Getter of property sourceAxisType
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.sourceAxisTypeChanged(sourceAxisType)#
- Parameters:
sourceAxisType –
SourceAxisType
Notification signal of property sourceAxisType
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.value()#
- Return type:
float
Getter of property value
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.valueChanged(value)#
- Parameters:
value – float
Notification signal of property value
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.velocity()#
- Return type:
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.
Getter of property velocity
.
- PySide6.Qt3DInput.Qt3DInput.QAxisAccumulator.velocityChanged(value)#
- Parameters:
value – float
Notification signal of property velocity
.