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
QQuick3DParticleAffector Class Referenceabstract

#include <qquick3dparticleaffector_p.h>

+ Inheritance diagram for QQuick3DParticleAffector:
+ Collaboration diagram for QQuick3DParticleAffector:

Public Slots

void setSystem (QQuick3DParticleSystem *system)
 
void setEnabled (bool enabled)
 
- Public Slots inherited from QQuick3DNode
void setX (float x)
 
void setY (float y)
 
void setZ (float z)
 
void setRotation (const QQuaternion &rotation)
 
void setEulerRotation (const QVector3D &eulerRotation)
 
void setPosition (const QVector3D &position)
 
void setScale (const QVector3D &scale)
 
void setPivot (const QVector3D &pivot)
 
void setLocalOpacity (float opacity)
 
void setVisible (bool visible)
 
void setStaticFlags (int staticFlags)
 
- Public Slots inherited from QQuick3DObject
void update ()
 
void setParentItem (QQuick3DObject *parentItem)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void update ()
 
void systemChanged ()
 
void enabledChanged ()
 
- Signals inherited from QQuick3DNode
void xChanged ()
 
void yChanged ()
 
void zChanged ()
 
void rotationChanged ()
 
void eulerRotationChanged ()
 
void positionChanged ()
 
void scaleChanged ()
 
void pivotChanged ()
 
void localOpacityChanged ()
 
void visibleChanged ()
 
void forwardChanged ()
 
void upChanged ()
 
void rightChanged ()
 
void sceneTransformChanged ()
 
void scenePositionChanged ()
 
void sceneRotationChanged ()
 
void sceneScaleChanged ()
 
void staticFlagsChanged ()
 
- Signals inherited from QQuick3DObject
void parentChanged ()
 
void childrenChanged ()
 
void stateChanged ()
 
- 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

 QQuick3DParticleAffector (QQuick3DNode *parent=nullptr)
 \qmltype Affector3D \inherits Node \inqmlmodule QtQuick3D.Particles3D
 
 ~QQuick3DParticleAffector () override
 
QQuick3DParticleSystemsystem () const
 \qmlproperty ParticleSystem3D Affector3D::system
 
bool enabled () const
 \qmlproperty bool Affector3D::enabled
 
QQmlListProperty< QQuick3DParticleparticles ()
 
void appendParticle (QQuick3DParticle *)
 
qsizetype particleCount () const
 
QQuick3DParticleparticle (qsizetype) const
 
void clearParticles ()
 
void replaceParticle (qsizetype, QQuick3DParticle *)
 
void removeLastParticle ()
 
- Public Member Functions inherited from QQuick3DNode
 QQuick3DNode (QQuick3DNode *parent=nullptr)
 \qmltype Node \inherits Object3D \inqmlmodule QtQuick3D
 
 ~QQuick3DNode () override
 
float x () const
 \qmlproperty real QtQuick3D::Node::x
 
float y () const
 \qmlproperty real QtQuick3D::Node::y
 
float z () const
 \qmlproperty real QtQuick3D::Node::z
 
QQuaternion rotation () const
 \qmlproperty quaternion QtQuick3D::Node::rotation
 
QVector3D eulerRotation () const
 \qmlproperty vector3d QtQuick3D::Node::eulerRotation
 
QVector3D position () const
 \qmlproperty vector3d QtQuick3D::Node::position
 
QVector3D scale () const
 \qmlproperty vector3d QtQuick3D::Node::scale
 
QVector3D pivot () const
 \qmlproperty vector3d QtQuick3D::Node::pivot
 
float localOpacity () const
 \qmlproperty real QtQuick3D::Node::opacity
 
bool visible () const
 \qmlproperty bool QtQuick3D::Node::visible
 
int staticFlags () const
 \qmlproperty int QtQuick3D::Node::staticFlags
 
QQuick3DNodeparentNode () const
 
QVector3D forward () const
 \qmlproperty vector3d QtQuick3D::Node::forward \readonly
 
QVector3D up () const
 \qmlproperty vector3d QtQuick3D::Node::up \readonly
 
QVector3D right () const
 \qmlproperty vector3d QtQuick3D::Node::right \readonly
 
QVector3D scenePosition () const
 \qmlproperty vector3d QtQuick3D::Node::scenePosition \readonly
 
QQuaternion sceneRotation () const
 \qmlproperty quaternion QtQuick3D::Node::sceneRotation \readonly
 
QVector3D sceneScale () const
 \qmlproperty vector3d QtQuick3D::Node::sceneScale \readonly
 
QMatrix4x4 sceneTransform () const
 \qmlproperty matrix4x4 QtQuick3D::Node::sceneTransform \readonly
 
Q_INVOKABLE void rotate (qreal degrees, const QVector3D &axis, QQuick3DNode::TransformSpace space)
 \qmlmethod QtQuick3D::Node::rotate(real degrees, vector3d axis, enumeration space)
 
Q_INVOKABLE QVector3D mapPositionToScene (const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionToScene(vector3d localPosition)
 
Q_INVOKABLE QVector3D mapPositionFromScene (const QVector3D &scenePosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionFromScene(vector3d scenePosition)
 
Q_INVOKABLE QVector3D mapPositionToNode (const QQuick3DNode *node, const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionToNode(QtQuick3D::Node node, vector3d localPosition)
 
Q_INVOKABLE QVector3D mapPositionFromNode (const QQuick3DNode *node, const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionFromNode(QtQuick3D::Node node, vector3d localPosition)
 
Q_INVOKABLE QVector3D mapDirectionToScene (const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionToScene(vector3d localDirection)
 
Q_INVOKABLE QVector3D mapDirectionFromScene (const QVector3D &sceneDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionFromScene(vector3d sceneDirection)
 
Q_INVOKABLE QVector3D mapDirectionToNode (const QQuick3DNode *node, const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionToNode(QtQuick3D::Node node, vector3d localDirection)
 
Q_INVOKABLE QVector3D mapDirectionFromNode (const QQuick3DNode *node, const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionFromNode(QtQuick3D::Node node, vector3d localDirection)
 
void markAllDirty () override
 
- 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Protected Attributes

QList< QQuick3DParticle * > m_particles
 
QQuick3DNodem_systemSharedParent = nullptr
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Properties

QQuick3DParticleSystemsystem
 
QQmlListProperty< QQuick3DParticleparticles
 \qmlproperty List<Particle3D> Affector3D::particles
 
bool enabled
 
- Properties inherited from QQuick3DNode
float x
 
float y
 
float z
 
QQuaternion rotation
 
QVector3D eulerRotation
 
QVector3D position
 
QVector3D scale
 
QVector3D pivot
 
float opacity
 
bool visible
 
QVector3D forward
 
QVector3D up
 
QVector3D right
 
QVector3D scenePosition
 
QQuaternion sceneRotation
 
QVector3D sceneScale
 
QMatrix4x4 sceneTransform
 
int staticFlags
 
- Properties inherited from QQuick3DObject
QQuick3DObjectparent
 \qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Private Member Functions

void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
virtual void prepareToAffect ()
 
virtual void affectParticle (const QQuick3DParticleData &sd, QQuick3DParticleDataCurrent *d, float time)=0
 

Friends

class QQuick3DParticleSystem
 

Additional Inherited Members

- Public Types inherited from QQuick3DNode
enum  TransformSpace { LocalSpace , ParentSpace , SceneSpace }
 
enum  StaticFlags { None }
 
- 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 QQuick3DNode
void connectNotify (const QMetaMethod &signal) override
 
void disconnectNotify (const QMetaMethod &signal) override
 
 QQuick3DNode (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
 
QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) override
 
virtual void itemChange (ItemChange, const ItemChangeData &) override
 
- Protected Member Functions inherited from QQuick3DObject
 QQuick3DObject (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
bool isComponentComplete () const
 
virtual void preSync ()
 
- 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.
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Detailed Description

Definition at line 28 of file qquick3dparticleaffector_p.h.

Constructor & Destructor Documentation

◆ QQuick3DParticleAffector()

QT_BEGIN_NAMESPACE QQuick3DParticleAffector::QQuick3DParticleAffector ( QQuick3DNode * parent = nullptr)

\qmltype Affector3D \inherits Node \inqmlmodule QtQuick3D.Particles3D

Affectors modify the attributes of particles during their lifetime.

Since
6.2

The Affector3D is an abstract base class of affectors like \l Gravity3D, \l Wander3D, and \l PointRotator3D.

By default affectors affect all particles in the system, but this can be limited by defining the \l particles list. If the system has multiple affectors, the order of affectors may result in different outcome, as affectors are applied one after another.

Definition at line 23 of file qquick3dparticleaffector.cpp.

◆ ~QQuick3DParticleAffector()

QQuick3DParticleAffector::~QQuick3DParticleAffector ( )
override

Definition at line 28 of file qquick3dparticleaffector.cpp.

References connection, QObject::disconnect(), and QQuick3DParticleSystem::unRegisterParticleAffector().

+ Here is the call graph for this function:

Member Function Documentation

◆ affectParticle()

virtual void QQuick3DParticleAffector::affectParticle ( const QQuick3DParticleData & sd,
QQuick3DParticleDataCurrent * d,
float time )
privatepure virtual

◆ appendParticle()

void QQuick3DParticleAffector::appendParticle ( QQuick3DParticle * n)

Definition at line 117 of file qquick3dparticleaffector.cpp.

References QList< T >::append(), QObject::connect(), QObject::destroyed(), QObject::disconnect(), QMap< Key, T >::insert(), m_particles, particle(), QMap< Key, T >::remove(), and QList< T >::removeAll().

+ Here is the call graph for this function:

◆ clearParticles()

void QQuick3DParticleAffector::clearParticles ( )

Definition at line 137 of file qquick3dparticleaffector.cpp.

References QList< T >::clear(), and m_particles.

+ Here is the call graph for this function:

◆ componentComplete()

void QQuick3DParticleAffector::componentComplete ( )
overrideprivatevirtual

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.

Reimplemented from QQuick3DNode.

Definition at line 88 of file qquick3dparticleaffector.cpp.

References QQuick3DObject::parent, and setSystem().

+ Here is the call graph for this function:

◆ enabled()

bool QQuick3DParticleAffector::enabled ( ) const

\qmlproperty bool Affector3D::enabled

If enabled is set to false, this affector will not alter any particles. Usually this is used to conditionally turn an affector on or off.

The default value is true.

Definition at line 73 of file qquick3dparticleaffector.cpp.

◆ enabledChanged

void QQuick3DParticleAffector::enabledChanged ( )
signal

Referenced by setEnabled().

+ Here is the caller graph for this function:

◆ particle()

QQuick3DParticle * QQuick3DParticleAffector::particle ( qsizetype index) const

Definition at line 132 of file qquick3dparticleaffector.cpp.

References QList< T >::at(), and m_particles.

Referenced by appendParticle(), and replaceParticle().

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

◆ particleCount()

qsizetype QQuick3DParticleAffector::particleCount ( ) const

Definition at line 127 of file qquick3dparticleaffector.cpp.

References m_particles, and QList< T >::size().

+ Here is the call graph for this function:

◆ particles()

QQmlListProperty< QQuick3DParticle > QQuick3DParticleAffector::particles ( )

◆ prepareToAffect()

void QQuick3DParticleAffector::prepareToAffect ( )
privatevirtual

◆ removeLastParticle()

void QQuick3DParticleAffector::removeLastParticle ( )

Definition at line 155 of file qquick3dparticleaffector.cpp.

References QObject::disconnect(), QList< T >::last(), m_particles, QMap< Key, T >::remove(), and QList< T >::removeLast().

+ Here is the call graph for this function:

◆ replaceParticle()

void QQuick3DParticleAffector::replaceParticle ( qsizetype index,
QQuick3DParticle * n )

Definition at line 141 of file qquick3dparticleaffector.cpp.

References QObject::connect(), QObject::destroyed(), QObject::disconnect(), QMap< Key, T >::insert(), m_particles, particle(), remove(), QMap< Key, T >::remove(), and QList< T >::removeAll().

+ Here is the call graph for this function:

◆ setEnabled

void QQuick3DParticleAffector::setEnabled ( bool enabled)
slot

Definition at line 78 of file qquick3dparticleaffector.cpp.

References enabled, enabledChanged(), Q_EMIT, and update().

+ Here is the call graph for this function:

◆ setSystem

void QQuick3DParticleAffector::setSystem ( QQuick3DParticleSystem * system)
slot

Definition at line 47 of file qquick3dparticleaffector.cpp.

References getSharedParentNode(), m_systemSharedParent, Q_EMIT, QQuick3DParticleSystem::registerParticleAffector(), system, systemChanged(), QQuick3DParticleSystem::unRegisterParticleAffector(), and update().

Referenced by componentComplete().

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

◆ system()

QQuick3DParticleSystem * QQuick3DParticleAffector::system ( ) const

\qmlproperty ParticleSystem3D Affector3D::system

This property defines the \l ParticleSystem3D for the affector. If system is direct parent of the affector, this property does not need to be defined.

Definition at line 42 of file qquick3dparticleaffector.cpp.

◆ systemChanged

void QQuick3DParticleAffector::systemChanged ( )
signal

Referenced by setSystem().

+ Here is the caller graph for this function:

◆ update

Friends And Related Symbol Documentation

◆ QQuick3DParticleSystem

friend class QQuick3DParticleSystem
friend

Definition at line 68 of file qquick3dparticleaffector_p.h.

Member Data Documentation

◆ m_particles

QList<QQuick3DParticle *> QQuick3DParticleAffector::m_particles
protected

◆ m_systemSharedParent

QQuick3DNode* QQuick3DParticleAffector::m_systemSharedParent = nullptr
protected

Property Documentation

◆ enabled

bool QQuick3DParticleAffector::enabled
readwrite

Definition at line 33 of file qquick3dparticleaffector_p.h.

Referenced by setEnabled().

◆ particles

QQmlListProperty< QQuick3DParticle > QQuick3DParticleAffector::particles
read

\qmlproperty List<Particle3D> Affector3D::particles

This list controls which logical particles will be affected. When empty, all particles in the system are affected.

Definition at line 32 of file qquick3dparticleaffector_p.h.

◆ system

QQuick3DParticleSystem * QQuick3DParticleAffector::system
readwrite

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