particle_source_or_sink
ParticleSink
Bases: ParticleRemover
ParticleRemover where physical particles are removed continuously within a cylindrical volume located at the metalink pose.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj |
StatefulObject
|
Object to which this state will be applied |
required |
conditions |
dict
|
Dictionary mapping the names of ParticleSystem (str) to None or the corresponding condition / list of conditions (where None represents no conditions) necessary in order for this particle modifier to be able to modify particles belonging to @ParticleSystem. Each condition should be a function, whose signature is as follows:
Where @obj is the specific object that this ParticleModifier state belongs to. For a given ParticleSystem, if all of its conditions evaluate to True and particles are detected within this particle modifier area, then we potentially modify those particles |
required |
sink_radius |
float
|
Radius of the cylinder representing particles' sinking volume |
required |
sink_height |
float
|
Height of the cylinder representing particles' sinking volume |
required |
Source code in omnigibson/object_states/particle_source_or_sink.py
ParticleSource
Bases: ParticleApplier
ParticleApplier where physical particles are spawned continuously in a cylindrical fashion from the metalink pose.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj |
StatefulObject
|
Object to which this state will be applied |
required |
conditions |
dict
|
Dictionary mapping the names of ParticleSystem (str) to None or the corresponding condition / list of conditions (where None represents no conditions) necessary in order for this particle modifier to be able to modify particles belonging to @ParticleSystem. Each condition should be a function, whose signature is as follows:
Where @obj is the specific object that this ParticleModifier state belongs to. For a given ParticleSystem, if all of its conditions evaluate to True and particles are detected within this particle modifier area, then we potentially modify those particles |
required |
source_radius |
float
|
Radius of the cylinder representing particles' spawning volume |
required |
source_height |
float
|
Height of the cylinder representing particles' spawning volume |
required |
initial_speed |
float
|
The initial speed for generated particles. Note that the direction of the velocity is inferred from the particle sampling process |
0.0
|