Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Signals | Public Member Functions | Properties | List of all members
QQuickSpringAnimation Class Reference

#include <qquickspringanimation_p.h>

+ Inheritance diagram for QQuickSpringAnimation:
+ Collaboration diagram for QQuickSpringAnimation:

Signals

void modulusChanged ()
 
void massChanged ()
 
void syncChanged ()
 
- Signals inherited from QQuickPropertyAnimation
void durationChanged (int)
 
void fromChanged ()
 
void toChanged ()
 
void easingChanged (const QEasingCurve &)
 
void propertiesChanged (const QString &)
 
void targetChanged ()
 
void propertyChanged ()
 
- Signals inherited from QQuickAbstractAnimation
void started ()
 
void stopped ()
 
void runningChanged (bool)
 
void pausedChanged (bool)
 
void alwaysRunToEndChanged (bool)
 
void loopCountChanged (int)
 
 Q_REVISION (2, 12) void finished()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QQuickSpringAnimation (QObject *parent=nullptr)
 \qmltype SpringAnimation \instantiates QQuickSpringAnimation \inqmlmodule QtQuick\inherits NumberAnimation
 
 ~QQuickSpringAnimation ()
 
qreal velocity () const
 \qmlproperty real QtQuick::SpringAnimation::velocity
 
void setVelocity (qreal velocity)
 
qreal spring () const
 \qmlproperty real QtQuick::SpringAnimation::spring
 
void setSpring (qreal spring)
 
qreal damping () const
 \qmlproperty real QtQuick::SpringAnimation::damping This property holds the spring damping value.
 
void setDamping (qreal damping)
 
qreal epsilon () const
 \qmlproperty real QtQuick::SpringAnimation::epsilon This property holds the spring epsilon.
 
void setEpsilon (qreal epsilon)
 
qreal mass () const
 \qmlproperty real QtQuick::SpringAnimation::mass This property holds the "mass" of the property being moved.
 
void setMass (qreal modulus)
 
qreal modulus () const
 \qmlproperty real QtQuick::SpringAnimation::modulus This property holds the modulus value.
 
void setModulus (qreal modulus)
 
QAbstractAnimationJob * transition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection direction, QObject *defaultTarget=nullptr) override
 
- Public Member Functions inherited from QQuickNumberAnimation
 QQuickNumberAnimation (QObject *parent=nullptr)
 \qmltype NumberAnimation \instantiates QQuickNumberAnimation \inqmlmodule QtQuick\inherits PropertyAnimation
 
 ~QQuickNumberAnimation () override
 
qreal from () const
 
void setFrom (qreal)
 
qreal to () const
 \qmlproperty real QtQuick::NumberAnimation::to This property holds the end value for the animation.
 
void setTo (qreal)
 
- Public Member Functions inherited from QQuickPropertyAnimation
 QQuickPropertyAnimation (QObject *parent=nullptr)
 \qmltype PropertyAnimation \instantiates QQuickPropertyAnimation \inqmlmodule QtQuick\inherits Animation
 
 ~QQuickPropertyAnimation () override
 
virtual int duration () const
 \qmlproperty int QtQuick::PropertyAnimation::duration This property holds the duration of the animation, in milliseconds.
 
virtual void setDuration (int)
 
QVariant from () const
 \qmlproperty variant QtQuick::PropertyAnimation::from This property holds the starting value for the animation.
 
void setFrom (const QVariant &)
 
QVariant to () const
 \qmlproperty variant QtQuick::PropertyAnimation::to This property holds the end value for the animation.
 
void setTo (const QVariant &)
 
QEasingCurve easing () const
 Specifies the easing curve used for the animation.
 
void setEasing (const QEasingCurve &)
 
QObject * target () const
 
void setTargetObject (QObject *)
 
QString property () const
 
void setProperty (const QString &)
 
QString properties () const
 
void setProperties (const QString &)
 
QQmlListProperty< QObject > targets ()
 
QQmlListProperty< QObject > exclude ()
 
- Public Member Functions inherited from QQuickAbstractAnimation
 QQuickAbstractAnimation (QObject *parent=nullptr)
 \qmltype Animation \instantiates QQuickAbstractAnimation \inqmlmodule QtQuick
 
 ~QQuickAbstractAnimation () override
 
bool isRunning () const
 \qmlproperty bool QtQuick::Animation::running This property holds whether the animation is currently running.
 
void setRunning (bool)
 \qmlsignal QtQuick::Animation::started()
 
bool isPaused () const
 \qmlproperty bool QtQuick::Animation::paused This property holds whether the animation is currently paused.
 
void setPaused (bool)
 
bool alwaysRunToEnd () const
 \qmlproperty bool QtQuick::Animation::alwaysRunToEnd This property holds whether the animation should run to completion when it is stopped.
 
void setAlwaysRunToEnd (bool)
 
int loops () const
 \qmlproperty int QtQuick::Animation::loops This property holds the number of times the animation should play.
 
void setLoops (int)
 
int duration () const
 
int currentTime ()
 
void setCurrentTime (int)
 
QQuickAnimationGroup * group () const
 
void setGroup (QQuickAnimationGroup *, int index=-1)
 
void setDefaultTarget (const QQmlProperty &)
 
void setDisableUserControl ()
 
void setEnableUserControl ()
 
bool userControlDisabled () const
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
virtual ThreadingModel threadingModel () const
 
QAbstractAnimationJob * qtAnimation ()
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QQmlPropertyValueSource
 QQmlPropertyValueSource ()
 Constructs a QQmlPropertyValueSource.
 
virtual ~QQmlPropertyValueSource ()
 Destroys the value source.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Properties

qreal velocity
 
qreal spring
 
qreal damping
 
qreal epsilon
 
qreal modulus
 
qreal mass
 
- Properties inherited from QQuickNumberAnimation
qreal from
 
qreal to
 
- Properties inherited from QQuickPropertyAnimation
int duration
 
QVariant from
 
QVariant to
 
QEasingCurve easing
 
QObject * target
 
QString property
 
QString properties
 
QQmlListProperty< QObject > targets
 
QQmlListProperty< QObject > exclude
 \qmlproperty list<QtObject> QtQuick::PropertyAnimation::exclude This property holds the items not to be affected by this animation.
 
- Properties inherited from QQuickAbstractAnimation
bool running
 
bool paused
 
bool alwaysRunToEnd
 
int loops
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Types inherited from QQuickAbstractAnimation
enum  ThreadingModel { GuiThread , RenderThread , AnyThread }
 
enum  Loops { Infinite = -2 }
 
enum  TransitionDirection { Forward , Backward }
 
- Public Slots inherited from QQuickAbstractAnimation
void restart ()
 \qmlmethod QtQuick::Animation::restart()
 
void start ()
 \qmlmethod QtQuick::Animation::start()
 
void pause ()
 \qmlmethod QtQuick::Animation::pause()
 
void resume ()
 \qmlmethod QtQuick::Animation::resume()
 
void stop ()
 \qmlmethod QtQuick::Animation::stop()
 
void complete ()
 \qmlmethod QtQuick::Animation::complete()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QQuickNumberAnimation
 QQuickNumberAnimation (QQuickPropertyAnimationPrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QQuickPropertyAnimation
QQuickStateActions createTransitionActions (QQuickStateActions &actions, QQmlProperties &modified, QObject *defaultTarget=nullptr)
 
 QQuickPropertyAnimation (QQuickPropertyAnimationPrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QQuickAbstractAnimation
 QQuickAbstractAnimation (QQuickAbstractAnimationPrivate &dd, QObject *parent)
 
QAbstractAnimationJob * initInstance (QAbstractAnimationJob *animation)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 26 of file qquickspringanimation_p.h.

Constructor & Destructor Documentation

◆ QQuickSpringAnimation()

QQuickSpringAnimation::QQuickSpringAnimation ( QObject * parent = nullptr)

\qmltype SpringAnimation \instantiates QQuickSpringAnimation \inqmlmodule QtQuick\inherits NumberAnimation

Allows a property to track a value in a spring-like motion.

SpringAnimation mimics the oscillatory behavior of a spring, with the appropriate \l spring constant to control the acceleration and the \l damping to control how quickly the effect dies away.

You can also limit the maximum \l velocity of the animation.

The following \l Rectangle moves to the position of the mouse using a SpringAnimation when the mouse is clicked. The use of the \l Behavior on the x and y values indicates that whenever these values are changed, a SpringAnimation should be applied.

import QtQuick
Item {
width: 300; height: 300
Rectangle {
id: rect
width: 50; height: 50
color: "red"
Behavior on x { SpringAnimation { spring: 2; damping: 0.2 } }
Behavior on y { SpringAnimation { spring: 2; damping: 0.2 } }
}
MouseArea {
anchors.fill: parent
onClicked: (mouse)=> {
rect.x = mouse.x - rect.width/2
rect.y = mouse.y - rect.height/2
}
}
}

Like any other animation type, a SpringAnimation can be applied in a number of ways, including transitions, behaviors and property value sources. The \l {Animation and Transitions in Qt Quick} documentation shows a variety of methods for creating animations.

See also
SmoothedAnimation, {Animation and Transitions in Qt Quick}, {Qt Quick Examples - Animation}, {Qt Quick Demo - Clocks}

Definition at line 341 of file qquickspringanimation.cpp.

◆ ~QQuickSpringAnimation()

QQuickSpringAnimation::~QQuickSpringAnimation ( )

Definition at line 346 of file qquickspringanimation.cpp.

References QSet< T >::begin(), d, and it.

+ Here is the call graph for this function:

Member Function Documentation

◆ damping()

qreal QQuickSpringAnimation::damping ( ) const

\qmlproperty real QtQuick::SpringAnimation::damping This property holds the spring damping value.

This value describes how quickly the spring-like motion comes to rest. The default value is 0.

The useful value range is 0 - 1.0. The lower the value, the faster it comes to rest.

Definition at line 409 of file qquickspringanimation.cpp.

References d.

◆ epsilon()

qreal QQuickSpringAnimation::epsilon ( ) const

\qmlproperty real QtQuick::SpringAnimation::epsilon This property holds the spring epsilon.

The epsilon is the rate and amount of change in the value which is close enough to 0 to be considered equal to zero. This will depend on the usage of the value. For pixel positions, 0.25 would suffice. For scale, 0.005 will suffice.

The default is 0.01. Tuning this value can provide small performance improvements.

Definition at line 435 of file qquickspringanimation.cpp.

References d.

◆ mass()

qreal QQuickSpringAnimation::mass ( ) const

\qmlproperty real QtQuick::SpringAnimation::mass This property holds the "mass" of the property being moved.

The value is 1.0 by default.

A greater mass causes slower movement and a greater spring-like motion when an item comes to rest.

Definition at line 480 of file qquickspringanimation.cpp.

References d.

◆ massChanged

void QQuickSpringAnimation::massChanged ( )
signal

Referenced by setMass().

+ Here is the caller graph for this function:

◆ modulus()

qreal QQuickSpringAnimation::modulus ( ) const

\qmlproperty real QtQuick::SpringAnimation::modulus This property holds the modulus value.

The default value is 0.

Setting a modulus forces the target value to "wrap around" at the modulus. For example, setting the modulus to 360 will cause a value of 370 to wrap around to 10.

Definition at line 454 of file qquickspringanimation.cpp.

References d.

◆ modulusChanged

void QQuickSpringAnimation::modulusChanged ( )
signal

Referenced by setModulus().

+ Here is the caller graph for this function:

◆ setDamping()

void QQuickSpringAnimation::setDamping ( qreal damping)

Definition at line 415 of file qquickspringanimation.cpp.

References d, and damping.

◆ setEpsilon()

void QQuickSpringAnimation::setEpsilon ( qreal epsilon)

Definition at line 441 of file qquickspringanimation.cpp.

References d, and epsilon.

◆ setMass()

void QQuickSpringAnimation::setMass ( qreal modulus)

Definition at line 486 of file qquickspringanimation.cpp.

References d, emit, mass, and massChanged().

+ Here is the call graph for this function:

◆ setModulus()

void QQuickSpringAnimation::setModulus ( qreal modulus)

Definition at line 460 of file qquickspringanimation.cpp.

References d, emit, modulus, and modulusChanged().

+ Here is the call graph for this function:

◆ setSpring()

void QQuickSpringAnimation::setSpring ( qreal spring)

Definition at line 392 of file qquickspringanimation.cpp.

References d, and spring.

◆ setVelocity()

void QQuickSpringAnimation::setVelocity ( qreal velocity)

Definition at line 367 of file qquickspringanimation.cpp.

References d, and velocity.

◆ spring()

qreal QQuickSpringAnimation::spring ( ) const

\qmlproperty real QtQuick::SpringAnimation::spring

This property describes how strongly the target is pulled towards the source. The default value is 0 (that is, the spring-like motion is disabled).

The useful value range is 0 - 5.0.

When this property is set and the \l velocity value is greater than 0, the \l velocity limits the maximum speed.

Definition at line 386 of file qquickspringanimation.cpp.

References d.

◆ syncChanged

void QQuickSpringAnimation::syncChanged ( )
signal

◆ transition()

QAbstractAnimationJob * QQuickSpringAnimation::transition ( QQuickStateActions & actions,
QQmlProperties & modified,
TransitionDirection direction,
QObject * defaultTarget = nullptr )
overridevirtual

Reimplemented from QQuickPropertyAnimation.

Definition at line 496 of file qquickspringanimation.cpp.

References animation, copy(), QQuickPropertyAnimation::createTransitionActions(), QVariantAnimation::currentValue, d, direction, dist(), QVariant::fromValue(), i, QQuickAbstractAnimation::initInstance(), QQmlProperty::property(), QQuickPropertyAnimation::property, Q_UNUSED, qAbs(), QVariant::toReal(), and QSpringAnimation::Velocity.

+ Here is the call graph for this function:

◆ velocity()

qreal QQuickSpringAnimation::velocity ( ) const

\qmlproperty real QtQuick::SpringAnimation::velocity

This property holds the maximum velocity allowed when tracking the source.

The default value is 0 (no maximum velocity).

Definition at line 361 of file qquickspringanimation.cpp.

References d.

Property Documentation

◆ damping

qreal QQuickSpringAnimation::damping
readwrite

Definition at line 35 of file qquickspringanimation_p.h.

Referenced by setDamping().

◆ epsilon

qreal QQuickSpringAnimation::epsilon
readwrite

Definition at line 36 of file qquickspringanimation_p.h.

Referenced by setEpsilon().

◆ mass

qreal QQuickSpringAnimation::mass
readwrite

Definition at line 38 of file qquickspringanimation_p.h.

Referenced by setMass().

◆ modulus

qreal QQuickSpringAnimation::modulus
readwrite

Definition at line 37 of file qquickspringanimation_p.h.

Referenced by setModulus().

◆ spring

qreal QQuickSpringAnimation::spring
readwrite

Definition at line 34 of file qquickspringanimation_p.h.

Referenced by setSpring().

◆ velocity

qreal QQuickSpringAnimation::velocity
readwrite

Definition at line 33 of file qquickspringanimation_p.h.

Referenced by setVelocity().

The documentation for this class was generated from the following files: