Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQuick3DParticleSystemLogging Class Reference

#include <qquick3dparticlesystemlogging_p.h>

+ Inheritance diagram for QQuick3DParticleSystemLogging:
+ Collaboration diagram for QQuick3DParticleSystemLogging:

Public Slots

void setLoggingInterval (int interval)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void loggingIntervalChanged ()
 
void updatesChanged ()
 
void particlesMaxChanged ()
 
void particlesUsedChanged ()
 
void timeChanged ()
 
void timeAverageChanged ()
 
 Q_REVISION (6, 3) void timeDeviationChanged()
 
- 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

 QQuick3DParticleSystemLogging (QObject *parent=nullptr)
 \qmltype ParticleSystem3DLogging \inherits QtObject \inqmlmodule QtQuick3D.Particles3D
 
int loggingInterval () const
 \qmlproperty int ParticleSystem3DLogging::loggingInterval
 
int updates () const
 \qmlproperty int ParticleSystem3DLogging::updates \readonly
 
int particlesMax () const
 \qmlproperty int ParticleSystem3DLogging::particlesMax \readonly
 
int particlesUsed () const
 \qmlproperty int ParticleSystem3DLogging::particlesUsed \readonly
 
float time () const
 \qmlproperty real ParticleSystem3DLogging::time \readonly
 
float timeAverage () const
 \qmlproperty real ParticleSystem3DLogging::timeAverage \readonly
 
 Q_REVISION (6, 3) float timeDeviation() 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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

int loggingInterval
 
int updates
 
int particlesMax
 
int particlesUsed
 
float time
 
float timeAverage
 
float timeDeviation
 \qmlproperty real ParticleSystem3DLogging::timeDeviation
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Friends

class QQuick3DParticleSystem
 

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 Member Functions inherited from QObject
QObjectsender () 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< QObjectDatad_ptr
 

Detailed Description

Definition at line 26 of file qquick3dparticlesystemlogging_p.h.

Constructor & Destructor Documentation

◆ QQuick3DParticleSystemLogging()

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

\qmltype ParticleSystem3DLogging \inherits QtObject \inqmlmodule QtQuick3D.Particles3D

Provides information of the particle system.

Since
6.2

The ParticleSystem3DLogging type provides information about particle system statistics. This element cannot be created directly, but can be retrieved from a \l ParticleSystem3D.

Definition at line 20 of file qquick3dparticlesystemlogging.cpp.

Member Function Documentation

◆ loggingInterval()

int QQuick3DParticleSystemLogging::loggingInterval ( ) const

\qmlproperty int ParticleSystem3DLogging::loggingInterval

This property defines in milliseconds how often the logging data is updated. Longer update time increases the accuracy of \l {ParticleSystem3DLogging::time}{time} and \l {ParticleSystem3DLogging::timeAverage}{timeAverage}, while shorter update times keep the data more up to date.

The default value is 1000.

Definition at line 36 of file qquick3dparticlesystemlogging.cpp.

◆ loggingIntervalChanged

void QQuick3DParticleSystemLogging::loggingIntervalChanged ( )
signal

◆ particlesMax()

int QQuick3DParticleSystemLogging::particlesMax ( ) const

\qmlproperty int ParticleSystem3DLogging::particlesMax \readonly

This property holds the maximum amount of particles in this system. Maximum amount is the sum of system particles \l {Particle3D::maxAmount}{maxAmount} properties.

Definition at line 69 of file qquick3dparticlesystemlogging.cpp.

◆ particlesMaxChanged

void QQuick3DParticleSystemLogging::particlesMaxChanged ( )
signal

◆ particlesUsed()

int QQuick3DParticleSystemLogging::particlesUsed ( ) const

\qmlproperty int ParticleSystem3DLogging::particlesUsed \readonly

This property holds the amount of particles currently in use in this system. This value should be close to \l particlesMax at some point of particle system animation. If it is much smaller, consider decreasing \l {Particle3D::maxAmount}{maxAmount} values. If it reaches \l particlesMax, particles are used effectively but it can also mean that particles are reused before they reach the end of their \l {ParticleEmitter3D::lifeSpan}{lifeSpan}. In this case, consider increasing the \l {Particle3D::maxAmount}{maxAmount} values.

Definition at line 85 of file qquick3dparticlesystemlogging.cpp.

◆ particlesUsedChanged

void QQuick3DParticleSystemLogging::particlesUsedChanged ( )
signal

◆ Q_REVISION() [1/2]

QQuick3DParticleSystemLogging::Q_REVISION ( 6 ,
3  ) const

◆ Q_REVISION [2/2]

QQuick3DParticleSystemLogging::Q_REVISION ( 6 ,
3  )
signal

◆ setLoggingInterval

void QQuick3DParticleSystemLogging::setLoggingInterval ( int interval)
slot

Definition at line 41 of file qquick3dparticlesystemlogging.cpp.

◆ time()

float QQuick3DParticleSystemLogging::time ( ) const

\qmlproperty real ParticleSystem3DLogging::time \readonly

This property holds the time in milliseconds used for emitting and animating particles in each frame.

Definition at line 97 of file qquick3dparticlesystemlogging.cpp.

◆ timeAverage()

float QQuick3DParticleSystemLogging::timeAverage ( ) const

\qmlproperty real ParticleSystem3DLogging::timeAverage \readonly

This property holds the average time in milliseconds used for emitting and animating particles in each frame. Average is calculated from the middle 50% of the past max 100 logging updates. So when \l loggingInterval is 1000, this represents an average \l time in past 100 seconds. This can be used for measuring the performance of current particle system.

Definition at line 112 of file qquick3dparticlesystemlogging.cpp.

◆ timeAverageChanged

void QQuick3DParticleSystemLogging::timeAverageChanged ( )
signal

◆ timeChanged

void QQuick3DParticleSystemLogging::timeChanged ( )
signal

◆ updates()

int QQuick3DParticleSystemLogging::updates ( ) const

\qmlproperty int ParticleSystem3DLogging::updates \readonly

This property holds the amount of particle system updates since the last logging. When loggingInterval is 1000 (default), this can be considered to match the fps.

Definition at line 57 of file qquick3dparticlesystemlogging.cpp.

◆ updatesChanged

void QQuick3DParticleSystemLogging::updatesChanged ( )
signal

Friends And Related Symbol Documentation

◆ QQuick3DParticleSystem

friend class QQuick3DParticleSystem
friend

Definition at line 66 of file qquick3dparticlesystemlogging_p.h.

Property Documentation

◆ loggingInterval

int QQuick3DParticleSystemLogging::loggingInterval
readwrite

Definition at line 29 of file qquick3dparticlesystemlogging_p.h.

◆ particlesMax

int QQuick3DParticleSystemLogging::particlesMax
read

Definition at line 31 of file qquick3dparticlesystemlogging_p.h.

◆ particlesUsed

int QQuick3DParticleSystemLogging::particlesUsed
read

Definition at line 32 of file qquick3dparticlesystemlogging_p.h.

◆ time

float QQuick3DParticleSystemLogging::time
read

Definition at line 33 of file qquick3dparticlesystemlogging_p.h.

◆ timeAverage

float QQuick3DParticleSystemLogging::timeAverage
read

Definition at line 34 of file qquick3dparticlesystemlogging_p.h.

◆ timeDeviation

float QQuick3DParticleSystemLogging::timeDeviation
read

\qmlproperty real ParticleSystem3DLogging::timeDeviation

Since
6.3 \readonly

This property holds the deviation of the average times in milliseconds. The value is the difference between maximum and minimum values of middle 50% of the results, also called interquartile range (IQR). Bigger deviation means that the times fluctuate more so \l timeAverage can be considered to be less accurate.

Definition at line 35 of file qquick3dparticlesystemlogging_p.h.

◆ updates

int QQuick3DParticleSystemLogging::updates
read

Definition at line 30 of file qquick3dparticlesystemlogging_p.h.


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