hoomd_bevy/representation/
mod.rs

1// Copyright (c) 2024-2026 The Regents of the University of Michigan.
2// Part of hoomd-rs, released under the BSD 3-Clause License.
3
4//! Graphical elements that depict the simulation microstate.
5//!
6//! The `representation` module contains types that you can use to visually represent
7//! your sites, bodies, or calculated properties of the simulation state. Each type
8//! has implementation dependent details, although most include a `setup` method
9//! that you need to add to the `Startup` schedule and helper methods that you can call
10//! in the `Update` schedule to synchronize the state.
11//!
12//! Most of the types in `representation` are opaque primitives intended to
13//! represent sites or bodies. Some, such as those ending in `Boundary` are thin
14//! outlines intended to represent the simulation boundaries.
15
16pub mod disk;
17pub mod ellipse;
18pub mod plane_mesh;
19pub mod surface_mesh;
20
21pub(crate) mod rectangular_boundary;
22pub use rectangular_boundary::RectangularBoundary;
23
24pub(crate) mod hyperbolic_disk;
25pub use hyperbolic_disk::{HyperbolicDisk, HyperbolicDiskAssets, HyperbolicDiskMaterial};
26
27pub(crate) mod hyperbolic_polygon;
28pub use hyperbolic_polygon::{
29    HyperbolicPolygon, HyperbolicPolygonAssets, HyperbolicPolygonMaterial,
30    HyperbolicPolygonMaterialParameters,
31};