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
QQuick3DParticleModelParticle Class Reference

#include <qquick3dparticlemodelparticle_p.h>

+ Inheritance diagram for QQuick3DParticleModelParticle:
+ Collaboration diagram for QQuick3DParticleModelParticle:

Public Slots

void setDelegate (QQmlComponent *delegate)
 
- Public Slots inherited from QQuick3DParticle
void setSystem (QQuick3DParticleSystem *system)
 
void setMaxAmount (int maxAmount)
 
void setColor (QColor color)
 
void setColorVariation (QVector4D colorVariation)
 
void setUnifiedColorVariation (bool unified)
 
void setFadeInEffect (QQuick3DParticle::FadeType fadeInEffect)
 
void setFadeOutEffect (QQuick3DParticle::FadeType fadeOutEffect)
 
void setFadeInDuration (int fadeInDuration)
 
void setFadeOutDuration (int fadeOutDuration)
 
void setAlignMode (QQuick3DParticle::AlignMode alignMode)
 
void setAlignTargetPosition (const QVector3D &alignPosition)
 
void setHasTransparency (bool transparency)
 
void setSortMode (QQuick3DParticle::SortMode sortMode)
 
- Public Slots inherited from QQuick3DObject
void update ()
 
void setParentItem (QQuick3DObject *parentItem)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void delegateChanged ()
 
void instanceTableChanged ()
 
- Signals inherited from QQuick3DParticle
void systemChanged ()
 
void maxAmountChanged ()
 
void colorChanged ()
 
void colorVariationChanged ()
 
void unifiedColorVariationChanged ()
 
void fadeInEffectChanged ()
 
void fadeOutEffectChanged ()
 
void fadeInDurationChanged ()
 
void fadeOutDurationChanged ()
 
void alignModeChanged ()
 
void alignTargetPositionChanged ()
 
void hasTransparencyChanged ()
 
void sortModeChanged ()
 
- 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

 QQuick3DParticleModelParticle (QQuick3DNode *parent=nullptr)
 \qmltype ModelParticle3D \inherits Particle3D \inqmlmodule QtQuick3D.Particles3D
 
QQmlComponentdelegate () const
 \qmlproperty Component ModelParticle3D::delegate
 
QQuick3DInstancinginstanceTable () const
 \qmlproperty Instancing ModelParticle3D::instanceTable
 
- Public Member Functions inherited from QQuick3DParticle
 QQuick3DParticle (QQuick3DObject *parent=nullptr)
 \qmltype Particle3D \inherits Object3D \inqmlmodule QtQuick3D.Particles3D
 
 ~QQuick3DParticle () override
 
QQuick3DParticleSystemsystem () const
 
int maxAmount () const
 \qmlproperty int Particle3D::maxAmount
 
QColor color () const
 \qmlproperty color Particle3D::color
 
QVector4D colorVariation () const
 \qmlproperty vector4d Particle3D::colorVariation
 
bool unifiedColorVariation () const
 \qmlproperty bool Particle3D::unifiedColorVariation
 
FadeType fadeInEffect () const
 \qmlproperty enumeration Particle3D::FadeType
 
FadeType fadeOutEffect () const
 \qmlproperty FadeType Particle3D::fadeOutEffect
 
int fadeInDuration () const
 \qmlproperty int Particle3D::fadeInDuration
 
int fadeOutDuration () const
 \qmlproperty int Particle3D::fadeOutDuration
 
AlignMode alignMode () const
 \qmlproperty enumeration Particle3D::AlignMode
 
QVector3D alignTargetPosition () const
 \qmlproperty vector3d Particle3D::alignTargetPosition
 
bool hasTransparency () const
 \qmlproperty bool Particle3D::hasTransparency
 
SortMode sortMode () const
 \qmlproperty enumeration Particle3D::SortMode
 
float opacity () const
 
void resetColor ()
 
- 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 Member Functions

void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
void itemChange (ItemChange change, const ItemChangeData &value) override
 
void setDepthBias (float bias) override
 
- Protected Member Functions inherited from QQuick3DParticle
 QQuick3DParticle (QQuick3DObjectPrivate &dd, QQuick3DNode *parent=nullptr)
 
virtual void reset ()
 
virtual void doSetMaxAmount (int amount)
 
void updateBurstIndex (int amount)
 
virtual int nextCurrentIndex (const QQuick3DParticleEmitter *emitter)
 
QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) override
 
float depthBias () const
 
- Protected Member Functions inherited from QQuick3DObject
virtual void markAllDirty ()
 
 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.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Properties

QQmlComponentdelegate
 
QQuick3DInstancinginstanceTable
 
- Properties inherited from QQuick3DParticle
int maxAmount
 
QColor color
 
QVector4D colorVariation
 
bool unifiedColorVariation
 
FadeType fadeInEffect
 
FadeType fadeOutEffect
 
int fadeInDuration
 
int fadeOutDuration
 
AlignMode alignMode
 
QVector3D alignTargetPosition
 
bool hasTransparency
 
SortMode sortMode
 
- 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
 

Friends

class QQuick3DParticleSystem
 
class QQuick3DParticleEmitter
 

Additional Inherited Members

- Public Types inherited from QQuick3DParticle
enum  FadeType { FadeNone , FadeOpacity , FadeScale }
 
enum  AlignMode { AlignNone , AlignTowardsTarget , AlignTowardsStartVelocity }
 
enum  SortMode { SortNone , SortNewest , SortOldest , SortDistance }
 
- 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 QQuick3DParticle
QList< QQuick3DParticleDatam_particleData
 
QQuick3DParticleSpriteSequencem_spriteSequence = nullptr
 
int m_maxAmount = 100
 
int m_currentIndex = -1
 
int m_lastBurstIndex = 0
 
AlignMode m_alignMode = AlignNone
 
QVector3D m_alignTarget
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 36 of file qquick3dparticlemodelparticle_p.h.

Constructor & Destructor Documentation

◆ QQuick3DParticleModelParticle()

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

\qmltype ModelParticle3D \inherits Particle3D \inqmlmodule QtQuick3D.Particles3D

Particle using a Qt Quick 3D Model.

Since
6.2

The ModelParticle3D is a logical particle element that creates particles from a Qt Quick 3D \l Model component.

Definition at line 19 of file qquick3dparticlemodelparticle.cpp.

References QObject::connect(), QQuick3DParticle::m_maxAmount, QQuick3DParticle::maxAmountChanged(), QQuick3DParticle::sortMode, and QQuick3DParticle::sortModeChanged().

+ Here is the call graph for this function:

Member Function Documentation

◆ componentComplete()

void QQuick3DParticleModelParticle::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.

Reimplemented from QQuick3DParticle.

Definition at line 278 of file qquick3dparticlemodelparticle.cpp.

References QQuick3DParticle::componentComplete(), QQuick3DParticle::setSystem(), and QQuick3DParticle::system().

+ Here is the call graph for this function:

◆ delegate()

QQmlComponent * QQuick3DParticleModelParticle::delegate ( ) const

\qmlproperty Component ModelParticle3D::delegate

The delegate provides a template defining each object instantiated by the particle.

For example, to allocate 200 red cube particles:

\qml Component { id: particleComponent Model { source: "#Cube" scale: Qt.vector3d(0.2, 0.2, 0.2) materials: DefaultMaterial { } } }

ModelParticle3D { id: particleRed delegate: particleComponent maxAmount: 200 color: "#ff0000" } \endqml

Definition at line 65 of file qquick3dparticlemodelparticle.cpp.

References QPointer< T >::data().

+ Here is the call graph for this function:

◆ delegateChanged

void QQuick3DParticleModelParticle::delegateChanged ( )
signal

Referenced by setDelegate().

+ Here is the caller graph for this function:

◆ instanceTable()

QQuick3DInstancing * QQuick3DParticleModelParticle::instanceTable ( ) const

\qmlproperty Instancing ModelParticle3D::instanceTable

The instanceTable provides access to the \l Instancing table of the model particle. ModelParticle3D uses an internal instance table to implement efficient rendering. This table can be applied to the \l{Model::instancing}{instancing} property of models that are not part of the particle system.

It is also possible to use this feature to provide an instancing table without showing any particles. This is done by omitting the \l delegate property. For example:

\qml ParticleSystem3D { id: psystem ModelParticle3D { id: particleRed maxAmount: 200 color: "#ff0000" colorVariation: Qt.vector4d(0.5,0.5,0.5,0.5) }

ParticleEmitter3D { particle: particleRed velocity: VectorDirection3D { direction: Qt.vector3d(-20, 200, 0) directionVariation: Qt.vector3d(20, 20, 20) } particleScale: 0.2 emitRate: 20 lifeSpan: 2000 } }

Model { source: "#Sphere" instancing: particleRed.instanceTable materials: PrincipledMaterial { baseColor: "yellow" } } \endqml

Definition at line 200 of file qquick3dparticlemodelparticle.cpp.

◆ instanceTableChanged

void QQuick3DParticleModelParticle::instanceTableChanged ( )
signal

◆ itemChange()

void QQuick3DParticleModelParticle::itemChange ( ItemChange change,
const ItemChangeData & value )
overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 287 of file qquick3dparticlemodelparticle.cpp.

References QQuick3DObject::itemChange().

+ Here is the call graph for this function:

◆ setDelegate

void QQuick3DParticleModelParticle::setDelegate ( QQmlComponent * delegate)
slot

Definition at line 70 of file qquick3dparticlemodelparticle.cpp.

References delegate, delegateChanged(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setDepthBias()

void QQuick3DParticleModelParticle::setDepthBias ( float bias)
inlineoverrideprotectedvirtual

Reimplemented from QQuick3DParticle.

Definition at line 63 of file qquick3dparticlemodelparticle_p.h.

References QQuick3DParticle::setDepthBias().

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QQuick3DParticleEmitter

friend class QQuick3DParticleEmitter
friend

Definition at line 75 of file qquick3dparticlemodelparticle_p.h.

◆ QQuick3DParticleSystem

friend class QQuick3DParticleSystem
friend

Definition at line 74 of file qquick3dparticlemodelparticle_p.h.

Property Documentation

◆ delegate

QQmlComponent * QQuick3DParticleModelParticle::delegate
readwrite

Definition at line 39 of file qquick3dparticlemodelparticle_p.h.

Referenced by setDelegate().

◆ instanceTable

QQuick3DInstancing * QQuick3DParticleModelParticle::instanceTable
read

Definition at line 40 of file qquick3dparticlemodelparticle_p.h.


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