QEasingCurve

Note

This class was introduced in Qt 4.6

Synopsis

Functions

• def __eq__ (other)
• def __ne__ (other)
• def amplitude ()
• def customType ()
• def overshoot ()
• def period ()
• def setAmplitude (amplitude)
• def setCustomType (arg__1)
• def setOvershoot (overshoot)
• def setPeriod (period)
• def setType (type)
• def type ()
• def valueForProgress (progress)

Detailed Description

The PySide.QtCore.QEasingCurve class provides easing curves for controlling animation.

Easing curves describe a function that controls how the speed of the interpolation between 0 and 1 should be. Easing curves allow transitions from one value to another to appear more natural than a simple constant speed would allow. The PySide.QtCore.QEasingCurve class is usually used in conjunction with the PySide.QtCore.QVariantAnimation and PySide.QtCore.QPropertyAnimation classes but can be used on its own. It is usually used to accelerate the interpolation from zero velocity (ease in) or decelerate to zero velocity (ease out). Ease in and ease out can also be combined in the same easing curve.

To calculate the speed of the interpolation, the easing curve provides the function PySide.QtCore.QEasingCurve.valueForProgress() , where the progress argument specifies the progress of the interpolation: 0 is the start value of the interpolation, 1 is the end value of the interpolation. The returned value is the effective progress of the interpolation. If the returned value is the same as the input value for all input values the easing curve is a linear curve. This is the default behaviour.

For example,

QEasingCurve easing(QEasingCurve::InOutQuad);

for(qreal t = 0.0; t < 1.0; t+=0.1)
    qWarning() << "Effective progress" << t << " is
               << easing.valueForProgress(t);

will print the effective progress of the interpolation between 0 and 1.

When using a PySide.QtCore.QPropertyAnimation , the associated easing curve will be used to control the progress of the interpolation between startValue and endValue:

QPropertyAnimation animation;
animation.setStartValue(0);
animation.setEndValue(1000);
animation.setDuration(1000);
animation.setEasingCurve(QEasingCurve::InOutQuad);

The ability to set an amplitude, overshoot, or period depends on the PySide.QtCore.QEasingCurve type. Amplitude access is available to curves that behave as springs such as elastic and bounce curves. Changing the amplitude changes the height of the curve. Period access is only available to elastic curves and setting a higher period slows the rate of bounce. Only curves that have “boomerang” behaviors such as the InBack , OutBack , InOutBack , and OutInBack have overshoot settings. These curves will interpolate beyond the end points and return to the end point, acting similar to a boomerang.

The Easing Curves Example contains samples of PySide.QtCore.QEasingCurve types and lets you change the curve settings.

class PySide.QtCore.QEasingCurve([type=Linear])

class PySide.QtCore.QEasingCurve(other)

Parameters:

• other – PySide.QtCore.QEasingCurve
• type – PySide.QtCore.QEasingCurve.Type

Constructs an easing curve of the given type .

Construct a copy of other .

PySide.QtCore.QEasingCurve.Type

The type of easing curve.

Constant	Description
QEasingCurve.Linear
QEasingCurve.InQuad
QEasingCurve.OutQuad
QEasingCurve.InOutQuad
QEasingCurve.OutInQuad
QEasingCurve.InCubic
QEasingCurve.OutCubic
QEasingCurve.InOutCubic
QEasingCurve.OutInCubic
QEasingCurve.InQuart
QEasingCurve.OutQuart
QEasingCurve.InOutQuart
QEasingCurve.OutInQuart
QEasingCurve.InQuint
QEasingCurve.OutQuint
QEasingCurve.InOutQuint
QEasingCurve.OutInQuint
QEasingCurve.InSine
QEasingCurve.OutSine
QEasingCurve.InOutSine
QEasingCurve.OutInSine
QEasingCurve.InExpo
QEasingCurve.OutExpo
QEasingCurve.InOutExpo
QEasingCurve.OutInExpo
QEasingCurve.InCirc
QEasingCurve.OutCirc
QEasingCurve.InOutCirc
QEasingCurve.OutInCirc
QEasingCurve.InElastic
QEasingCurve.OutElastic
QEasingCurve.InOutElastic
QEasingCurve.OutInElastic
QEasingCurve.InBack
QEasingCurve.OutBack
QEasingCurve.InOutBack
QEasingCurve.OutInBack
QEasingCurve.InBounce
QEasingCurve.OutBounce
QEasingCurve.InOutBounce
QEasingCurve.OutInBounce
QEasingCurve.Custom	This is returned if the user specified a custom curve type with PySide.QtCore.QEasingCurve.setCustomType() . Note that you cannot call PySide.QtCore.QEasingCurve.setType() with this value, but PySide.QtCore.QEasingCurve.type() can return it.

PySide.QtCore.QEasingCurve.amplitude()

Return type:PySide.QtCore.qreal

Returns the amplitude. This is not applicable for all curve types. It is only applicable for bounce and elastic curves (curves of PySide.QtCore.QEasingCurve.type() QEasingCurve.InBounce , QEasingCurve.OutBounce , QEasingCurve.InOutBounce , QEasingCurve.OutInBounce , QEasingCurve.InElastic , QEasingCurve.OutElastic , QEasingCurve.InOutElastic or QEasingCurve.OutInElastic ).

See also

PySide.QtCore.QEasingCurve.setAmplitude()

PySide.QtCore.QEasingCurve.customType()

Return type:PyObject

PySide.QtCore.QEasingCurve.__ne__(other)

Parameters:other – PySide.QtCore.QEasingCurve Return type:PySide.QtCore.bool

Compare this easing curve with other and returns true if they are not equal. It will also compare the properties of a curve.

See also

PySide.QtCore.QEasingCurve.operator==()

PySide.QtCore.QEasingCurve.__eq__(other)

Parameters:other – PySide.QtCore.QEasingCurve Return type:PySide.QtCore.bool

Compare this easing curve with other and returns true if they are equal. It will also compare the properties of a curve.

PySide.QtCore.QEasingCurve.overshoot()

Return type:PySide.QtCore.qreal

Returns the overshoot. This is not applicable for all curve types. It is only applicable if PySide.QtCore.QEasingCurve.type() is QEasingCurve.InBack , QEasingCurve.OutBack , QEasingCurve.InOutBack or QEasingCurve.OutInBack .

See also

PySide.QtCore.QEasingCurve.setOvershoot()

PySide.QtCore.QEasingCurve.period()

Return type:PySide.QtCore.qreal

Returns the period. This is not applicable for all curve types. It is only applicable if PySide.QtCore.QEasingCurve.type() is QEasingCurve.InElastic , QEasingCurve.OutElastic , QEasingCurve.InOutElastic or QEasingCurve.OutInElastic .

See also

PySide.QtCore.QEasingCurve.setPeriod()

PySide.QtCore.QEasingCurve.setAmplitude(amplitude)

Parameters:amplitude – PySide.QtCore.qreal

Sets the amplitude to amplitude .

This will set the amplitude of the bounce or the amplitude of the elastic “spring” effect. The higher the number, the higher the amplitude.

See also

PySide.QtCore.QEasingCurve.amplitude()

PySide.QtCore.QEasingCurve.setCustomType(arg__1)

Parameters:arg__1 – PyObject

PySide.QtCore.QEasingCurve.setOvershoot(overshoot)

Parameters:overshoot – PySide.QtCore.qreal

Sets the overshoot to overshoot .

0 produces no overshoot, and the default value of 1.70158 produces an overshoot of 10 percent.

See also

PySide.QtCore.QEasingCurve.overshoot()

PySide.QtCore.QEasingCurve.setPeriod(period)

Parameters:period – PySide.QtCore.qreal

Sets the period to period . Setting a small period value will give a high frequency of the curve. A large period will give it a small frequency.

See also

PySide.QtCore.QEasingCurve.period()

PySide.QtCore.QEasingCurve.setType(type)

Parameters:type – PySide.QtCore.QEasingCurve.Type

Sets the type of the easing curve to type .

See also

PySide.QtCore.QEasingCurve.type()

PySide.QtCore.QEasingCurve.type()

Return type:PySide.QtCore.QEasingCurve.Type

Returns the type of the easing curve.

See also

PySide.QtCore.QEasingCurve.setType()

PySide.QtCore.QEasingCurve.valueForProgress(progress)

Parameters:progress – PySide.QtCore.qreal Return type:PySide.QtCore.qreal

Return the effective progress for the easing curve at progress . While progress must be between 0 and 1, the returned effective progress can be outside those bounds. For instance, QEasingCurve.InBack will return negative values in the beginning of the function.