class `ParticleEmitterBoxShape`

Inherits: ParticleEmitterShape

Particle emitter shape that emits particles from an axis aligned box.

Particles can be emitted from box volume, surface or edges. All particles have their normals set to positive Z direction.

Public

Constructors

ParticleEmitterBoxShape

ParticleEmitterBoxShape() = default

ParticleEmitterBoxShape

ParticleEmitterBoxShape(const ParticleBoxShapeSettings &settings)

Methods

SetSettings

void SetSettings(const ParticleBoxShapeSettings &settings)

Options describing the shape.

GetSettings

const ParticleBoxShapeSettings &GetSettings() const

staticCreate

static SPtr<ParticleEmitterBoxShape> Create(const ParticleBoxShapeSettings &settings)

Creates a new particle emitter box shape.

staticCreate

static SPtr<ParticleEmitterBoxShape> Create()

Creates a new particle emitter box shape.

staticGetRttiStatic

static RTTIType *GetRttiStatic()

GetRtti

RTTIType *GetRtti() const override

Returns an interface you can use to access class' Run Time Type Information.

Internal

Methods

SpawnInternal

u32 SpawnInternal(const Random &random, ParticleSet &particles, u32 count, const ParticleSystemState &state) const override

Spawns a new set of particles using the current shape's distribution.

random: Random number generator.
particles: Particle set in which to insert new particles.
count: Number of particles to spawn.
state: Optional state that can contain various per-frame information required for spawning the particles.

Returns: Index at which the first of the particles was inserted, with other particles following sequentially.

SpawnInternal

void SpawnInternal(const Random &random, Vector3 &position, Vector3 &normal) const

Spawns a single particle, generating its position and normal.

Protected

Methods

CalcBounds

void CalcBounds(AABox &shape, AABox &velocity) const override

Calculates the bounds of the emitter shape.

shape: AABB for the emitter shape itself.
velocity: AABB for the generated normals.

Fields

mSettings

ParticleBoxShapeSettings mSettings

mSurfaceArea

float[3] mSurfaceArea

mEdgeLengths

float[3] mEdgeLengths