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

#include <qquick3dparticlescaleaffector_p.h>

Inheritance diagram for QQuick3DParticleScaleAffector:
Collaboration diagram for QQuick3DParticleScaleAffector:

Public Types

enum  ScalingType {
  Linear , SewSaw , SineWave , AbsSineWave ,
  Step , SmoothStep
}
Public Types inherited from QQuick3DNode
enum  TransformSpace { LocalSpace , ParentSpace , SceneSpace }
enum  StaticFlags { None }

Public Slots

void setMinSize (float size)
void setMaxSize (float size)
void setDuration (int duration)
void setType (ScalingType type)
void setEasingCurve (const QEasingCurve &curve)
Public Slots inherited from QQuick3DParticleAffector
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)
void setLayers (int newLayers)
Public Slots inherited from QQuick3DObject
void update ()
void setParentItem (QQuick3DObject *parentItem)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Signals

void minSizeChanged ()
void maxSizeChanged ()
void durationChanged ()
void typeChanged ()
void easingCurveChanged ()
Signals inherited from QQuick3DParticleAffector
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 ()
void layersChanged ()
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

 QQuick3DParticleScaleAffector (QQuick3DNode *parent=nullptr)
 \qmltype ScaleAffector3D \inherits Affector3D \inqmlmodule QtQuick3D.Particles3D
float minSize () const
 \qmlproperty real ScaleAffector3D::minSize
float maxSize () const
 \qmlproperty real ScaleAffector3D::maxSize
int duration () const
 \qmlproperty int ScaleAffector3D::duration
ScalingType type () const
 \qmlproperty enumeration ScaleAffector3D::ScalingType
QEasingCurve easingCurve () const
 \qmlproperty EasingCurve ScaleAffector3D::easingCurve
Public Member Functions inherited from QQuick3DParticleAffector
 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
int layers () const
 \qmlproperty int QtQuick3D::Node::layers
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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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 prepareToAffect () override
void affectParticle (const QQuick3DParticleData &, QQuick3DParticleDataCurrent *d, float time) override
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)

Properties

float minSize
float maxSize
int duration
ScalingType type
QEasingCurve easingCurve
Properties inherited from QQuick3DParticleAffector
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
int layers
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

Additional Inherited Members

Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Attributes inherited from QQuick3DParticleAffector
QList< QQuick3DParticle * > m_particles
QQuick3DNodem_systemSharedParent = nullptr
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 23 of file qquick3dparticlescaleaffector_p.h.

Member Enumeration Documentation

◆ ScalingType

Enumerator
Linear 
SewSaw 
SineWave 
AbsSineWave 
Step 
SmoothStep 

Definition at line 36 of file qquick3dparticlescaleaffector_p.h.

Constructor & Destructor Documentation

◆ QQuick3DParticleScaleAffector()

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

\qmltype ScaleAffector3D \inherits Affector3D \inqmlmodule QtQuick3D.Particles3D

Particle scale affector.

Since
6.4

Scale affector scales the particle size based on its lifetime and parameters.

Definition at line 19 of file qquick3dparticlescaleaffector.cpp.

Member Function Documentation

◆ affectParticle()

void QQuick3DParticleScaleAffector::affectParticle ( const QQuick3DParticleData & ,
QQuick3DParticleDataCurrent * d,
float time )
overrideprotectedvirtual

Implements QQuick3DParticleAffector.

Definition at line 149 of file qquick3dparticlescaleaffector.cpp.

◆ duration()

int QQuick3DParticleScaleAffector::duration ( ) const

\qmlproperty int ScaleAffector3D::duration

This property holds the duration of scaling cycle in milliseconds. The default is 1000.

Definition at line 53 of file qquick3dparticlescaleaffector.cpp.

◆ durationChanged

void QQuick3DParticleScaleAffector::durationChanged ( )
signal

◆ easingCurve()

QEasingCurve QQuick3DParticleScaleAffector::easingCurve ( ) const

\qmlproperty EasingCurve ScaleAffector3D::easingCurve

This property holds the \l {QtQuick::PropertyAnimation::easing}{easing curve} providing more fine tuned control on how the scaling occurs. The easing curve is used with Linear and SewSaw scaling types. The default easing curve provides linear value between [0, 1].

Definition at line 98 of file qquick3dparticlescaleaffector.cpp.

◆ easingCurveChanged

void QQuick3DParticleScaleAffector::easingCurveChanged ( )
signal

◆ maxSize()

float QQuick3DParticleScaleAffector::maxSize ( ) const

\qmlproperty real ScaleAffector3D::maxSize

This property holds the maximum size the affector can scale the particle. The default is 1.0.

Definition at line 42 of file qquick3dparticlescaleaffector.cpp.

◆ maxSizeChanged

void QQuick3DParticleScaleAffector::maxSizeChanged ( )
signal

◆ minSize()

float QQuick3DParticleScaleAffector::minSize ( ) const

\qmlproperty real ScaleAffector3D::minSize

This property holds the minimum size the affector can scale the particle. The default is 1.0.

Definition at line 31 of file qquick3dparticlescaleaffector.cpp.

◆ minSizeChanged

void QQuick3DParticleScaleAffector::minSizeChanged ( )
signal

◆ prepareToAffect()

void QQuick3DParticleScaleAffector::prepareToAffect ( )
overrideprotectedvirtual

Reimplemented from QQuick3DParticleAffector.

Definition at line 144 of file qquick3dparticlescaleaffector.cpp.

◆ setDuration

void QQuick3DParticleScaleAffector::setDuration ( int duration)
slot

Definition at line 119 of file qquick3dparticlescaleaffector.cpp.

◆ setEasingCurve

void QQuick3DParticleScaleAffector::setEasingCurve ( const QEasingCurve & curve)
slot

Definition at line 136 of file qquick3dparticlescaleaffector.cpp.

◆ setMaxSize

void QQuick3DParticleScaleAffector::setMaxSize ( float size)
slot

Definition at line 111 of file qquick3dparticlescaleaffector.cpp.

◆ setMinSize

void QQuick3DParticleScaleAffector::setMinSize ( float size)
slot

Definition at line 103 of file qquick3dparticlescaleaffector.cpp.

◆ setType

void QQuick3DParticleScaleAffector::setType ( ScalingType type)
slot

Definition at line 128 of file qquick3dparticlescaleaffector.cpp.

◆ type()

QQuick3DParticleScaleAffector::ScalingType QQuick3DParticleScaleAffector::type ( ) const

\qmlproperty enumeration ScaleAffector3D::ScalingType

Defines the scaling type of the affector.

\value ScaleAffector3D.Linear The scale is calculated using the easing curve to interpolate between minimum and maximum scale size between duration milliseconds and then continues from the minimum size. \value ScaleAffector3D.SewSaw The scale is calculated using the easing curve to interpolate between minimum and maximum scale size between duration milliseconds on a rising edge then continues from maximum to minimum on a falling edge. \value ScaleAffector3D.SineWave The scale follows the sine wave. Easing curve is not used. \value ScaleAffector3D.AbsSineWave The scale follows the sine wave except negative values are inverted. Easing curve is not used. \value ScaleAffector3D.Step The scale stays at minimum size until half of the duration milliseconds have passed then steps directly to the maximum size. Easing curve is not used. \value ScaleAffector3D.SmoothStep The scale smootly transitions from minimum to maximum size. Easing curve is not used.

\qmlproperty ScalingType ScaleAffector3D::type

This property holds the scaling type of the affector. The default value is Linear.

Definition at line 86 of file qquick3dparticlescaleaffector.cpp.

◆ typeChanged

void QQuick3DParticleScaleAffector::typeChanged ( )
signal

Property Documentation

◆ duration

int QQuick3DParticleScaleAffector::duration
readwrite

Definition at line 28 of file qquick3dparticlescaleaffector_p.h.

◆ easingCurve

QEasingCurve QQuick3DParticleScaleAffector::easingCurve
readwrite

Definition at line 30 of file qquick3dparticlescaleaffector_p.h.

◆ maxSize

float QQuick3DParticleScaleAffector::maxSize
readwrite

Definition at line 27 of file qquick3dparticlescaleaffector_p.h.

◆ minSize

float QQuick3DParticleScaleAffector::minSize
readwrite

Definition at line 26 of file qquick3dparticlescaleaffector_p.h.

◆ type

ScalingType QQuick3DParticleScaleAffector::type
readwrite

Definition at line 29 of file qquick3dparticlescaleaffector_p.h.


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