honeycomb_render/
lib.rs

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
//! # honeycomb-render
//!
//! This crate implements a graphical debugging tool using the `bevy` crate. The [`App`] structure
//! can be used to render a given combinatorial map, using underlying ECS logic to render map
//! items.
//!
//! All the ECS code used to render maps is left public, allowing advanced user to customize the
//! rendering tool to account for user-defined attributes.
//!
//! Note that rendering large maps may require running the program in `release` mode.
//!
//! ## Quickstart
//!
//! Examples are available in the dedicated crate.

// ------ CUSTOM LINTS

// more lints
#![warn(clippy::pedantic)]
#![warn(missing_docs)]
// some exceptions
#![allow(clippy::module_name_repetitions)]
#![allow(clippy::cast_possible_truncation)]
#![allow(clippy::cast_sign_loss)]
#![allow(clippy::cast_precision_loss)]
#![allow(clippy::similar_names)]
#![allow(clippy::must_use_candidate)]
#![allow(clippy::needless_pass_by_value)] // all ECS systems are flagged with this one

// ------ MODULE DECLARATIONS

mod app;
mod capture;
mod gui;
mod inspector;
mod options;
mod render;

// ------ PUBLIC API

// out of the box render tool

pub use app::App;

// item for custom composition

/// plugins used to build the default [`App`]
pub mod plugins {
    pub use crate::capture::CapturePlugin;
    pub use crate::gui::GuiPlugin;
    pub use crate::options::OptionsPlugin;
    pub use crate::render::ScenePlugin;
}

/// bundles used to build the default [`App`]
pub mod bundles {
    pub use crate::capture::ecs_data::{
        DartBodyBundle, DartHeadBundle, EdgeBundle, FaceBundle, VertexBundle,
    };
}

/// components used to build the default [`App`]
pub mod components {
    pub use crate::capture::ecs_data::{
        Beta, CaptureId, DartBody, DartHead, DartId, Edge, EdgeId, Face, FaceId, Vertex, VertexId,
        Volume, VolumeId,
    };
    pub use crate::render::camera::PanOrbitCamera;
}

/// resources used to build the default [`App`]
pub mod resources {
    pub use crate::capture::ecs_data::{FaceNormals, MapVertices};
    pub use crate::options::resource::*;
}

/// systems used to build the default [`App`]
pub mod systems {
    pub use crate::capture::system::*;
    pub use crate::inspector::tab::draw_inspected_data;
    pub use crate::options::tab::draw_options;
    pub use crate::render::{
        camera::{cursor_in_render, update_camera},
        picking::update_picking,
        scene::setup_scene,
        update::*,
    };
}