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
Public Slots | Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
QQuickParticleGroup Class Reference

#include <qquickparticlegroup_p.h>

+ Inheritance diagram for QQuickParticleGroup:
+ Collaboration diagram for QQuickParticleGroup:

Public Slots

void setSystem (QQuickParticleSystem *arg)
 
void delayRedirect (QObject *obj)
 
- Public Slots inherited from QQuickStochasticState
void setDuration (int arg)
 
void setName (const QString &arg)
 
void setTo (const QVariantMap &arg)
 
void setDurationVariation (int arg)
 
void setRandomStart (bool arg)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void systemChanged (QQuickParticleSystem *arg)
 
- Signals inherited from QQuickStochasticState
void durationChanged (int arg)
 
void nameChanged (const QString &arg)
 
void toChanged (const QVariantMap &arg)
 
void durationVariationChanged (int arg)
 
void entered ()
 
void randomStartChanged (bool arg)
 
- 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

 QQuickParticleGroup (QObject *parent=nullptr)
 \qmltype ParticleGroup \instantiates QQuickParticleGroup \inqmlmodule QtQuick.Particles
 
QQmlListProperty< QObject > particleChildren ()
 
QQuickParticleSystem * system () const
 
- Public Member Functions inherited from QQuickStochasticState
 QQuickStochasticState (QObject *parent=nullptr)
 
int duration () const
 
QString name () const
 
QVariantMap to () const
 
int durationVariation () const
 
virtual int variedDuration () const
 
bool randomStart () const
 
- 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 QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Protected Member Functions

void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
- 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)
 

Properties

QQuickParticleSystem * system
 
QQmlListProperty< QObject > particleChildren
 
- Properties inherited from QQuickStochasticState
int duration
 
int durationVariation
 
bool randomStart
 
QVariantMap to
 
QString name
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- 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 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 22 of file qquickparticlegroup_p.h.

Constructor & Destructor Documentation

◆ QQuickParticleGroup()

QQuickParticleGroup::QQuickParticleGroup ( QObject * parent = nullptr)
explicit

\qmltype ParticleGroup \instantiates QQuickParticleGroup \inqmlmodule QtQuick.Particles

For setting attributes on a logical particle group.

This element allows you to set timed transitions on particle groups.

You can also use this element to group particle system elements related to the logical particle group. Emitters, Affectors and Painters set as direct children of a ParticleGroup will automatically apply to that logical particle group. TrailEmitters will automatically follow the group.

If a ParticleGroup element is not defined for a group, the group will function normally as if none of the transition properties were set.

\qmlproperty ParticleSystem QtQuick.Particles::ParticleGroup::system This is the system which will contain the group.

If the ParticleGroup is a direct child of a ParticleSystem, it will automatically be associated with it.

\qmlproperty string QtQuick.Particles::ParticleGroup::name This is the name of the particle group, and how it is generally referred to by other elements.

If elements refer to a name which does not have an explicit ParticleGroup created, it will work normally (with no transitions specified for the group). If you do not need to assign duration based transitions to a group, you do not need to create a ParticleGroup with that name (although you may).

\qmlproperty int QtQuick.Particles::ParticleGroup::duration The time in milliseconds before the group will attempt to transition.

\qmlproperty ParticleSystem QtQuick.Particles::ParticleGroup::durationVariation The maximum number of milliseconds that the duration of the transition cycle varies per particle in the group.

Default value is zero.

\qmlproperty ParticleSystem QtQuick.Particles::ParticleGroup::to The weighted list of transitions valid for this group.

If the chosen transition stays in this group, another duration (+/- up to durationVariation) milliseconds will occur before another transition is attempted.

Definition at line 58 of file qquickparticlegroup.cpp.

Member Function Documentation

◆ classBegin()

void QQuickParticleGroup::classBegin ( )
inlineoverrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 57 of file qquickparticlegroup_p.h.

◆ componentComplete()

void QQuickParticleGroup::componentComplete ( )
overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 111 of file qquickparticlegroup.cpp.

References QObject::parent(), and setSystem().

+ Here is the call graph for this function:

◆ delayRedirect

void QQuickParticleGroup::delayRedirect ( QObject * obj)
slot

Definition at line 96 of file qquickparticlegroup.cpp.

◆ particleChildren()

QQmlListProperty< QObject > QQuickParticleGroup::particleChildren ( )

◆ setSystem

void QQuickParticleGroup::setSystem ( QQuickParticleSystem * arg)
slot

Definition at line 86 of file qquickparticlegroup.cpp.

References arg, emit, QQuickParticleSystem::registerParticleGroup(), and systemChanged().

Referenced by componentComplete().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ system()

QQuickParticleSystem * QQuickParticleGroup::system ( ) const
inline

Definition at line 40 of file qquickparticlegroup_p.h.

◆ systemChanged

void QQuickParticleGroup::systemChanged ( QQuickParticleSystem * arg)
signal

Referenced by setSystem().

+ Here is the caller graph for this function:

Property Documentation

◆ particleChildren

QQmlListProperty< QObject > QQuickParticleGroup::particleChildren
read

Definition at line 29 of file qquickparticlegroup_p.h.

◆ system

QQuickParticleSystem* QQuickParticleGroup::system
readwrite

Definition at line 26 of file qquickparticlegroup_p.h.

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