ParticleEffect Class Reference

Creates a ParticleEffect object that handles Particle objects. More...

#include <ParticleEffect.h>

Collaboration diagram for ParticleEffect:

Public Member Functions
	ParticleEffect (std::string fileName, std::unordered_map< std::string, Object * > &objects, std::unordered_map< std::string, Shader * > &shaders, std::string vertexShaderName, std::string fragmentShaderName, glm::vec3 emitter, bool emit)
	~ParticleEffect ()
void	update (float dt)
void	draw (glm::mat4 &viewMatrix, glm::mat4 &projMatrix)
void	makeNewParticles (std::unordered_map< std::string, Object * > &objects, std::unordered_map< std::string, Shader * > &shaders)
void	setEmitter (glm::vec3 emitter)
void	setEmitting (bool emit)

Private Attributes
std::vector< Particle * >	particles
std::unordered_map < std::string, Object * >	objects
std::unordered_map < std::string, Shader * >	shaders
std::string	objectName
std::string	vertexShaderName
std::string	fragmentShaderName
float	moveSpeed
glm::vec3	emitter
bool	emit

Detailed Description

Creates a ParticleEffect object that handles Particle objects.

Author

Jamie Slowgrove

Constructor & Destructor Documentation

ParticleEffect::ParticleEffect	(	std::string	fileName,
		std::unordered_map< std::string, Object * > &	objects,
		std::unordered_map< std::string, Shader * > &	shaders,
		std::string	vertexShaderName,
		std::string	fragmentShaderName,
		glm::vec3	emitter,
		bool	emit
	)

Constructs a ParticleEffect Object.

Parameters

objectName	The file name of the model that the Particle will use.
objects	A reference to the loaded Object files
shaders	A reference to the loaded Shader files
vertexShaderName	The name of the vertex shader.
fragmentShaderName	The name of the fragment shader.
emitter	The position that the particle effect emits from.
emit	The new value of the emit boolean.

Here is the call graph for this function:

ParticleEffect::~ParticleEffect

(

)

Destructs a ParticleEffect Object. Destructs the ParticleEffect Object deleting the Particle Object from memory.

Member Function Documentation

void ParticleEffect::draw	(	glm::mat4 &	viewMatrix,
		glm::mat4 &	projMatrix
	)

Draws the ParticleEffect.

Parameters

viewMatrix	A reference to the camera view matrix.
projMatrix	A reference to the camera projection matrix.

Here is the caller graph for this function:

void ParticleEffect::makeNewParticles	(	std::unordered_map< std::string, Object * > &	objects,
		std::unordered_map< std::string, Shader * > &	shaders
	)

Creates the new Particle objects.

Parameters

objects	A reference to the loaded Object files
shaders	A reference to the loaded Shader files

Here is the caller graph for this function:

void ParticleEffect::setEmitter

(

glm::vec3

emitter

)

Setter # The position of the emitter.

Parameters

emitter

The new position of the emitter.

Here is the caller graph for this function:

void ParticleEffect::setEmitting

(

bool

emit

)

Setter # The value of the emit boolean.

Parameters

emit	The new value of the emit boolean.

Here is the caller graph for this function:

void ParticleEffect::update

(

float

dt

)

A function that updates the ParticleEffect

Parameters

dt	The delta time.

Here is the caller graph for this function:

Member Data Documentation

bool ParticleEffect::emit

private

A boolean for if the ParticleEffect should emit

glm::vec3 ParticleEffect::emitter

private

The position of the Particle emitter

std::string ParticleEffect::fragmentShaderName

private

The name of the fragment shader

float ParticleEffect::moveSpeed

private

The move speed of the particles

std::string ParticleEffect::objectName

private

The name of the object for the model

std::unordered_map<std::string, Object*> ParticleEffect::objects

private

The loaded Object files

std::vector<Particle*> ParticleEffect::particles

private

A vector of Particle objects

std::unordered_map<std::string, Shader*> ParticleEffect::shaders

private

std::string ParticleEffect::vertexShaderName

private

The name of the vertex shader

---

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

• Assignment 2/ParticleEffect.h
• Assignment 2/ParticleEffect.cpp