Confetti::PointEmitter Class Reference

An Emitter that emits PointParticles. More...

#include <Confetti/Emitter.h>

Inheritance diagram for Confetti::PointEmitter:

Public Member Functions
	PointEmitter (std::shared_ptr< Vkx::Device > device, int n, std::shared_ptr< EmitterVolume > volume, std::shared_ptr< Environment > environment, std::shared_ptr< Appearance > appearance, bool sorted)
	Constructor. More...
	PointEmitter (std::shared_ptr< Vkx::Device > device, std::vector< PointParticle > particles, std::shared_ptr< EmitterVolume > volume, std::shared_ptr< Environment > environment, std::shared_ptr< Appearance > appearance, bool sorted)
	Constructor. More...
void	initialize ()
	Initializes the emitter.
void	uninitialize ()
	Uninitializes the emitter.
std::vector< PointParticle > &	particles ()
std::vector< PointParticle > const &	particles () const
Overrides BasicEmitter
virtual void	update (float dt) override
virtual void	draw () const override
	Draws all the emitter's particles. More...
Public Member Functions inherited from Confetti::BasicEmitter
	BasicEmitter (std::shared_ptr< Vkx::Device > device, std::shared_ptr< EmitterVolume > volume, std::shared_ptr< Environment > environment, std::shared_ptr< Appearance > appearance, bool sorted)
	Constructor. More...
virtual	~BasicEmitter ()=default
	Destructor.
std::shared_ptr< EmitterVolume >	emitterVolume () const
	Returns the emitter volume.
std::shared_ptr< Appearance >	appearance () const
	Returns the appearance.
std::shared_ptr< Environment >	environment () const
	Returns the environment.
glm::vec3	currentPosition () const
	Returns the current position.
glm::vec3	currentVelocity () const
	Returns the current velocity.
bool	enabled () const
	Returns true if the emitter is enabled.
bool	sorted () const
	Returns true if the particles are sorted.
bool	enable (bool enable=true)
	Enables/Disables the emitter. Returns the previous state. More...
void	update (glm::vec3 const &position, glm::vec3 const &velocity)
	Sets the emitter's position and velocity. More...
void	update (float dt, glm::vec3 const &position, glm::vec3 const &velocity)
	Updates the emitter and its particles. More...

Additional Inherited Members
Protected Attributes inherited from Confetti::BasicEmitter
Vkx::LocalBuffer	vertexes_
Vkx::LocalBuffer	indexes_
std::shared_ptr< Vkx::Device >	device_

Detailed Description

An Emitter that emits PointParticles.

Constructor & Destructor Documentation

PointEmitter() [1/2]

Confetti::PointEmitter::PointEmitter	(	std::shared_ptr< Vkx::Device >	device,
		int	n,
		std::shared_ptr< EmitterVolume >	volume,
		std::shared_ptr< Environment >	environment,
		std::shared_ptr< Appearance >	appearance,
		bool	sorted
	)

Constructor.

Parameters

volume	Emitter volume.
environment	Environment.
appearance	Appearance.
n	Number of particles to create.

Warning

std::bad_alloc is thown if memory is unable to be allocated for the particles.

PointEmitter() [2/2]

Confetti::PointEmitter::PointEmitter	(	std::shared_ptr< Vkx::Device >	device,
		std::vector< PointParticle >	particles,
		std::shared_ptr< EmitterVolume >	volume,
		std::shared_ptr< Environment >	environment,
		std::shared_ptr< Appearance >	appearance,
		bool	sorted
	)

Constructor.

Parameters

particles	Particle array (the emitter assumes ownership).
volume	Emitter volume.
environment	Environment applied to all particles.
appearance	Appearance shared by all particles.
n	Number of particles to create.

Warning

particles must have been allocated with new[].

Member Function Documentation

draw()

void Confetti::PointEmitter::draw ( ) const

overridevirtual

Draws all the emitter's particles.

Note

This method must be overridden.

Implements Confetti::BasicEmitter.

update()

void Confetti::PointEmitter::update ( float  dt )

overridevirtual

Parameters

dt	Amount of time elapsed since the last update

Implements Confetti::BasicEmitter.