viewport-lib 0.8.4

3D viewport rendering library
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

//! On-surface vector quantity utilities.
//!
//! Converts intrinsic (tangent-plane) vector fields and edge one-forms into
//! world-space [`GlyphItem`](crate::GlyphItem)s ready for submission to
//! [`SceneFrame::glyphs`](crate::renderer::types::SceneFrame::glyphs).
//!
//! # Quick-start
//!
//! ```rust,ignore
//! use viewport_lib::quantities::{vertex_intrinsic_to_glyphs, edge_one_form_to_glyphs};
//!
//! // Vertex intrinsic vectors : e.g. a tangential vortex field on a sphere.
//! let glyph = vertex_intrinsic_to_glyphs(
//!     &mesh.positions,
//!     &mesh.normals,
//!     mesh.tangents.as_deref(),
//!     &intrinsic_vecs,   // &[[f32; 2]] : (u, v) per vertex
//!     0.3,               // arrow scale
//! );
//! frame.scene.glyphs.push(glyph);
//!
//! // Edge one-forms : Whitney reconstruction per triangle.
//! let glyph = edge_one_form_to_glyphs(
//!     &mesh.positions,
//!     &mesh.indices,
//!     &edge_values,      // &[f32] : 3 values per triangle (e01, e12, e20)
//!     0.3,
//! );
//! frame.scene.glyphs.push(glyph);
//! ```
//!
//! # Tangent frames
//!
//! All functions accept an optional explicit tangent buffer (`[tx, ty, tz, w]`
//! format, matching [`MeshData::tangents`](crate::resources::MeshData::tangents)).
//! When omitted, smooth per-vertex frames are derived from the normals via
//! Gram-Schmidt orthogonalisation.

pub mod intrinsic_vectors;
pub mod one_forms;
pub mod polyline_vectors;
pub mod tangent_frames;

pub use intrinsic_vectors::{face_intrinsic_to_glyphs, vertex_intrinsic_to_glyphs};
pub use one_forms::edge_one_form_to_glyphs;
pub use polyline_vectors::{polyline_edge_vectors_to_glyphs, polyline_node_vectors_to_glyphs};
pub use tangent_frames::{
    compute_face_tangent_frames, compute_vertex_tangent_frames, tangents_from_explicit,
};