Kuesa::Qt3D::Particles¶

Particle system that controls emission and the various properties or particles over their lifetime. More...

#include <Kuesa/Qt3D/api/particles.h>

Inherits from Qt3DCore::QEntity

Public Types¶

	Name
enum class	AlignMode { FaceCamera, Velocity}

Public Slots¶

	Name
void	setParticleCount(int particleCount)
void	setFrameTime(float frameTime)
void	setMaxParticlesEmittedPerFrame(int maxParticlesEmittedPerFrame)
void	setGravity(const QVector3D & gravity)
void	setEmitterPosition(const QVector3D & emitterPosition)
void	setEmitterPositionRandom(const QVector3D & emitterPositionRandom)
void	setEmitterVelocity(const QVector3D & emitterVelocity)
void	setEmitterVelocityRandom(const QVector3D & emitterVelocityRandom)
void	setParticleLifespan(float lifespan)
void	setParticleLifespanRandom(float lifespanRandom)
void	setInitialSize(const QVector2D & initialSize)
void	setFinalSize(const QVector2D & finalSize)
void	setInitialColor(const QVector4D & initialColor)
void	setFinalColor(const QVector4D & finalColor)
void	setInitialAngle(float initialAngle)
void	setInitialAngleRandom(float initialAngleRandom)
void	setRotationRate(float rotationRate)
void	setRotationRateRandom(float rotationRateRandom)
void	setSpriteTexture(Qt3DRender::QAbstractTexture * spriteTexture)
void	setAlignMode(AlignMode alignMode)

Public Signals¶

	Name
void	particleCountChanged(int particleCount)
void	frameTimeChanged(float frameTime)
void	maxParticlesEmittedPerFrameChanged(int maxParticlesEmittedPerFrame)
void	gravityChanged(const QVector3D & gravity)
void	emitterPositionChanged(const QVector3D & emitterPosition)
void	emitterPositionRandomChanged(const QVector3D & emitterPositionRandom)
void	emitterVelocityChanged(const QVector3D & emitterVelocity)
void	emitterVelocityRandomChanged(const QVector3D & emitterVelocityRandom)
void	particleLifespanChanged(float particleLifespan)
void	particleLifespanRandomChanged(float particleLifespanRandom)
void	initialSizeChanged(const QVector2D & initialSize)
void	finalSizeChanged(const QVector2D & finalSize)
void	initialColorChanged(const QVector4D & initialColor)
void	finalColorChanged(const QVector4D & finalColor)
void	initialAngleChanged(float initialAngle)
void	initialAngleRandomChanged(float initialAngleRandom)
void	rotationRateChanged(float rotationRate)
void	rotationRateRandomChanged(float rotationRateRandom)
void	spriteTextureChanged(const Qt3DRender::QAbstractTexture * spriteTexture)
void	alignModeChanged(AlignMode alignMode)

Public Functions¶

	Name
	Q_ENUM(AlignMode )
	Particles(Qt3DCore::QEntity * parent =nullptr)
int	particleCount() const
float	frameTime() const
int	maxParticlesEmittedPerFrame() const
QVector3D	gravity() const
QVector3D	emitterPosition() const
QVector3D	emitterPositionRandom() const
QVector3D	emitterVelocity() const
QVector3D	emitterVelocityRandom() const
float	particleLifespan() const
float	particleLifespanRandom() const
QVector2D	initialSize() const
QVector2D	finalSize() const
QVector4D	initialColor() const
QVector4D	finalColor() const
float	initialAngle() const
float	initialAngleRandom() const
float	rotationRate() const
float	rotationRateRandom() const
Qt3DRender::QAbstractTexture *	spriteTexture() const
AlignMode	alignMode() const

Public Properties¶

	Name
int	particleCount
float	frameTime
int	maxParticlesEmittedPerFrame
QVector3D	gravity
QVector3D	emitterPosition
QVector3D	emitterPositionRandom
QVector3D	emitterVelocity
QVector3D	emitterVelocityRandom
float	particleLifespan
float	particleLifespanRandom
QVector2D	initialSize
QVector2D	finalSize
QVector4D	initialColor
QVector4D	finalColor
float	initialAngle
float	initialAngleRandom
float	rotationRate
float	rotationRateRandom
Qt3DRender::QAbstractTexture *	spriteTexture
AlignMode	alignMode

Detailed Description¶

class Kuesa::Qt3D::Particles;

Particle system that controls emission and the various properties or particles over their lifetime.

Since: Kuesa 2.0

#include <Qt3DExtras/Qt3DWindow>
#include <ForwardRenderer>
#include <SceneEntity>
#include <Particles>

Qt3DExtras::Qt3DWindow win;
Kuesa::Qt3D::SceneEntity *root = new Kuesa::Qt3D::SceneEntity();
Kuesa::Qt3D::ForwardRenderer *frameGraph = new Kuesa::Qt3D::ForwardRenderer();
frameGraph->setParticlesEnabled(true)

Kuesa::Qt3D::Particles *particles = new Kuesa::Qt3D::Particles(root);
particles->setParticleCount(128);
particles->setMaxParticlesEmittedPerFrame(4);
particles->setGravity(QVector3D(0.0f, -1.0f, 0.0f));
...

win->setRootEntity(root);
win->setActiveFrameGraph(forwardRenderer);
...

Public Types Documentation¶

enum AlignMode¶

Enumerator	Value	Description
FaceCamera
Velocity

This enum type describes the available particle alignment modes.

FaceCamera The particle faces the camera at all times.
Velocity The particle's local Y axis is aligned to its direction.

Public Slots Documentation¶

slot setParticleCount¶

void setParticleCount(
    int particleCount
)

slot setFrameTime¶

void setFrameTime(
    float frameTime
)

slot setMaxParticlesEmittedPerFrame¶

void setMaxParticlesEmittedPerFrame(
    int maxParticlesEmittedPerFrame
)

slot setGravity¶

void setGravity(
    const QVector3D & gravity
)

slot setEmitterPosition¶

void setEmitterPosition(
    const QVector3D & emitterPosition
)

slot setEmitterPositionRandom¶

void setEmitterPositionRandom(
    const QVector3D & emitterPositionRandom
)

slot setEmitterVelocity¶

void setEmitterVelocity(
    const QVector3D & emitterVelocity
)

slot setEmitterVelocityRandom¶

void setEmitterVelocityRandom(
    const QVector3D & emitterVelocityRandom
)

slot setParticleLifespan¶

void setParticleLifespan(
    float lifespan
)

slot setParticleLifespanRandom¶

void setParticleLifespanRandom(
    float lifespanRandom
)

slot setInitialSize¶

void setInitialSize(
    const QVector2D & initialSize
)

slot setFinalSize¶

void setFinalSize(
    const QVector2D & finalSize
)

slot setInitialColor¶

void setInitialColor(
    const QVector4D & initialColor
)

slot setFinalColor¶

void setFinalColor(
    const QVector4D & finalColor
)

slot setInitialAngle¶

void setInitialAngle(
    float initialAngle
)

slot setInitialAngleRandom¶

void setInitialAngleRandom(
    float initialAngleRandom
)

slot setRotationRate¶

void setRotationRate(
    float rotationRate
)

slot setRotationRateRandom¶

void setRotationRateRandom(
    float rotationRateRandom
)

slot setSpriteTexture¶

void setSpriteTexture(
    Qt3DRender::QAbstractTexture * spriteTexture
)

slot setAlignMode¶

void setAlignMode(
    AlignMode alignMode
)

Public Signals Documentation¶

signal particleCountChanged¶

void particleCountChanged(
    int particleCount
)

signal frameTimeChanged¶

void frameTimeChanged(
    float frameTime
)

signal maxParticlesEmittedPerFrameChanged¶

void maxParticlesEmittedPerFrameChanged(
    int maxParticlesEmittedPerFrame
)

signal gravityChanged¶

void gravityChanged(
    const QVector3D & gravity
)

signal emitterPositionChanged¶

void emitterPositionChanged(
    const QVector3D & emitterPosition
)

signal emitterPositionRandomChanged¶

void emitterPositionRandomChanged(
    const QVector3D & emitterPositionRandom
)

signal emitterVelocityChanged¶

void emitterVelocityChanged(
    const QVector3D & emitterVelocity
)

signal emitterVelocityRandomChanged¶

void emitterVelocityRandomChanged(
    const QVector3D & emitterVelocityRandom
)

signal particleLifespanChanged¶

void particleLifespanChanged(
    float particleLifespan
)

signal particleLifespanRandomChanged¶

void particleLifespanRandomChanged(
    float particleLifespanRandom
)

signal initialSizeChanged¶

void initialSizeChanged(
    const QVector2D & initialSize
)

signal finalSizeChanged¶

void finalSizeChanged(
    const QVector2D & finalSize
)

signal initialColorChanged¶

void initialColorChanged(
    const QVector4D & initialColor
)

signal finalColorChanged¶

void finalColorChanged(
    const QVector4D & finalColor
)

signal initialAngleChanged¶

void initialAngleChanged(
    float initialAngle
)

signal initialAngleRandomChanged¶

void initialAngleRandomChanged(
    float initialAngleRandom
)

signal rotationRateChanged¶

void rotationRateChanged(
    float rotationRate
)

signal rotationRateRandomChanged¶

void rotationRateRandomChanged(
    float rotationRateRandom
)

signal spriteTextureChanged¶

void spriteTextureChanged(
    const Qt3DRender::QAbstractTexture * spriteTexture
)

signal alignModeChanged¶

void alignModeChanged(
    AlignMode alignMode
)

Public Functions Documentation¶

function Q_ENUM¶

Q_ENUM(
    AlignMode 
)

function Particles¶

explicit Particles(
    Qt3DCore::QEntity * parent =nullptr
)

function particleCount¶

int particleCount() const

function frameTime¶

float frameTime() const

function maxParticlesEmittedPerFrame¶

int maxParticlesEmittedPerFrame() const

function gravity¶

QVector3D gravity() const

function emitterPosition¶

QVector3D emitterPosition() const

function emitterPositionRandom¶

QVector3D emitterPositionRandom() const

function emitterVelocity¶

QVector3D emitterVelocity() const

function emitterVelocityRandom¶

QVector3D emitterVelocityRandom() const

function particleLifespan¶

float particleLifespan() const

function particleLifespanRandom¶

float particleLifespanRandom() const

function initialSize¶

QVector2D initialSize() const

function finalSize¶

QVector2D finalSize() const

function initialColor¶

QVector4D initialColor() const

function finalColor¶

QVector4D finalColor() const

function initialAngle¶

float initialAngle() const

function initialAngleRandom¶

float initialAngleRandom() const

function rotationRate¶

float rotationRate() const

function rotationRateRandom¶

float rotationRateRandom() const

function spriteTexture¶

Qt3DRender::QAbstractTexture * spriteTexture() const

function alignMode¶

AlignMode alignMode() const

Public Property Documentation¶

property particleCount¶

int particleCount;

Since: Kuesa 2.0

Holds the maximum number of particles the system can handle. Currently the maximum value is 2048.

\default 32

property frameTime¶

float frameTime;

Since: Kuesa 2.0

Holds the speed at which updates need to be made in milliseconds.

\default 1/60

property maxParticlesEmittedPerFrame¶

int maxParticlesEmittedPerFrame;

Since: Kuesa 2.0

Holds the maximum number of new particles that can be created each frame.

\default 4

property gravity¶

QVector3D gravity;

Since: Kuesa 2.0

Holds the gravity value to apply to the particles.

property emitterPosition¶

QVector3D emitterPosition;

Since: Kuesa 2.0

Holds the world position of the particle emitter.

property emitterPositionRandom¶

QVector3D emitterPositionRandom;

Since: Kuesa 2.0

Holds the randomness factor applied to the world position.

property emitterVelocity¶

QVector3D emitterVelocity;

Since: Kuesa 2.0

Holds the velocity applied to the particles.

property emitterVelocityRandom¶

QVector3D emitterVelocityRandom;

Since: Kuesa 2.0

Holds the velocity randomness factor applied to the particles.

property particleLifespan¶

float particleLifespan;

Since: Kuesa 2.0 \default 1

Holds the lifetime of the particles.

property particleLifespanRandom¶

float particleLifespanRandom;

Since: Kuesa 2.0

Holds the lifetime randomness factor applied to the particles.

property initialSize¶

QVector2D initialSize;

Since: Kuesa 2.0 \default 0

Holds the initial size of the particles.

property finalSize¶

QVector2D finalSize;

Since: Kuesa 2.0

Holds the final size of the particles.

property initialColor¶

QVector4D initialColor;

Since: Kuesa 2.0

Holds the initial color of the particles.

property finalColor¶

QVector4D finalColor;

Since: Kuesa 2.0

Holds the final color of the particles.

property initialAngle¶

float initialAngle;

Since: Kuesa 2.0

Holds the initial rotation angle in radians of the particles.

property initialAngleRandom¶

float initialAngleRandom;

Since: Kuesa 2.0

Holds the initial rotation randomness factor applied to the particles.

property rotationRate¶

float rotationRate;

Since: Kuesa 2.0

Holds the rotation speed applied to the particles.

property rotationRateRandom¶

float rotationRateRandom;

Since: Kuesa 2.0

Holds the rotation speed randomness factor applied to the particles.

property spriteTexture¶

Qt3DRender::QAbstractTexture * spriteTexture;

Since: Kuesa 2.0

Holds the 2D sprite texture to apply to the particles.

property alignMode¶

AlignMode alignMode;

Since: Kuesa 2.0

Holds the alignment mode for the particles.

FaceCamera The particle faces the camera at all times.
Velocity The particle's local Y axis is aligned to its direction.

If the Velocity alignment mode is used, the initialAngle and rotationRate properties are ignored.

Updated on 2023-07-03 at 11:02:09 +0000