gs.materials.PBD.Particle#

class genesis.engine.materials.PBD.particle.Particle(*, use_visual_raycasting: bool = False, rho: float = 1000.0, sampler: Literal['pbs', 'random', 'regular'] = 'pbs')[source]#

Bases: Base[PBDFreeParticleEntity]

Particle-based entities with no inter-particle interaction.

Note

This creates particle-based entities that have no inter-particle interaction at all; i.e. they are only affected by external forces. This is useful for creating particle-based animations. 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 x86 for now. Defaults to ‘pbs’ on supported platforms, ‘random’ otherwise.

rho: float#
sampler: Literal['pbs', 'random', 'regular']#
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'strict': True, 'validate_default': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].