bevy_symbios_shape 0.1.0

Bevy integration for Symbios Shape.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! # bevy_symbios_shape
//!
//! Bevy integration for [`symbios-shape`](https://crates.io/crates/symbios-shape) —
//! a CGA Shape Grammar engine for procedural architecture.
//!
//! ## Quick start
//!
//! ```ignore
//! use bevy::prelude::*;
//! use bevy_symbios_shape::prelude::*;
//! use symbios_shape::{Interpreter, Scope, grammar::parse_ops};
//!
//! fn main() {
//!     App::new()
//!         .add_plugins((DefaultPlugins, BevySymbiosShapePlugin))
//!         .add_systems(Startup, setup)
//!         .run();
//! }
//!
//! fn setup(
//!     mut commands: Commands,
//!     registry: Res<ShapeRegistry>,
//!     mut meshes: ResMut<Assets<Mesh>>,
//!     mut materials: ResMut<Assets<StandardMaterial>>,
//! ) {
//!     let mut interp = Interpreter::new();
//!     interp.add_rule("Lot",    parse_ops("Extrude(12) Split(Y) { 3: Ground | ~1: Upper | 2: Roof }").unwrap());
//!     interp.add_rule("Ground", parse_ops(r#"I("GroundFloor")"#).unwrap());
//!     interp.add_rule("Upper",  parse_ops(r#"I("Floor")"#).unwrap());
//!     interp.add_rule("Roof",   parse_ops(r#"Taper(0.8) I("Roof")"#).unwrap());
//!
//!     let footprint = Scope::new(
//!         symbios_shape::Vec3::ZERO,
//!         symbios_shape::Quat::IDENTITY,
//!         symbios_shape::Vec3::new(10.0, 0.0, 10.0),
//!     );
//!
//!     commands
//!         .spawn_shape(&interp, footprint, "Lot", &registry, &mut meshes, &mut materials)
//!         .unwrap();
//! }
//! ```
//!
//! ## Modules
//!
//! | Module | Purpose |
//! |---|---|
//! | [`transform`] | `scope_to_transform` — Sim-to-Real coordinate translation |
//! | [`mesh`] | `build_profiled_mesh` / `build_tapered_cuboid` — procedural mesh generation |
//! | [`registry`] | [`ShapeRegistry`] — asset routing table |
//! | [`spawner`] | [`SpawnShapeExt`] — `Commands` extension trait |

pub mod mesh;
pub mod registry;
pub mod spawner;
pub mod transform;

pub use registry::ShapeRegistry;
pub use spawner::SpawnShapeExt;
pub use transform::scope_to_transform;

/// Convenience re-exports for the most common types.
pub mod prelude {
    pub use crate::BevySymbiosShapePlugin;
    pub use crate::registry::ShapeRegistry;
    pub use crate::spawner::SpawnShapeExt;
    pub use crate::transform::scope_to_transform;
}

/// Bevy plugin that registers [`ShapeRegistry`] as a default resource.
///
/// Add this plugin to your [`App`] alongside [`DefaultPlugins`]:
///
/// ```ignore
/// App::new()
///     .add_plugins((DefaultPlugins, BevySymbiosShapePlugin))
///     // ...
/// ```
///
/// After the plugin is added, [`ShapeRegistry`] is available as a [`Resource`].
/// Populate it in a startup system before calling [`SpawnShapeExt::spawn_shape`].
///
/// [`App`]: bevy::prelude::App
/// [`DefaultPlugins`]: bevy::prelude::DefaultPlugins
/// [`Resource`]: bevy::prelude::Resource
pub struct BevySymbiosShapePlugin;

impl bevy::prelude::Plugin for BevySymbiosShapePlugin {
    fn build(&self, app: &mut bevy::prelude::App) {
        app.init_resource::<ShapeRegistry>();
    }
}