#include <qquickpathinterpolator_p.h>

Inheritance diagram for QQuickPathInterpolator:

Collaboration diagram for QQuickPathInterpolator:

Signals
void	pathChanged ()

void	progressChanged ()

void	xChanged ()

void	yChanged ()

void	angleChanged ()

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
	QQuickPathInterpolator (QObject *parent=nullptr)
	\qmltype PathInterpolator \instantiates QQuickPathInterpolator \inqmlmodule QtQuick

QQuickPath *	path () const
	\qmlproperty Path QtQuick::PathInterpolator::path This property holds the path to interpolate.

void	setPath (QQuickPath *path)

qreal	progress () const
	\qmlproperty real QtQuick::PathInterpolator::progress This property holds the current progress along the path.

void	setProgress (qreal progress)

qreal	x () const
	\qmlproperty real QtQuick::PathInterpolator::x \qmlproperty real QtQuick::PathInterpolator::y

qreal	y () const

qreal	angle () const
	\qmlproperty real QtQuick::PathInterpolator::angle

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`.

Properties
QQuickPath *	path

qreal	progress

qreal	x

qreal	y

qreal	angle

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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 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
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 28 of file qquickpathinterpolator_p.h.

Constructor & Destructor Documentation

◆ QQuickPathInterpolator()

QT_BEGIN_NAMESPACE QQuickPathInterpolator::QQuickPathInterpolator ( QObject * parent = nullptr )

explicit

\qmltype PathInterpolator \instantiates QQuickPathInterpolator \inqmlmodule QtQuick

Specifies how to manually animate along a path.

PathInterpolator provides x, y, and angle information for a particular progress along a path.

In the following example, we animate a green rectangle along a bezier path.

import QtQuick
 
Rectangle {
    width: 400
    height: 400
 
    PathInterpolator {
        id: motionPath
 
        path: Path {
            startX: 0; startY: 0
 
            PathCubic {
                x: 350; y: 350
 
                control1X: 350; control1Y: 0
                control2X: 0; control2Y: 350
            }
        }
 
        NumberAnimation on progress { from: 0; to: 1; duration: 2000 }
    }
 
    Rectangle {
        width: 50; height: 50
        color: "green"
 
        //bind our attributes to follow the path as progress changes
        x: motionPath.x
        y: motionPath.y
        rotation: motionPath.angle
    }
}

Definition at line 25 of file qquickpathinterpolator.cpp.

Member Function Documentation

◆ angle()

qreal QQuickPathInterpolator::angle ( ) const

\qmlproperty real QtQuick::PathInterpolator::angle

This property holds the angle of the path tangent at \l progress.

Angles are reported clockwise, with zero degrees at the 3 o'clock position.

Definition at line 101 of file qquickpathinterpolator.cpp.

◆ angleChanged

void QQuickPathInterpolator::angleChanged ( )

signal

◆ path()

QQuickPath * QQuickPathInterpolator::path ( ) const

\qmlproperty Path QtQuick::PathInterpolator::path This property holds the path to interpolate.

For more information on defining a path see the \l Path documentation.

Definition at line 36 of file qquickpathinterpolator.cpp.

◆ pathChanged

void QQuickPathInterpolator::pathChanged ( )

signal

Referenced by setPath().

Here is the caller graph for this function:

◆ progress()

qreal QQuickPathInterpolator::progress ( ) const

\qmlproperty real QtQuick::PathInterpolator::progress This property holds the current progress along the path.

Typical usage of PathInterpolator is to set the progress (often via a NumberAnimation), and read the corresponding values for x, y, and angle (often via bindings to these values).

Progress ranges from 0.0 to 1.0.

Definition at line 62 of file qquickpathinterpolator.cpp.

◆ progressChanged

void QQuickPathInterpolator::progressChanged ( )

signal

Referenced by setProgress().

Here is the caller graph for this function:

◆ setPath()

void QQuickPathInterpolator::setPath ( QQuickPath * path )

Definition at line 41 of file qquickpathinterpolator.cpp.

References QObject::connect(), disconnect(), emit, path, pathChanged(), SIGNAL, and SLOT.

Here is the call graph for this function:

◆ setProgress()

void QQuickPathInterpolator::setProgress ( qreal progress )

Definition at line 67 of file qquickpathinterpolator.cpp.

References emit, progress, progressChanged(), qMax(), and qMin().

Here is the call graph for this function:

◆ x()

qreal QQuickPathInterpolator::x ( ) const

\qmlproperty real QtQuick::PathInterpolator::x \qmlproperty real QtQuick::PathInterpolator::y

These properties hold the position of the path at \l progress.

Definition at line 84 of file qquickpathinterpolator.cpp.

◆ xChanged

void QQuickPathInterpolator::xChanged ( )

signal

◆ y()

qreal QQuickPathInterpolator::y ( ) const

Definition at line 89 of file qquickpathinterpolator.cpp.

◆ yChanged

void QQuickPathInterpolator::yChanged ( )

signal

Property Documentation

◆ angle

qreal QQuickPathInterpolator::angle

read

Definition at line 35 of file qquickpathinterpolator_p.h.

◆ path

QQuickPath * QQuickPathInterpolator::path

readwrite

Definition at line 31 of file qquickpathinterpolator_p.h.

Referenced by setPath().

◆ progress

qreal QQuickPathInterpolator::progress

readwrite

Definition at line 32 of file qquickpathinterpolator_p.h.

Referenced by setProgress().

◆ x

qreal QQuickPathInterpolator::x

read

Definition at line 33 of file qquickpathinterpolator_p.h.

◆ y

qreal QQuickPathInterpolator::y

read

Definition at line 34 of file qquickpathinterpolator_p.h.

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

qtdeclarative/src/quick/util/qquickpathinterpolator_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/util/qquickpathinterpolator.cpp (0dc4fd240a2897c5c443a0ef6d84c416843e4938)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickPathInterpolator()

Member Function Documentation

◆ angle()

◆ angleChanged

◆ path()

◆ pathChanged

◆ progress()

◆ progressChanged

◆ setPath()

◆ setProgress()

◆ x()

◆ xChanged

◆ y()

◆ yChanged

Property Documentation

◆ angle

◆ path

◆ progress

◆ x

◆ y