honeycomb-render 0.11.0

Visualization tool for combinatorial maps
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! # 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.
//!

// ------ 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 gui;
mod import_map;
mod options;
mod render_map;
mod scene;

// ------ PUBLIC API

// out of the box render tool

use bevy::prelude::*;
use honeycomb_core::cmap::{CMap2, CMap3};
use honeycomb_core::geometry::CoordsFloat;

/// Main rendering function.
pub fn render_2d_map<T: CoordsFloat>(cmap: CMap2<T>) {
    let mut app = App::new();
    app.insert_resource(resources::Map(cmap));
    app.init_gizmo_group::<resources::DartGizmos>()
        .init_gizmo_group::<resources::VertexGizmos>()
        .init_gizmo_group::<resources::EdgeGizmos>();
    app.add_systems(Startup, import_map::extract_data_from_map::<T>);
    // resource
    app.insert_resource(Msaa::Sample4)
        .insert_resource(ClearColor(Color::srgb(0.9, 0.9, 0.9)));
    // plugins
    app.add_plugins(DefaultPlugins)
        .add_plugins(plugins::OptionsPlugin)
        .add_plugins(plugins::GuiPlugin)
        .add_plugins(plugins::ScenePlugin);

    app.run();
}

/// Main rendering function.
pub fn render_3d_map<T: CoordsFloat>(cmap: CMap3<T>) {
    let mut app = App::new();
    app.insert_resource(resources::Map3(cmap));
    app.init_gizmo_group::<resources::DartGizmos>()
        .init_gizmo_group::<resources::VertexGizmos>()
        .init_gizmo_group::<resources::EdgeGizmos>();
    app.add_systems(Startup, import_map::extract_data_from_3d_map::<T>);
    // resource
    app.insert_resource(Msaa::Sample4)
        .insert_resource(ClearColor(Color::srgb(0.9, 0.9, 0.9)));
    // plugins
    app.add_plugins(DefaultPlugins)
        .add_plugins(plugins::OptionsPlugin)
        .add_plugins(plugins::GuiPlugin)
        .add_plugins(plugins::ScenePlugin);

    app.run();
}
// item for custom composition

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

/// bundles used to build the default [`App`]
pub mod bundles {
    pub use crate::import_map::{DartBundle, EdgeBundle, FaceBundle, VertexBundle};
}

/// components used to build the default [`App`]
pub mod components {
    pub use crate::import_map::{
        Beta, Dart, DartId, Edge, EdgeId, Face, FaceId, Vertex, VertexId, Volume, VolumeId,
    };
}

/// resources used to build the default [`App`]
pub mod resources {
    pub use crate::gui::WindowVisible;
    pub use crate::import_map::{FaceNormals, Map, Map3, MapVertices, VolumeNormals};
    pub use crate::options::{
        DartHeadMul, DartRenderColor, DartShrink, DartWidth, EdgeRenderColor, EdgeWidth,
        FaceRenderColor, FaceShrink, VertexRenderColor, VertexWidth, VolumeRenderColor,
        VolumeShrink,
    };
    pub use crate::render_map::{DartGizmos, EdgeGizmos, FaceGizmos, VertexGizmos};
}

/// systems used to build the default [`App`]
pub mod systems {
    pub use crate::gui::{draw_inspected_data, draw_options};
    pub use crate::import_map::{extract_data_from_3d_map, extract_data_from_map};
    pub use crate::render_map::{
        render_dart_enabled, render_darts, render_darts_3d, render_edge_enabled, render_edges,
        render_face_enabled, render_faces, render_vertex_enabled, render_vertices,
    };
}