gs.materials.PBD.Particle#

class genesis.engine.materials.PBD.particle.Particle(rho=1000.0, sampler=None)[source]#

Bases: Base

The liquid material class for PBD.

Note

This creates particle-based entities that has no inter-particle interaction at all; i.e. it is only affected by external forces. This is useful for creating particle-based animations. This material will be handled by the PBD solver, but there’s actually nothing to solve really. It’s just hosted under the PBD system.

Parameters:

  • rho (float, optional) – The rest density. Default is 1000.0.

  • sampler (str, optional) – Particle sampler (‘pbs’, ‘regular’, ‘random’). Note that ‘pbs’ is only supported on Linux for now. Defaults to ‘pbs’ on supported platforms, ‘random’ otherwise.

property rho#

The rest density.

property sampler#

Particle sampler (‘pbs’, ‘regular’, ‘random’).