ncine::ColorAffector Class Reference

Particle color affector. More...

#include <ParticleAffectors.h>

Inheritance diagram for ncine::ColorAffector:

Collaboration diagram for ncine::ColorAffector:

Classes
struct	ColorStep

Public Member Functions
	ColorAffector (ColorAffector &&)=default
	Default move constructor.
ColorAffector &	operator= (ColorAffector &&)=default
	Default move assignment operator.
ColorAffector	clone () const
	Returns a copy of this object.
void	affect (Particle *particle, float normalizedAge) override
	Affects the color of the specified particle.
void	addColorStep (float age, const Colorf &color)
void	addColorStep (const ColorStep &step)
unsigned int	numSteps () const override
	Returns the number of steps.
void	removeStep (unsigned int index) override
	Removes the step at the specified position index.
void	clearSteps () override
	Removes all steps.
nctl::Array< ColorStep > &	steps ()
const nctl::Array< ColorStep > &	steps () const
Public Member Functions inherited from ncine::ParticleAffector
	ParticleAffector (Type type)
void	affect (Particle *particle)
	Affects a property of the specified particle.
Type	type () const
	Returns the affector type.
bool	isEnabled () const
	Returns true if the affector is enabled.
void	setEnabled (bool enabled)
	Enables or disables the affector.

Protected Member Functions
	ColorAffector (const ColorAffector &other)=default
	Protected default copy constructor used to clone objects.
Protected Member Functions inherited from ncine::ParticleAffector
	ParticleAffector (const ParticleAffector &other)=default
	Protected default copy constructor used to clone objects.

Additional Inherited Members
Public Types inherited from ncine::ParticleAffector
enum class	Type {   COLOR , SIZE , ROTATION , POSITION ,   VELOCITY }
Protected Attributes inherited from ncine::ParticleAffector
Type	type_
	Affector type.
bool	enabled_
	A flag indicating whether the affector is enabled or not.

Detailed Description

Particle color affector.

Member Function Documentation

affect()

void ncine::ColorAffector::affect ( Particle *  particle, float  normalizedAge  )

overridevirtual

Affects the color of the specified particle.

Implements ncine::ParticleAffector.

clearSteps()

void ncine::ColorAffector::clearSteps ( )

inlineoverridevirtual

Removes all steps.

Implements ncine::ParticleAffector.

numSteps()

unsigned int ncine::ColorAffector::numSteps ( ) const

inlineoverridevirtual

Returns the number of steps.

Implements ncine::ParticleAffector.

removeStep()

void ncine::ColorAffector::removeStep ( unsigned int  index )

overridevirtual

Removes the step at the specified position index.

Implements ncine::ParticleAffector.

---

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

• include/ncine/ParticleAffectors.h
• src/graphics/ParticleAffectors.cpp