Expand description
Connect hoomd-rs simulations with the Bevy game engine.
Use HoomdBevyPlugin to create visual, interactive simulations. Add the
plugin to a Bevy App and it will step the simulation up to a configurable
limit number of steps per second. To display geometry on the screen, add one
more more setup methods from representation to the Startup schedule.
Then add a sync method to the Update schedule that synchronizes the entire
microstate (using the helper methods from representation).
§Examples
Many of the examples use HoomdBevyPlugin. Find them in the examples
directory in the hoomd-rs repository.
§Embedded assets.
hoomd-bevy provides the following assets:
embedded://hoomd_bevy/logo.png - The HOOMD logo (512 x 512).
§Feature flags
doc-example Make examples suitable for display in a web browser.
webgpu Compile for the WebGPU platform when building for the wasm32 target.
§Complete documentation
hoomd-bevy is is a part of hoomd-rs. Read the complete documentation
for more information.
Modules§
- representation
- Graphical elements that depict the simulation microstate.
Structs§
- Advance
Set - Systems that run to advance the simulation.
- Camera
Control2d - Settings used by the 2d camera controls.
- Hoomd
Bevy Plugin - Interface hoomd-rs simulations with the Bevy game engine.
- Keyboard
Input Set - Systems that run to process non-GUI keyboard input.
- Mouse
Input Set - Systems that run to process non-GUI mouse input.
- Parameters
Window State - State of the parameters window
- Settings
- Store parameters that influence how the simulation is executed.
- UiState
- State of the UI
Enums§
- Initial
Camera - Configure the initial camera view and set how the camera will be controlled.
Constants§
- BOUNDARY_
COLOR - The default color for the boundary representation.
- HIGHLIGHT_
COLOR - The default color for highlighted features.
- MUTED_
COLOR - The default color for a muted representation.
- PRIMARY_
COLOR - The default color for the primary representation (in 2D).
- PRIMARY_
COLOR_ 3D - The default color for the primary representation (darkened for 3D lighting).
Functions§
- add_
default_ plugins - Construct the default plugins.