honeycomb_render/
lib.rs

1//! # honeycomb-render
2//!
3//! This crate implements a graphical debugging tool using the `bevy` crate. The [`App`] structure
4//! can be used to render a given combinatorial map, using underlying ECS logic to render map
5//! items.
6//!
7//! All the ECS code used to render maps is left public, allowing advanced user to customize the
8//! rendering tool to account for user-defined attributes.
9//!
10//! Note that rendering large maps may require running the program in `release` mode.
11//!
12
13// ------ CUSTOM LINTS
14
15// more lints
16#![warn(clippy::pedantic)]
17#![warn(missing_docs)]
18// some exceptions
19#![allow(clippy::module_name_repetitions)]
20#![allow(clippy::cast_possible_truncation)]
21#![allow(clippy::cast_sign_loss)]
22#![allow(clippy::cast_precision_loss)]
23#![allow(clippy::similar_names)]
24#![allow(clippy::must_use_candidate)]
25#![allow(clippy::needless_pass_by_value)] // all ECS systems are flagged with this one
26
27// ------ MODULE DECLARATIONS
28
29mod gui;
30mod import_map;
31mod options;
32mod render_map;
33mod scene;
34
35// ------ PUBLIC API
36
37// out of the box render tool
38
39use bevy::prelude::*;
40use honeycomb_core::cmap::CMap2;
41use honeycomb_core::geometry::CoordsFloat;
42
43/// Main rendering function.
44pub fn render_2d_map<T: CoordsFloat>(cmap: CMap2<T>) {
45    let mut app = App::new();
46    app.insert_resource(resources::Map(cmap));
47    app.init_gizmo_group::<resources::DartGizmos>()
48        .init_gizmo_group::<resources::VertexGizmos>()
49        .init_gizmo_group::<resources::EdgeGizmos>();
50    app.add_systems(Startup, import_map::extract_data_from_map::<T>);
51    // resource
52    app.insert_resource(Msaa::Sample4)
53        .insert_resource(ClearColor(Color::srgb(0.9, 0.9, 0.9)));
54    // plugins
55    app.add_plugins(DefaultPlugins)
56        .add_plugins(plugins::OptionsPlugin)
57        .add_plugins(plugins::GuiPlugin)
58        .add_plugins(plugins::ScenePlugin);
59
60    app.run();
61}
62
63// item for custom composition
64
65/// plugins used to build the default [`App`]
66pub mod plugins {
67    pub use crate::gui::GuiPlugin;
68    pub use crate::options::OptionsPlugin;
69    pub use crate::scene::ScenePlugin;
70}
71
72/// bundles used to build the default [`App`]
73pub mod bundles {
74    pub use crate::import_map::{DartBundle, EdgeBundle, FaceBundle, VertexBundle};
75}
76
77/// components used to build the default [`App`]
78pub mod components {
79    pub use crate::import_map::{
80        Beta, Dart, DartId, Edge, EdgeId, Face, FaceId, Vertex, VertexId, Volume, VolumeId,
81    };
82}
83
84/// resources used to build the default [`App`]
85pub mod resources {
86    pub use crate::gui::WindowVisible;
87    pub use crate::import_map::{FaceNormals, Map, MapVertices, VolumeNormals};
88    pub use crate::options::{
89        DartHeadMul, DartRenderColor, DartShrink, DartWidth, EdgeRenderColor, EdgeWidth,
90        FaceRenderColor, FaceShrink, VertexRenderColor, VertexWidth, VolumeRenderColor,
91        VolumeShrink,
92    };
93    pub use crate::render_map::{DartGizmos, EdgeGizmos, FaceGizmos, VertexGizmos};
94}
95
96/// systems used to build the default [`App`]
97pub mod systems {
98    pub use crate::gui::{draw_inspected_data, draw_options};
99    pub use crate::import_map::extract_data_from_map;
100    pub use crate::render_map::{
101        render_dart_enabled, render_darts, render_edge_enabled, render_edges, render_face_enabled,
102        render_faces, render_vertex_enabled, render_vertices,
103    };
104}
honeycomb_render/lib.rs

honeycomb_render/
lib.rs
