QQuickSpriteEngine Class Reference

#include <qquickspriteengine_p.h>

Inheritance diagram for QQuickSpriteEngine:

Collaboration diagram for QQuickSpriteEngine:

Public Member Functions
	QQuickSpriteEngine (QObject *parent=nullptr)
	QQuickSpriteEngine (const QList< QQuickSprite * > &sprites, QObject *parent=nullptr)
	~QQuickSpriteEngine () override
QQmlListProperty< QQuickSprite >	sprites ()
QQuickSprite *	sprite (int sprite=0) const
int	spriteState (int sprite=0) const
int	spriteStart (int sprite=0) const
int	spriteFrames (int sprite=0) const
int	spriteDuration (int sprite=0) const
int	spriteX (int sprite=0) const
int	spriteY (int sprite=0) const
int	spriteWidth (int sprite=0) const
int	spriteHeight (int sprite=0) const
int	spriteCount () const
int	maxFrames () const
void	restart (int index=0) override
void	advance (int index=0) override
bool	isNull () const
bool	isReady () const
bool	isLoading () const
bool	isError () const
QQuickPixmap::Status	status () const
void	startAssemblingImage ()
QImage	assembledImage (int maxSize=2048)
Public Member Functions inherited from QQuickStochasticEngine
	QQuickStochasticEngine (QObject *parent=nullptr)
	QQuickStochasticEngine (const QList< QQuickStochasticState * > &states, QObject *parent=nullptr)
	~QQuickStochasticEngine () override
QQmlListProperty< QQuickStochasticState >	states ()
QString	globalGoal () const
int	count () const
void	setCount (int c)
void	setGoal (int state, int sprite=0, bool jump=false)
void	start (int index=0, int state=0)
void	stop (int index=0)
int	curState (int index=0) const
QQuickStochasticState *	state (int idx) const
int	stateIndex (QQuickStochasticState *s) const
int	stateIndex (const QString &s) const
int	stateCount ()
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
QQmlListProperty< QQuickSprite >	sprites
Properties inherited from QQuickStochasticEngine
QString	globalGoal
QQmlListProperty< QQuickStochasticState >	states
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QQuickStochasticEngine
void	setGlobalGoal (const QString &arg)
uint	updateSprites (uint time)
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from QQuickStochasticEngine
void	globalGoalChanged (const QString &arg)
void	stateChanged (int idx)
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.
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 QQuickStochasticEngine
void	addToUpdateList (uint t, int idx)
int	nextState (int curState, int idx=0)
int	goalSeek (int curState, int idx, int dist=-1)
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 QQuickStochasticEngine
QList< QQuickStochasticState * >	m_states
QVector< int >	m_things
QVector< int >	m_goals
QVector< int >	m_duration
QVector< int >	m_startTimes
QVector< QPair< uint, QVector< int > > >	m_stateUpdates
QElapsedTimer	m_advanceTimer
uint	m_timeOffset
QString	m_globalGoal
int	m_maxFrames
int	m_imageStateCount
bool	m_addAdvance
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 229 of file qquickspriteengine_p.h.

Constructor & Destructor Documentation

QQuickSpriteEngine() [1/2]

QQuickSpriteEngine::QQuickSpriteEngine ( QObject * parent = nullptr )

explicit

Definition at line 71 of file qquickspriteengine.cpp.

QQuickSpriteEngine() [2/2]

QQuickSpriteEngine::QQuickSpriteEngine	(	const QList< QQuickSprite * > &	sprites,
		QObject *	parent = nullptr )

Definition at line 76 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_states, sprite(), and sprites.

Here is the call graph for this function:

~QQuickSpriteEngine()

QQuickSpriteEngine::~QQuickSpriteEngine ( )

override

Definition at line 83 of file qquickspriteengine.cpp.

Member Function Documentation

advance()

void QQuickSpriteEngine::advance ( int index = 0 )

overridevirtual

Reimplemented from QQuickStochasticEngine.

Definition at line 568 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::addToUpdateList(), QList< T >::at(), QElapsedTimer::elapsed(), emit, QQuickStochasticState::entered(), QQuickSprite::frameSync, QQuickStochasticEngine::m_addAdvance, QQuickStochasticEngine::m_advanceTimer, QQuickStochasticEngine::m_duration, QQuickStochasticEngine::m_startTimes, QQuickStochasticEngine::m_states, QQuickStochasticEngine::m_things, QQuickStochasticEngine::m_timeOffset, QQuickStochasticEngine::nextState(), qWarning, restart(), spriteDuration(), spriteStart(), QQuickStochasticEngine::stateChanged(), and QQuickStochasticState::variedDuration().

Here is the call graph for this function:

assembledImage()

QImage QQuickSpriteEngine::assembledImage

(

int

maxSize = 2048

)

Definition at line 339 of file qquickspriteengine.cpp.

References QQuickPixmap::Error, QFile::exists(), QImage::Format_ARGB32_Premultiplied, frameSize(), QQuickStochasticEngine::m_imageStateCount, QQuickStochasticEngine::m_maxFrames, qDebug, qMax(), qmlWarning(), qWarning, QQuickPixmap::Ready, state, status(), and QDir::tempPath().

Here is the call graph for this function:

isError()

bool QQuickSpriteEngine::isError ( ) const

inline

Definition at line 261 of file qquickspriteengine_p.h.

References QQuickPixmap::Error.

isLoading()

bool QQuickSpriteEngine::isLoading ( ) const

inline

Definition at line 260 of file qquickspriteengine_p.h.

References QQuickPixmap::Loading.

isNull()

bool QQuickSpriteEngine::isNull ( ) const

inline

Definition at line 258 of file qquickspriteengine_p.h.

References QQuickPixmap::Null.

isReady()

bool QQuickSpriteEngine::isReady ( ) const

inline

Definition at line 259 of file qquickspriteengine_p.h.

References QQuickPixmap::Ready.

maxFrames()

int QQuickSpriteEngine::maxFrames

(

)

const

Definition at line 88 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_maxFrames.

restart()

void QQuickSpriteEngine::restart ( int index = 0 )

overridevirtual

Reimplemented from QQuickStochasticEngine.

Definition at line 530 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::addToUpdateList(), QList< T >::at(), QElapsedTimer::elapsed(), QQuickSprite::frameSync, QRandomGenerator::global(), i, QQuickStochasticEngine::m_addAdvance, QQuickStochasticEngine::m_advanceTimer, QQuickStochasticEngine::m_duration, QQuickStochasticEngine::m_startTimes, QQuickStochasticEngine::m_stateUpdates, QQuickStochasticEngine::m_things, QQuickStochasticEngine::m_timeOffset, NINF, spriteDuration(), and time.

Referenced by advance().

Here is the call graph for this function:

Here is the caller graph for this function:

sprite()

QQuickSprite * QQuickSpriteEngine::sprite

(

int

sprite = 0

)

const

Definition at line 246 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_things, and sprite().

Referenced by QQuickSpriteEngine(), sprite(), spriteFrames(), spriteHeight(), spriteStart(), spriteState(), spriteWidth(), spriteX(), spriteY(), and startAssemblingImage().

Here is the call graph for this function:

Here is the caller graph for this function:

spriteCount()

int QQuickSpriteEngine::spriteCount

(

)

const

Definition at line 263 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_imageStateCount.

spriteDuration()

int QQuickSpriteEngine::spriteDuration

(

int

sprite = 0

)

const

Definition at line 181 of file qquickspriteengine.cpp.

References state.

Referenced by advance(), QQuickImageParticle::initialize(), and restart().

Here is the caller graph for this function:

spriteFrames()

int QQuickSpriteEngine::spriteFrames

(

int

sprite = 0

)

const

Definition at line 154 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_duration, QQuickStochasticEngine::m_startTimes, QQuickStochasticEngine::m_things, sprite(), and state.

Referenced by QQuickImageParticle::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

spriteHeight()

int QQuickSpriteEngine::spriteHeight

(

int

sprite = 0

)

const

Definition at line 257 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_things, sprite(), and state.

Referenced by QQuickImageParticle::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

sprites()

QQmlListProperty< QQuickSprite > QQuickSpriteEngine::sprites ( )

inline

Definition at line 237 of file qquickspriteengine_p.h.

spriteStart()

int QQuickSpriteEngine::spriteStart

(

int

sprite = 0

)

const

Definition at line 140 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_duration, QQuickStochasticEngine::m_startTimes, QQuickStochasticEngine::m_things, QQuickStochasticEngine::m_timeOffset, sprite(), and state.

Referenced by advance().

Here is the call graph for this function:

Here is the caller graph for this function:

spriteState()

int QQuickSpriteEngine::spriteState

(

int

sprite = 0

)

const

Definition at line 119 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_duration, QQuickStochasticEngine::m_startTimes, QQuickStochasticEngine::m_things, sprite(), and state.

Here is the call graph for this function:

spriteWidth()

int QQuickSpriteEngine::spriteWidth

(

int

sprite = 0

)

const

Definition at line 251 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_things, sprite(), and state.

Referenced by QQuickImageParticle::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

spriteX()

int QQuickSpriteEngine::spriteX

(

int

sprite = 0

)

const

Definition at line 223 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_duration, QQuickStochasticEngine::m_startTimes, QQuickStochasticEngine::m_things, sprite(), and state.

Referenced by QQuickImageParticle::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

spriteY()

int QQuickSpriteEngine::spriteY

(

int

sprite = 0

)

const

Definition at line 201 of file qquickspriteengine.cpp.

References QQuickStochasticEngine::m_duration, QQuickStochasticEngine::m_startTimes, QQuickStochasticEngine::m_things, sprite(), and state.

Referenced by QQuickImageParticle::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

startAssemblingImage()

void QQuickSpriteEngine::startAssemblingImage

(

)

Definition at line 313 of file qquickspriteengine.cpp.

References QList< T >::clear(), QQuickStochasticEngine::m_states, qDebug, QList< T >::removeAll(), and sprite().

Here is the call graph for this function:

status()

QQuickPixmap::Status QQuickSpriteEngine::status

(

)

const

Definition at line 289 of file qquickspriteengine.cpp.

References QQuickPixmap::Error, QQuickPixmap::Loading, QQuickPixmap::Null, and QQuickPixmap::Ready.

Referenced by assembledImage().

Here is the caller graph for this function:

Property Documentation

sprites

QQmlListProperty<QQuickSprite> QQuickSpriteEngine::sprites

read

Definition at line 232 of file qquickspriteengine_p.h.

Referenced by QQuickSpriteEngine().

---

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

• qtdeclarative/src/quick/items/qquickspriteengine_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
• qtdeclarative/src/quick/items/qquickspriteengine.cpp (b899dff5d496e8bebb6bb81e37951d03f8469f63)