QEasingCurve Class

    QEasingCurve easing(QEasingCurve::InOutQuad);

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

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

qreal myEasingFunction(qreal progress);

Member Function Documentation

QEasingCurve::QEasingCurve(QEasingCurve::Type type = Linear)

Constructs an easing curve of the given type.

QEasingCurve::QEasingCurve(const QEasingCurve &other)

Construct a copy of other.

QEasingCurve::QEasingCurve(QEasingCurve &&other)

Move-constructs a QEasingCurve instance, making it point at the same object that other was pointing to.

QEasingCurve::~QEasingCurve()

Destructor.

void QEasingCurve::addCubicBezierSegment(const QPointF &c1, const QPointF &c2, const QPointF &endPoint)

Adds a segment of a cubic bezier spline to define a custom easing curve. It is only applicable if type() is QEasingCurve::BezierSpline. Note that the spline implicitly starts at (0.0, 0.0) and has to end at (1.0, 1.0) to be a valid easing curve. c1 and c2 are the control points used for drawing the curve. endPoint is the endpoint of the curve.

void QEasingCurve::addTCBSegment(const QPointF &nextPoint, qreal t, qreal c, qreal b)

Adds a segment of a TCB bezier spline to define a custom easing curve. It is only applicable if type() is QEasingCurve::TCBSpline. The spline has to start explicitly at (0.0, 0.0) and has to end at (1.0, 1.0) to be a valid easing curve. The tension t changes the length of the tangent vector. The continuity c changes the sharpness in change between the tangents. The bias b changes the direction of the tangent vector. nextPoint is the sample position. All three parameters are valid between -1 and 1 and define the tangent of the control point. If all three parameters are 0 the resulting spline is a Catmull-Rom spline. The begin and endpoint always have a bias of -1 and 1, since the outer tangent is not defined.

qreal QEasingCurve::amplitude() const

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

See also setAmplitude().

QEasingCurve::EasingFunction QEasingCurve::customType() const

Returns the function pointer to the custom easing curve. If type() does not return QEasingCurve::Custom, this function will return 0.

See also setCustomType().

qreal QEasingCurve::overshoot() const

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

See also setOvershoot().

qreal QEasingCurve::period() const

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

See also setPeriod().

void QEasingCurve::setAmplitude(qreal amplitude)

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 amplitude().

void QEasingCurve::setCustomType(QEasingCurve::EasingFunction func)

Sets a custom easing curve that is defined by the user in the function func. The signature of the function is qreal myEasingFunction(qreal progress), where progress and the return value are considered to be normalized between 0 and 1. (In some cases the return value can be outside that range) After calling this function type() will return QEasingCurve::Custom. func cannot be zero.

See also customType() and valueForProgress().

void QEasingCurve::setOvershoot(qreal overshoot)

Sets the overshoot to overshoot.

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

See also overshoot().

void QEasingCurve::setPeriod(qreal period)

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 period().

void QEasingCurve::setType(QEasingCurve::Type type)

Sets the type of the easing curve to type.

See also type().

void QEasingCurve::swap(QEasingCurve &other)

Swaps this curve with other. This operation is very fast and never fails.

QList<QPointF> QEasingCurve::toCubicSpline() const

Returns the cubicBezierSpline that defines a custom easing curve. If the easing curve does not have a custom bezier easing curve the list is empty.

QEasingCurve::Type QEasingCurve::type() const

Returns the type of the easing curve.

See also setType().

qreal QEasingCurve::valueForProgress(qreal progress) const

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

bool QEasingCurve::operator!=(const QEasingCurve &other) const

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 operator==().

QEasingCurve &QEasingCurve::operator=(const QEasingCurve &other)

Copy other.

QEasingCurve &QEasingCurve::operator=(QEasingCurve &&other)

Move-assigns other to this QEasingCurve instance.

bool QEasingCurve::operator==(const QEasingCurve &other) const

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