Affector QML Type | Qt Quick 6.7.3
Description: Applies alterations to the attributes of logical particles at any point in their lifetime.

- Qt 6.7
- Qt Quick
- QML Types
- QtQuick.Particles
- Affector
- Qt 6.7.3 Reference Documentation

# Affector QML Type

Applies alterations to the attributes of logical particles at any point in their lifetime. More...

Import Statement: | import QtQuick.Particles
Inherited By: | Age, Attractor, Friction, Gravity, GroupGoal, SpriteGoal, Turbulence, and Wander

- List of all members, including inherited members

## Properties

- acceleration : StochasticDirection
- enabled : bool
- groups : list<string>
- once : bool
- position : StochasticDirection
- relative : bool
- shape : Shape
- system : ParticleSystem
- velocity : StochasticDirection
- whenCollidingWith : list<string>

## Signals

- affectParticles(Array particles, real dt)
- affected(real x, real y)

## Detailed Description

The base Affector does not alter any attributes, but can be used to emit a signal when a particle meets certain conditions.

If an affector has a defined size, then it will only affect particles within its size and position on screen.

Affectors have different performance characteristics to the other particle system elements. In particular, they have some simplifications to try to maintain a simulation at real-time or faster. When running a system with Affectors, irregular frame timings that grow too large ( > one second per frame) will cause the Affectors to try and cut corners with a faster but less accurate simulation. If the system has multiple affectors the order in which they are applied is not guaranteed, and when simulating larger time shifts they will simulate the whole shift each, which can lead to different results compared to smaller time shifts.

Accurate simulation for large numbers of particles (hundreds) with multiple affectors may be possible on some hardware, but on less capable hardware you should expect small irregularties in the simulation as simulates with worse granularity.

## Property Documentation

acceleration : StochasticDirection

Affected particles will have their acceleration set to this direction.

enabled : bool

If enabled is set to false, this affector will not affect any particles.

Usually this is used to conditionally turn an affector on or off.

Default value is true.

groups : list<string>

Which logical particle groups will be affected.

If empty, it will affect all particles.

once : bool

If once is set to true, this affector will only affect each particle once in their lifetimes. If the affector normally simulates a continuous effect over time, then it will simulate the effect of one second of time the one instant it affects the particle.

Default value is false.

position : StochasticDirection

Affected particles will have their position set to this direction, relative to the ParticleSystem. When interpreting directions as points, imagine it as an arrow with the base at the 0,0 of the ParticleSystem and the tip at where the specified position will be.

relative : bool

Whether the affected particles have their existing position/velocity/acceleration added to the new one.

Default is true.

shape : Shape

If a size has been defined, the shape property can be used to affect a non-rectangular area.

system : ParticleSystem

This is the system which will be affected by the element. If the Affector is a direct child of a ParticleSystem, it will automatically be associated with it.

velocity : StochasticDirection

Affected particles will have their velocity set to this direction.

whenCollidingWith : list<string>

If any logical particle groups are specified here, then the affector will only be triggered if the particle being examined intersects with a particle of one of these groups.

This is different from the groups property. The groups property selects which particles might be examined, and if they meet other criteria (including being within the bounds of the Affector, modified by shape) then they will be tested again to see if they intersect with a particles from one of the particle groups in whenCollidingWith.

By default, no groups are specified.

## Signal Documentation

affectParticles(Array particles, real dt)

This signal is emitted when particles are selected to be affected. particles is an array of particle objects which can be directly manipulated.

dt is the time since the last time it was affected. Use dt to normalize trajectory manipulations to real time.

Note: JavaScript is slower to execute, so it is not recommended to use this in high-volume particle systems.

Note: The corresponding handler is `onAffectParticles`.

affected(real x, real y)

This signal is emitted when a particle is selected to be affected. It will not be emitted if a particle is considered by the Affector but not actually altered in any way.

In the special case where an Affector has no possible effect (e.g. Affector {}), this signal will be emitted for all particles being considered if you connect to it. This allows you to execute arbitrary code in response to particles (use the Affector::onAffectParticles signal handler if you want to execute code which affects the particles themselves). As this executes JavaScript code per particle, it is not recommended to use this signal with a high-volume particle system.

(x, y) is the particle's current position.

Note: The corresponding handler is `onAffected`.