Momentum Scripting v1
Loading...
Searching...
No Matches
MOMENTUM_NAMESPACE::ParticleDistribution Class Reference

#include <ParticleDistribution.h>

Public Member Functions

unsigned int getNumParticleModels ()
 
ParticleModelVector getParticleModels () const
 
std::shared_ptr< ParticleModelgetRandomModel ()
 

Friends

class GranularBodySystem
 
class Simulation
 

Detailed Description

A wrapper class for a ParticleDistribution of ParticleModels.

It is primary used in Emitters to create continuous flows of particles based on the models within.

Member Function Documentation

◆ getNumParticleModels()

unsigned int MOMENTUM_NAMESPACE::ParticleDistribution::getNumParticleModels ( )
Returns
get the number of particle models inside the distribution.

◆ getParticleModels()

ParticleModelVector MOMENTUM_NAMESPACE::ParticleDistribution::getParticleModels ( ) const
Returns
a vector of the ParticleModels inside the ParticleDistribution.

◆ getRandomModel()

std::shared_ptr< ParticleModel > MOMENTUM_NAMESPACE::ParticleDistribution::getRandomModel ( )
Returns
a random particle model inside the distribution
Note
- The probability for returning a specific model is dependent on the model weight relative to the other models.

Friends And Related Function Documentation

◆ GranularBodySystem

friend class GranularBodySystem
friend

◆ Simulation

friend class Simulation
friend