Lamp-Da 0.1
A compact lantern project
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
lampda::modes::ParticleSystem< MaxParticuleCount > Class Template Reference

Define a particle system ALL PARTICLE SYSTEM SHARE THE SAME PARTICLE SUBSET. More...

#include <particle_system.hpp>

Public Member Functions

 ParticleSystem (const ParticleSystem &)=delete
 
void reset ()
 reset system to zero count
 
void set_max_particle_count (const uint16_t _particleCount)
 Call when you want to change the particle count of the simulation Can be called once when starting the particle system.
 
template<typename PositionGeneratorFunction >
void init_particules (const PositionGeneratorFunction &positionGeneratorFunction, const uint32_t color=colors::HTMLColorCode::White)
 Init the particles from a initialization function.
 
template<typename PositionGeneratorFunction >
bool init_deferred_particules (uint8_t maxParticlesToPop, const PositionGeneratorFunction &positionGeneratorFunction)
 Init the particles from a initialization function, in a timed defered way.
 
template<typename PositionGeneratorFunction , typename ColorGeneratorFunction >
bool init_deferred_particules (uint8_t maxParticlesToPop, const PositionGeneratorFunction &positionGeneratorFunction, const ColorGeneratorFunction &colorGeneratorFunction)
 Init the particles from a initialization function, in a timed defered way.
 
void iterate_no_collisions (const utils::vec3d &accelerationCartesian, const float deltaTime_s, const bool shouldContrain=true)
 Advance the particle simulation, ignoring collisions.
 
void iterate_with_collisions (const utils::vec3d &accelerationCartesian, const float deltaTime_s, const bool shouldContrain=true, const float viscosity=sandViscosity)
 Advance the particle simulation, taking collisions in account. A led holds one particle, and a blocked particle flows around the obstacle. Resting particles update less often.
 
template<typename ShouldDepopFunction >
uint16_t depop_particules (const ShouldDepopFunction &shouldDepopFunction)
 Filter particles depending on condition.
 
template<typename ShouldDepopFunction >
uint16_t depop_particules_indexed (const ShouldDepopFunction &shouldDepopFunction)
 Same as depop_particules, but the predicate also receives the particle slot index.
 
template<typename SampleColorFunction >
uint16_t show (const SampleColorFunction &sample_color, LampTy &lamp, const bool forceDisplay=false) const
 Display this particle system.
 
uint16_t show (LampTy &lamp, const bool forceDisplay=false) const
 
uint16_t get_number_of_active () const
 Return the number of active particles.
 

Protected Member Functions

bool is_position_taken (const int16_t pos) const
 Return True if the position is already occupied.
 
template<typename PositiongeneratorFunction >
void spawn_particule (const size_t index, const PositiongeneratorFunction &positionGeneratorFunction, const uint32_t color)
 Spawn a particle.
 

Detailed Description

template<size_t MaxParticuleCount>
class lampda::modes::ParticleSystem< MaxParticuleCount >

Define a particle system ALL PARTICLE SYSTEM SHARE THE SAME PARTICLE SUBSET.

Member Function Documentation

◆ depop_particules()

template<size_t MaxParticuleCount>
template<typename ShouldDepopFunction >
uint16_t lampda::modes::ParticleSystem< MaxParticuleCount >::depop_particules ( const ShouldDepopFunction &  shouldDepopFunction)
inline

Filter particles depending on condition.

Parameters
[in]shouldDepopFunctionA function, that given a particle, will return true if it needs to be removed from the simulation.
Returns
The number of particles left in the simulation.

◆ depop_particules_indexed()

template<size_t MaxParticuleCount>
template<typename ShouldDepopFunction >
uint16_t lampda::modes::ParticleSystem< MaxParticuleCount >::depop_particules_indexed ( const ShouldDepopFunction &  shouldDepopFunction)
inline

Same as depop_particules, but the predicate also receives the particle slot index.

Returns
The number of particles left in the simulation.

◆ init_deferred_particules() [1/2]

template<size_t MaxParticuleCount>
template<typename PositionGeneratorFunction >
bool lampda::modes::ParticleSystem< MaxParticuleCount >::init_deferred_particules ( uint8_t  maxParticlesToPop,
const PositionGeneratorFunction &  positionGeneratorFunction 
)
inline

Init the particles from a initialization function, in a timed defered way.

Parameters
[in]maxParticlesToPopMaximum particles to spawn at this call
[in]positionGeneratorFunctionFunction that takes an index and return a led strip index

◆ init_deferred_particules() [2/2]

template<size_t MaxParticuleCount>
template<typename PositionGeneratorFunction , typename ColorGeneratorFunction >
bool lampda::modes::ParticleSystem< MaxParticuleCount >::init_deferred_particules ( uint8_t  maxParticlesToPop,
const PositionGeneratorFunction &  positionGeneratorFunction,
const ColorGeneratorFunction &  colorGeneratorFunction 
)
inline

Init the particles from a initialization function, in a timed defered way.

Parameters
[in]maxParticlesToPopMaximum particles to spawn at this call
[in]positionGeneratorFunctionFunction that takes an index and return a led strip index
[in]colorGeneratorFunctionFunction that takes an index and return a color of the particle at this index

◆ init_particules()

template<size_t MaxParticuleCount>
template<typename PositionGeneratorFunction >
void lampda::modes::ParticleSystem< MaxParticuleCount >::init_particules ( const PositionGeneratorFunction &  positionGeneratorFunction,
const uint32_t  color = colors::HTMLColorCode::White 
)
inline

Init the particles from a initialization function.

Parameters
[in]positionGeneratorFunctionFunction that takes an index and return a ledstrip index

◆ iterate_no_collisions()

template<size_t MaxParticuleCount>
void lampda::modes::ParticleSystem< MaxParticuleCount >::iterate_no_collisions ( const utils::vec3d &  accelerationCartesian,
const float  deltaTime_s,
const bool  shouldContrain = true 
)
inline

Advance the particle simulation, ignoring collisions.

Parameters
[in]accelerationCartesian3d acceleration vector to apply to particles
[in]deltaTime_sTime since last update, in seconds
[in]shouldContrainIf true, will constrain the particles to the lamp body.

◆ iterate_with_collisions()

template<size_t MaxParticuleCount>
void lampda::modes::ParticleSystem< MaxParticuleCount >::iterate_with_collisions ( const utils::vec3d &  accelerationCartesian,
const float  deltaTime_s,
const bool  shouldContrain = true,
const float  viscosity = sandViscosity 
)
inline

Advance the particle simulation, taking collisions in account. A led holds one particle, and a blocked particle flows around the obstacle. Resting particles update less often.

Parameters
[in]accelerationCartesian3d acceleration vector to apply to particles
[in]deltaTime_sTime since last update, in seconds
[in]shouldContrainIf true, will constrain the particles to the lamp body.
[in]viscosityFrom 0 (liquid, levels itself) to 1 (sand, forms piles)

◆ show()

template<size_t MaxParticuleCount>
template<typename SampleColorFunction >
uint16_t lampda::modes::ParticleSystem< MaxParticuleCount >::show ( const SampleColorFunction &  sample_color,
LampTy &  lamp,
const bool  forceDisplay = false 
) const
inline

Display this particle system.

Parameters
[in]sample_colorsampling function for the particle color
[in,out]lampThe lamp object to write to

◆ spawn_particule()

template<size_t MaxParticuleCount>
template<typename PositiongeneratorFunction >
void lampda::modes::ParticleSystem< MaxParticuleCount >::spawn_particule ( const size_t  index,
const PositiongeneratorFunction &  positionGeneratorFunction,
const uint32_t  color 
)
inlineprotected

Spawn a particle.

Parameters
[in]indexIndex of this particle
[in]positionGeneratorFunctionSpawn function

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