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

#include <qquick3dparticlespriteparticle_p.h>

+ Inheritance diagram for QQuick3DParticleSpriteParticle:
+ Collaboration diagram for QQuick3DParticleSpriteParticle:

Classes

class  ParticleUpdateNode
 
struct  PerEmitterData
 
struct  SpriteParticleData
 

Public Types

enum  BlendMode { SourceOver = 0 , Screen , Multiply }
 
enum  FeatureLevel {
  Simple = 0 , Mapped , Animated , SimpleVLight ,
  MappedVLight , AnimatedVLight
}
 
- Public Types inherited from QQuick3DParticle
enum  FadeType { FadeNone , FadeOpacity , FadeScale }
 
enum  AlignMode { AlignNone , AlignTowardsTarget , AlignTowardsStartVelocity }
 
enum  SortMode { SortNone , SortNewest , SortOldest , SortDistance }
 

Public Slots

void setBlendMode (QQuick3DParticleSpriteParticle::BlendMode blendMode)
 
void setSprite (QQuick3DTexture *sprite)
 
void setSpriteSequence (QQuick3DParticleSpriteSequence *spriteSequence)
 
void setBillboard (bool billboard)
 
void setParticleScale (float scale)
 
void setColorTable (QQuick3DTexture *colorTable)
 
void setOffsetX (float value)
 
void setOffsetY (float value)
 
 Q_REVISION (6, 4) void setCastsReflections(bool castsReflections)
 
- 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 blendModeChanged ()
 
void spriteChanged ()
 
void spriteSequenceChanged ()
 
void billboardChanged ()
 
void particleScaleChanged ()
 
void colorTableChanged ()
 
 Q_REVISION (6, 3) void lightsChanged()
 
 Q_REVISION (6, 3) void offsetXChanged()
 
 Q_REVISION (6, 3) void offsetYChanged()
 
 Q_REVISION (6, 4) void castsReflectionsChanged()
 
- 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

 QQuick3DParticleSpriteParticle (QQuick3DNode *parent=nullptr)
 \qmltype SpriteParticle3D \inherits Particle3D \inqmlmodule QtQuick3D.Particles3D
 
 ~QQuick3DParticleSpriteParticle () override
 
BlendMode blendMode () const
 \qmlproperty enumeration SpriteParticle3D::BlendMode
 
QQuick3DTexturesprite () const
 \qmlproperty Texture SpriteParticle3D::sprite
 
QQuick3DParticleSpriteSequencespriteSequence () const
 \qmlproperty SpriteSequence3D SpriteParticle3D::spriteSequence
 
bool billboard () const
 \qmlproperty bool SpriteParticle3D::billboard
 
float particleScale () const
 \qmlproperty real SpriteParticle3D::particleScale
 
QQuick3DTexturecolorTable () const
 \qmlproperty Texture SpriteParticle3D::colorTable
 
 Q_REVISION (6, 3) QQmlListProperty< QQuick3DAbstractLight > lights()
 
float offsetX () const
 \qmlproperty float SpriteParticle3D::offsetX
 
float offsetY () const
 \qmlproperty float SpriteParticle3D::offsetY
 
 Q_REVISION (6, 4) bool castsReflections() const
 
PerEmitterDataperEmitterData (const QQuick3DNode *updateNode)
 
PerEmitterDataperEmitterData (int emitterIndex)
 
QSSGRenderGraphObjectupdateParticleNode (const ParticleUpdateNode *updateNode, QSSGRenderGraphObject *node)
 
- 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 itemChange (ItemChange, const ItemChangeData &) override
 
void reset () override
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
int nextCurrentIndex (const QQuick3DParticleEmitter *emitter) override
 
virtual void setParticleData (int particleIndex, const QVector3D &position, const QVector3D &rotation, const QVector4D &color, float size, float age, float animationFrame)
 
virtual void resetParticleData (int particleIndex)
 
virtual void commitParticles (float)
 
void setDepthBias (float bias) override
 
virtual void handleMaxAmountChanged (int amount)
 
virtual void handleSystemChanged (QQuick3DParticleSystem *system)
 
void updateNodes ()
 
void deleteNodes ()
 
void markNodesDirty ()
 
- Protected Member Functions inherited from QQuick3DParticle
 QQuick3DParticle (QQuick3DObjectPrivate &dd, QQuick3DNode *parent=nullptr)
 
virtual void doSetMaxAmount (int amount)
 
void updateBurstIndex (int amount)
 
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)
 

Protected Attributes

QMap< const QQuick3DParticleEmitter *, PerEmitterDatam_perEmitterData
 
QVector< SpriteParticleDatam_spriteParticleData
 
int m_nextEmitterIndex = 0
 
FeatureLevel m_featureLevel = FeatureLevel::Simple
 
- 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
 

Properties

BlendMode blendMode
 
QQuick3DTexturesprite
 
QQuick3DParticleSpriteSequencespriteSequence
 
bool billboard
 
float particleScale
 
QQuick3DTexturecolorTable
 
QQmlListProperty< QQuick3DAbstractLightlights
 \qmlproperty list<Light> SpriteParticle3D::lights
 
float offsetX
 
float offsetY
 
bool castsReflections
 \qmlproperty bool SpriteParticle3D::castsReflections
 
- 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
 
class QQuick3DParticleSpriteSequence
 
class ParticleUpdateNode
 

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)
 

Detailed Description

Definition at line 31 of file qquick3dparticlespriteparticle_p.h.

Member Enumeration Documentation

◆ BlendMode

Enumerator
SourceOver 
Screen 
Multiply 

Definition at line 48 of file qquick3dparticlespriteparticle_p.h.

◆ FeatureLevel

Enumerator
Simple 
Mapped 
Animated 
SimpleVLight 
MappedVLight 
AnimatedVLight 

Definition at line 115 of file qquick3dparticlespriteparticle_p.h.

Constructor & Destructor Documentation

◆ QQuick3DParticleSpriteParticle()

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

\qmltype SpriteParticle3D \inherits Particle3D \inqmlmodule QtQuick3D.Particles3D

Particle using a 2D sprite texture.

Since
6.2

The SpriteParticle3D is a logical particle element that creates particles from a 2D sprite texture.

Definition at line 24 of file qquick3dparticlespriteparticle.cpp.

References QObject::connect(), handleMaxAmountChanged(), handleSystemChanged(), QHash< Key, T >::insert(), QQuick3DParticle::m_maxAmount, markNodesDirty(), QQuick3DParticle::maxAmountChanged(), QQuick3DParticle::sortModeChanged(), QQuick3DParticle::system(), and QQuick3DParticle::systemChanged().

+ Here is the call graph for this function:

◆ ~QQuick3DParticleSpriteParticle()

QQuick3DParticleSpriteParticle::~QQuick3DParticleSpriteParticle ( )
override

Definition at line 38 of file qquick3dparticlespriteparticle.cpp.

References connection, deleteNodes(), QObject::disconnect(), lights, and QQuick3DParticle::m_spriteSequence.

+ Here is the call graph for this function:

Member Function Documentation

◆ billboard()

bool QQuick3DParticleSpriteParticle::billboard ( ) const

\qmlproperty bool SpriteParticle3D::billboard

This property defines if the particle texture should always be aligned face towards the screen.

Note
When set to true, \l Particle3D \l {Particle3D::alignMode}{alignMode} property does not have an effect.

The default value is false.

Definition at line 130 of file qquick3dparticlespriteparticle.cpp.

◆ billboardChanged

void QQuick3DParticleSpriteParticle::billboardChanged ( )
signal

Referenced by setBillboard().

+ Here is the caller graph for this function:

◆ blendMode()

QQuick3DParticleSpriteParticle::BlendMode QQuick3DParticleSpriteParticle::blendMode ( ) const

\qmlproperty enumeration SpriteParticle3D::BlendMode

Defines the blending mode for the particles.

\value SpriteParticle3D.SourceOver Blend particles with SourceOver mode. \value SpriteParticle3D.Screen Blend particles with Screen mode. \value SpriteParticle3D.Multiply Blend particles with Multiply mode.

\qmlproperty BlendMode SpriteParticle3D::blendMode

This property defines the blending mode used for rendering the particles.

The default value is SpriteParticle3D.SourceOver.

Definition at line 79 of file qquick3dparticlespriteparticle.cpp.

◆ blendModeChanged

void QQuick3DParticleSpriteParticle::blendModeChanged ( )
signal

Referenced by setBlendMode().

+ Here is the caller graph for this function:

◆ colorTable()

QQuick3DTexture * QQuick3DParticleSpriteParticle::colorTable ( ) const

\qmlproperty Texture SpriteParticle3D::colorTable

This property defines the \l Texture used for coloring the particles. The image can be a 1D or a 2D texture. Horizontal pixels determine the particle color over its \l {ParticleEmitter3D::lifeSpan}{lifeSpan}. For example, when the particle is halfway through its life, it will have the color specified halfway across the image. If the image is 2D, vertical row is randomly selected for each particle. For example, a c {256 x 4} image contains 4 different coloring options for particles.

Definition at line 162 of file qquick3dparticlespriteparticle.cpp.

◆ colorTableChanged

void QQuick3DParticleSpriteParticle::colorTableChanged ( )
signal

Referenced by setColorTable().

+ Here is the caller graph for this function:

◆ commitParticles()

void QQuick3DParticleSpriteParticle::commitParticles ( float )
protectedvirtual

Reimplemented in QQuick3DParticleLineParticle.

Definition at line 511 of file qquick3dparticlespriteparticle.cpp.

References QQuick3DObject::markAllDirty(), QQuick3DObject::update(), and updateNodes().

Referenced by QQuick3DParticleLineParticle::commitParticles().

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

◆ componentComplete()

void QQuick3DParticleSpriteParticle::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 495 of file qquick3dparticlespriteparticle.cpp.

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

+ Here is the call graph for this function:

◆ deleteNodes()

void QQuick3DParticleSpriteParticle::deleteNodes ( )
protected

Definition at line 50 of file qquick3dparticlespriteparticle.cpp.

References QMap< Key, T >::clear(), and m_perEmitterData.

Referenced by ~QQuick3DParticleSpriteParticle(), and reset().

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

◆ handleMaxAmountChanged()

void QQuick3DParticleSpriteParticle::handleMaxAmountChanged ( int amount)
protectedvirtual

Reimplemented in QQuick3DParticleLineParticle.

Definition at line 445 of file qquick3dparticlespriteparticle.cpp.

References QQuick3DParticle::m_particleData, m_spriteParticleData, reset(), QList< T >::resize(), and QList< T >::size().

Referenced by QQuick3DParticleSpriteParticle(), and QQuick3DParticleLineParticle::handleMaxAmountChanged().

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

◆ handleSystemChanged()

void QQuick3DParticleSpriteParticle::handleSystemChanged ( QQuick3DParticleSystem * system)
protectedvirtual

Reimplemented in QQuick3DParticleLineParticle.

Definition at line 455 of file qquick3dparticlespriteparticle.cpp.

References m_perEmitterData, ParticleUpdateNode, and QQuick3DParticle::system().

Referenced by QQuick3DParticleSpriteParticle().

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

◆ itemChange()

void QQuick3DParticleSpriteParticle::itemChange ( ItemChange ,
const ItemChangeData &  )
overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 310 of file qquick3dparticlespriteparticle.cpp.

◆ markNodesDirty()

void QQuick3DParticleSpriteParticle::markNodesDirty ( )
protected

Definition at line 470 of file qquick3dparticlespriteparticle.cpp.

References m_perEmitterData.

Referenced by QQuick3DParticleSpriteParticle(), setBillboard(), setBlendMode(), setColorTable(), setParticleScale(), setSprite(), and setSpriteSequence().

+ Here is the caller graph for this function:

◆ nextCurrentIndex()

int QQuick3DParticleSpriteParticle::nextCurrentIndex ( const QQuick3DParticleEmitter * emitter)
overrideprotectedvirtual

Reimplemented from QQuick3DParticle.

Definition at line 518 of file qquick3dparticlespriteparticle.cpp.

References QMap< Key, T >::contains(), QMap< Key, T >::insert(), m_nextEmitterIndex, m_perEmitterData, m_spriteParticleData, QQuick3DParticle::nextCurrentIndex(), QQuick3DParticleSpriteParticle::PerEmitterData::particleCount, ParticleUpdateNode, perEmitterData(), and QQuick3DParticle::system().

Referenced by QQuick3DParticleLineParticle::nextCurrentIndex().

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

◆ offsetX()

float QQuick3DParticleSpriteParticle::offsetX ( ) const

\qmlproperty float SpriteParticle3D::offsetX

Since
6.3

This property defines the particles offset in the X axis

Definition at line 193 of file qquick3dparticlespriteparticle.cpp.

References QVector3D::x().

+ Here is the call graph for this function:

◆ offsetY()

float QQuick3DParticleSpriteParticle::offsetY ( ) const

\qmlproperty float SpriteParticle3D::offsetY

Since
6.3

This property defines the particles offset in the Y axis

Definition at line 204 of file qquick3dparticlespriteparticle.cpp.

References QVector3D::y().

+ Here is the call graph for this function:

◆ particleScale()

float QQuick3DParticleSpriteParticle::particleScale ( ) const

\qmlproperty real SpriteParticle3D::particleScale

This property defines the scale multiplier of the particles. To adjust the particles sizes in the emitter, use \ ParticleEmitter3D \l {ParticleEmitter3D::particleScale}{particleScale}, \l {ParticleEmitter3D::particleEndScale}{particleEndScale}, and \l {ParticleEmitter3D::particleScaleVariation}{particleScaleVariation} properties.

The default value is 5.0.

Definition at line 147 of file qquick3dparticlespriteparticle.cpp.

◆ particleScaleChanged

void QQuick3DParticleSpriteParticle::particleScaleChanged ( )
signal

Referenced by setParticleScale().

+ Here is the caller graph for this function:

◆ perEmitterData() [1/2]

QQuick3DParticleSpriteParticle::PerEmitterData & QQuick3DParticleSpriteParticle::perEmitterData ( const QQuick3DNode * updateNode)

Definition at line 369 of file qquick3dparticlespriteparticle.cpp.

References m_perEmitterData.

Referenced by nextCurrentIndex(), and updateParticleNode().

+ Here is the caller graph for this function:

◆ perEmitterData() [2/2]

QQuick3DParticleSpriteParticle::PerEmitterData & QQuick3DParticleSpriteParticle::perEmitterData ( int emitterIndex)

Definition at line 378 of file qquick3dparticlespriteparticle.cpp.

References m_perEmitterData.

◆ Q_REVISION() [1/7]

QQuick3DParticleSpriteParticle::Q_REVISION ( 6 ,
3  )

◆ Q_REVISION [2/7]

QQuick3DParticleSpriteParticle::Q_REVISION ( 6 ,
3  )
signal

◆ Q_REVISION [3/7]

QQuick3DParticleSpriteParticle::Q_REVISION ( 6 ,
3  )
signal

◆ Q_REVISION [4/7]

QQuick3DParticleSpriteParticle::Q_REVISION ( 6 ,
3  )
signal

◆ Q_REVISION() [5/7]

QQuick3DParticleSpriteParticle::Q_REVISION ( 6 ,
4  ) const

◆ Q_REVISION [6/7]

QQuick3DParticleSpriteParticle::Q_REVISION ( 6 ,
4  )
signal

◆ Q_REVISION [7/7]

QQuick3DParticleSpriteParticle::Q_REVISION ( 6 ,
4  )
slot

◆ reset()

void QQuick3DParticleSpriteParticle::reset ( )
overrideprotectedvirtual

Reimplemented from QQuick3DParticle.

Definition at line 503 of file qquick3dparticlespriteparticle.cpp.

References deleteNodes(), m_nextEmitterIndex, m_spriteParticleData, and QQuick3DParticle::reset().

Referenced by handleMaxAmountChanged(), and QQuick3DParticleLineParticle::reset().

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

◆ resetParticleData()

void QQuick3DParticleSpriteParticle::resetParticleData ( int particleIndex)
protectedvirtual

Reimplemented in QQuick3DParticleLineParticle.

Definition at line 550 of file qquick3dparticlespriteparticle.cpp.

References m_spriteParticleData.

Referenced by QQuick3DParticleLineParticle::resetParticleData().

+ Here is the caller graph for this function:

◆ setBillboard

void QQuick3DParticleSpriteParticle::setBillboard ( bool billboard)
slot

Definition at line 253 of file qquick3dparticlespriteparticle.cpp.

References billboard, billboardChanged(), markNodesDirty(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setBlendMode

void QQuick3DParticleSpriteParticle::setBlendMode ( QQuick3DParticleSpriteParticle::BlendMode blendMode)
slot

Definition at line 221 of file qquick3dparticlespriteparticle.cpp.

References blendMode, blendModeChanged(), markNodesDirty(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setColorTable

void QQuick3DParticleSpriteParticle::setColorTable ( QQuick3DTexture * colorTable)
slot

Definition at line 271 of file qquick3dparticlespriteparticle.cpp.

References QQuick3DObjectPrivate::attachWatcher(), colorTable, colorTableChanged(), markNodesDirty(), Q_EMIT, and setColorTable().

Referenced by setColorTable().

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

◆ setDepthBias()

void QQuick3DParticleSpriteParticle::setDepthBias ( float bias)
inlineoverrideprotectedvirtual

Reimplemented from QQuick3DParticle.

Definition at line 101 of file qquick3dparticlespriteparticle_p.h.

References QQuick3DParticle::setDepthBias().

+ Here is the call graph for this function:

◆ setOffsetX

void QQuick3DParticleSpriteParticle::setOffsetX ( float value)
slot

Definition at line 284 of file qquick3dparticlespriteparticle.cpp.

References emit, qFuzzyCompare(), QVector3D::setX(), and QVector3D::x().

+ Here is the call graph for this function:

◆ setOffsetY

void QQuick3DParticleSpriteParticle::setOffsetY ( float value)
slot

Definition at line 293 of file qquick3dparticlespriteparticle.cpp.

References emit, qFuzzyCompare(), QVector3D::setY(), and QVector3D::y().

+ Here is the call graph for this function:

◆ setParticleData()

void QQuick3DParticleSpriteParticle::setParticleData ( int particleIndex,
const QVector3D & position,
const QVector3D & rotation,
const QVector4D & color,
float size,
float age,
float animationFrame )
protectedvirtual

Reimplemented in QQuick3DParticleLineParticle.

Definition at line 539 of file qquick3dparticlespriteparticle.cpp.

References QQuick3DParticle::color, m_spriteParticleData, and position().

Referenced by QQuick3DParticleLineParticle::setParticleData().

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

◆ setParticleScale

void QQuick3DParticleSpriteParticle::setParticleScale ( float scale)
slot

Definition at line 262 of file qquick3dparticlespriteparticle.cpp.

References markNodesDirty(), particleScaleChanged(), Q_EMIT, and qFuzzyCompare().

+ Here is the call graph for this function:

◆ setSprite

void QQuick3DParticleSpriteParticle::setSprite ( QQuick3DTexture * sprite)
slot

Definition at line 230 of file qquick3dparticlespriteparticle.cpp.

References QQuick3DObjectPrivate::attachWatcher(), markNodesDirty(), Q_EMIT, setSprite(), sprite, and spriteChanged().

Referenced by setSprite().

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

◆ setSpriteSequence

void QQuick3DParticleSpriteParticle::setSpriteSequence ( QQuick3DParticleSpriteSequence * spriteSequence)
slot

Definition at line 242 of file qquick3dparticlespriteparticle.cpp.

References QQuick3DParticle::m_spriteSequence, markNodesDirty(), Q_EMIT, spriteSequence, and spriteSequenceChanged().

Referenced by QQuick3DParticleSpriteSequence::~QQuick3DParticleSpriteSequence().

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

◆ sprite()

QQuick3DTexture * QQuick3DParticleSpriteParticle::sprite ( ) const

\qmlproperty Texture SpriteParticle3D::sprite

This property defines the \l Texture used for the particles.

For example, to use "snowFlake.png" as the particles texture:

\qml SpriteParticle3D { id: snowParticle ... sprite: Texture { source: "images/snowflake.png" } } \endqml

Definition at line 101 of file qquick3dparticlespriteparticle.cpp.

◆ spriteChanged

void QQuick3DParticleSpriteParticle::spriteChanged ( )
signal

Referenced by setSprite().

+ Here is the caller graph for this function:

◆ spriteSequence()

QQuick3DParticleSpriteSequence * QQuick3DParticleSpriteParticle::spriteSequence ( ) const

\qmlproperty SpriteSequence3D SpriteParticle3D::spriteSequence

This property defines the sprite sequence properties for the particle. If the \l sprite texture contains a frame sequence, set this property to define the frame count, animation direction etc. features.

Definition at line 114 of file qquick3dparticlespriteparticle.cpp.

References QQuick3DParticle::m_spriteSequence.

◆ spriteSequenceChanged

void QQuick3DParticleSpriteParticle::spriteSequenceChanged ( )
signal

Referenced by setSpriteSequence().

+ Here is the caller graph for this function:

◆ updateNodes()

void QQuick3DParticleSpriteParticle::updateNodes ( )
protected

Definition at line 464 of file qquick3dparticlespriteparticle.cpp.

References m_perEmitterData.

Referenced by commitParticles().

+ Here is the caller graph for this function:

◆ updateParticleNode()

QSSGRenderGraphObject * QQuick3DParticleSpriteParticle::updateParticleNode ( const ParticleUpdateNode * updateNode,
QSSGRenderGraphObject * node )

Definition at line 387 of file qquick3dparticlespriteparticle.cpp.

References QQuick3DObjectPrivate::get(), QQuick3DTexture::getRenderImage(), QQuick3DParticle::hasTransparency, m_featureLevel, QQuick3DParticleSpriteParticle::ParticleUpdateNode::m_nodeDirty, QQuick3DParticle::m_spriteSequence, mapBlendMode(), QQuick3DObject::markAllDirty(), perEmitterData(), QSSGRenderNode::signedSquared(), QQuick3DParticle::SortDistance, and QQuick3DParticle::sortMode.

Referenced by QQuick3DParticleSpriteParticle::ParticleUpdateNode::updateSpatialNode().

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

Friends And Related Symbol Documentation

◆ ParticleUpdateNode

friend class ParticleUpdateNode
friend

Definition at line 147 of file qquick3dparticlespriteparticle_p.h.

Referenced by handleSystemChanged(), and nextCurrentIndex().

◆ QQuick3DParticleEmitter

friend class QQuick3DParticleEmitter
friend

Definition at line 112 of file qquick3dparticlespriteparticle_p.h.

◆ QQuick3DParticleSpriteSequence

friend class QQuick3DParticleSpriteSequence
friend

Definition at line 113 of file qquick3dparticlespriteparticle_p.h.

◆ QQuick3DParticleSystem

friend class QQuick3DParticleSystem
friend

Definition at line 111 of file qquick3dparticlespriteparticle_p.h.

Member Data Documentation

◆ m_featureLevel

FeatureLevel QQuick3DParticleSpriteParticle::m_featureLevel = FeatureLevel::Simple
protected

◆ m_nextEmitterIndex

int QQuick3DParticleSpriteParticle::m_nextEmitterIndex = 0
protected

◆ m_perEmitterData

◆ m_spriteParticleData

Property Documentation

◆ billboard

bool QQuick3DParticleSpriteParticle::billboard
readwrite

Definition at line 37 of file qquick3dparticlespriteparticle_p.h.

Referenced by setBillboard().

◆ blendMode

BlendMode QQuick3DParticleSpriteParticle::blendMode
readwrite

Definition at line 34 of file qquick3dparticlespriteparticle_p.h.

Referenced by setBlendMode().

◆ castsReflections

bool QQuick3DParticleSpriteParticle::castsReflections
readwrite

\qmlproperty bool SpriteParticle3D::castsReflections

Since
6.4

When this property is set to true, the sprite is rendered by reflection probes and can be seen in the reflections.

Definition at line 43 of file qquick3dparticlespriteparticle_p.h.

◆ colorTable

QQuick3DTexture * QQuick3DParticleSpriteParticle::colorTable
readwrite

Definition at line 39 of file qquick3dparticlespriteparticle_p.h.

Referenced by setColorTable().

◆ lights

QQmlListProperty< QQuick3DAbstractLight > QQuick3DParticleSpriteParticle::lights
read

\qmlproperty list<Light> SpriteParticle3D::lights

Since
6.3

This property contains a list of \l [QtQuick3D QML] {Light}{lights} used for rendering the particles.

Note
For optimal performance, define lights only if they are needed and keep the amount of lights at minimum.

Definition at line 40 of file qquick3dparticlespriteparticle_p.h.

Referenced by ~QQuick3DParticleSpriteParticle().

◆ offsetX

float QQuick3DParticleSpriteParticle::offsetX
readwrite

Definition at line 41 of file qquick3dparticlespriteparticle_p.h.

◆ offsetY

float QQuick3DParticleSpriteParticle::offsetY
readwrite

Definition at line 42 of file qquick3dparticlespriteparticle_p.h.

◆ particleScale

float QQuick3DParticleSpriteParticle::particleScale
readwrite

Definition at line 38 of file qquick3dparticlespriteparticle_p.h.

◆ sprite

QQuick3DTexture * QQuick3DParticleSpriteParticle::sprite
readwrite

Definition at line 35 of file qquick3dparticlespriteparticle_p.h.

Referenced by setSprite().

◆ spriteSequence

QQuick3DParticleSpriteSequence * QQuick3DParticleSpriteParticle::spriteSequence
readwrite

Definition at line 36 of file qquick3dparticlespriteparticle_p.h.

Referenced by setSpriteSequence().


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