refactor(scene): group modules into role-based subfolders

Move the 30 flat modules under src/scene/ into six folders by role:
convert (entity→geometry), text (fonts/shaping), model (render models),
pick (hit-test/selection/grips/xclip), view (camera/transform/render),
cache (block + property caches). pipeline/ is unchanged.

Full path migration — all `scene::X` references become
`scene::<group>::X`, no compatibility re-exports. render.rs items that
were `pub(super)` (parent was scene) become `pub(in crate::scene)` to
keep their original scene-wide visibility.

No behavior change; build and tests are green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Hakan SevenandClaude Opus 4.8 committed 2026-06-16 11:33:46 +03:00
1 parent cd048165a9
commit 7fe7e0230d
160 files changed
+732 -715

No files matched your search

+428
View File
@@ -0,0 +1,428 @@
// TrueType/OpenType glyph → CAD wire strokes.
//
// Pulls a system font's bytes from `sysfont`, extracts a glyph's outline with
// `ttf-parser`, and flattens the quadratic/cubic Bézier contours into polyline
// strokes — the same `lff::Glyph` shape the LFF stroke engine produces, so the
// text layout code can consume either without caring which font kind it is.
//
// Coordinates are normalized to the **same 9-unit cap-height space the LFF
// engine uses**: a capital letter is 9 units tall with the baseline at y = 0.
// That makes a TTF glyph a drop-in for an LFF one — the existing text layout
// scales both by `height / 9.0`, so TTF and stroke text share one pipeline.
// Cap height comes from the font's OS/2 table; if absent we approximate it as
// 0.7 × units-per-em.
//
// Unlike LFF single-stroke glyphs, TTF contours are closed outlines (the glyph
// boundary). Counters — the hole in "O" or "A" — come through as separate
// closed contours; the wire renderer simply draws every contour.
use crate::scene::text::lff::Glyph;
use crate::scene::text::sysfont;
use rustc_hash::FxHashMap as HashMap;
use std::sync::{Arc, Mutex, OnceLock};
/// Bézier flattening step counts. Outlines are small on screen most of the
/// time; these are a fixed budget that keeps curves smooth without exploding
/// vertex counts. Cubic gets more steps because OTF/CFF curves swing wider.
const QUAD_STEPS: usize = 8;
const CUBIC_STEPS: usize = 12;
/// Glyph-unit cap height the layout scales by `height / 9.0`.
const CAP_UNITS: f32 = 9.0;
/// Collects `ttf-parser` outline callbacks into closed contours, normalized so
/// the font's cap height equals [`CAP_UNITS`].
struct OutlineFlattener {
/// Font-unit → 9-unit-cap-height scale factor.
k: f32,
/// Pen position (9-unit) added to every vertex — lets a shaped glyph carry
/// its run offset. Zero for a standalone glyph.
offset: [f32; 2],
contours: Vec<Vec<[f32; 2]>>,
cur: Vec<[f32; 2]>,
start: [f32; 2],
pos: [f32; 2],
}
impl OutlineFlattener {
fn new(k: f32) -> Self {
OutlineFlattener {
k,
offset: [0.0, 0.0],
contours: Vec::new(),
cur: Vec::new(),
start: [0.0, 0.0],
pos: [0.0, 0.0],
}
}
fn n(&self, x: f32, y: f32) -> [f32; 2] {
[x * self.k + self.offset[0], y * self.k + self.offset[1]]
}
fn flush(&mut self) {
if self.cur.len() >= 2 {
self.contours.push(std::mem::take(&mut self.cur));
} else {
self.cur.clear();
}
}
}
impl ttf_parser::OutlineBuilder for OutlineFlattener {
fn move_to(&mut self, x: f32, y: f32) {
self.flush();
let p = self.n(x, y);
self.start = p;
self.pos = p;
self.cur.push(p);
}
fn line_to(&mut self, x: f32, y: f32) {
let p = self.n(x, y);
self.pos = p;
self.cur.push(p);
}
fn quad_to(&mut self, cx: f32, cy: f32, x: f32, y: f32) {
let p0 = self.pos;
let c = self.n(cx, cy);
let p = self.n(x, y);
for i in 1..=QUAD_STEPS {
let t = i as f32 / QUAD_STEPS as f32;
let u = 1.0 - t;
let bx = u * u * p0[0] + 2.0 * u * t * c[0] + t * t * p[0];
let by = u * u * p0[1] + 2.0 * u * t * c[1] + t * t * p[1];
self.cur.push([bx, by]);
}
self.pos = p;
}
fn curve_to(&mut self, c1x: f32, c1y: f32, c2x: f32, c2y: f32, x: f32, y: f32) {
let p0 = self.pos;
let c1 = self.n(c1x, c1y);
let c2 = self.n(c2x, c2y);
let p = self.n(x, y);
for i in 1..=CUBIC_STEPS {
let t = i as f32 / CUBIC_STEPS as f32;
let u = 1.0 - t;
let bx = u * u * u * p0[0]
+ 3.0 * u * u * t * c1[0]
+ 3.0 * u * t * t * c2[0]
+ t * t * t * p[0];
let by = u * u * u * p0[1]
+ 3.0 * u * u * t * c1[1]
+ 3.0 * u * t * t * c2[1]
+ t * t * t * p[1];
self.cur.push([bx, by]);
}
self.pos = p;
}
fn close(&mut self) {
// Close the ring back to its start so the wire forms a loop.
if self.cur.first().map_or(false, |f| *f != self.pos) {
self.cur.push(self.start);
}
self.flush();
}
}
// ── Cache ────────────────────────────────────────────────────────────────────
type GlyphCache = HashMap<(String, char), Option<Arc<Glyph>>>;
fn cache() -> &'static Mutex<GlyphCache> {
static CACHE: OnceLock<Mutex<GlyphCache>> = OnceLock::new();
CACHE.get_or_init(|| Mutex::new(HashMap::default()))
}
/// Em-normalized outline for one character of a system font family. Returns
/// `None` if the family is not installed or the glyph is missing. Result is
/// cached per `(family, char)`.
pub fn glyph(family: &str, ch: char) -> Option<Arc<Glyph>> {
let key = (family.to_string(), ch);
if let Some(hit) = cache().lock().unwrap().get(&key) {
return hit.clone();
}
let built = sysfont::with_face_data(family, |data, index| {
let face = ttf_parser::Face::parse(data, index).ok()?;
let gid = face.glyph_index(ch)?;
let k = cap_scale(&face);
let advance = face.glyph_hor_advance(gid).unwrap_or(0) as f32 * k;
let mut fl = OutlineFlattener::new(k);
// A glyph with no outline (e.g. space) still has a valid advance.
face.outline_glyph(gid, &mut fl);
fl.flush();
Some(Arc::new(Glyph {
strokes: fl.contours,
advance,
}))
})
.flatten();
cache().lock().unwrap().insert(key, built.clone());
built
}
/// Font-unit → 9-unit-cap-height factor for a parsed face. Cap height comes
/// from the OS/2 table; absent, we approximate it as 0.7 × units-per-em.
fn cap_scale(face: &ttf_parser::Face) -> f32 {
let upem = face.units_per_em() as f32;
let cap = face
.capital_height()
.filter(|&c| c > 0)
.map(|c| c as f32)
.unwrap_or(0.7 * upem);
CAP_UNITS / cap
}
// ── Shaping ────────────────────────────────────────────────────────────────
/// One shaped glyph, positioned within its run. Strokes are in 9-unit space and
/// already carry the glyph's pen position (cumulative advance + shaping offset),
/// so the caller only applies the run's own transform.
pub struct PlacedGlyph {
pub strokes: Vec<Vec<[f32; 2]>>,
}
/// A fully shaped run.
pub struct ShapedRun {
pub glyphs: Vec<PlacedGlyph>,
/// Total pen advance of the run (9-unit).
pub advance: f32,
}
type ShapeCache = HashMap<(String, String), Option<Arc<ShapedRun>>>;
fn shape_cache() -> &'static Mutex<ShapeCache> {
static CACHE: OnceLock<Mutex<ShapeCache>> = OnceLock::new();
CACHE.get_or_init(|| Mutex::new(HashMap::default()))
}
/// Pixel font size the layout runs at. Positions and outlines are normalized
/// out of pixel space afterwards, so the exact value only affects rounding.
const SHAPE_FS: f32 = 1000.0;
/// Shared cosmic-text layout engine, loaded once with the system fonts. Held
/// behind a mutex because `set_text`/`shape` need `&mut FontSystem`.
fn font_system() -> &'static Mutex<cosmic_text::FontSystem> {
static FS: OnceLock<Mutex<cosmic_text::FontSystem>> = OnceLock::new();
FS.get_or_init(|| Mutex::new(cosmic_text::FontSystem::new()))
}
/// Lay out and shape `text` in `family` with cosmic-text — ligatures, Arabic
/// joining, kerning, bidi reordering, and automatic font fallback (a glyph the
/// chosen family lacks is taken from another installed font). Each resulting
/// glyph is outlined from its *resolved* font and normalized into 9-unit
/// cap-height space (cap height of the primary family). Cached per
/// `(family, text)`; `None` for a non-system family.
pub fn shape_run(family: &str, text: &str) -> Option<Arc<ShapedRun>> {
if text.is_empty() {
return None;
}
let key = (family.to_string(), text.to_string());
if let Some(hit) = shape_cache().lock().unwrap().get(&key) {
return hit.clone();
}
let built = build_shaped(family, text).map(Arc::new);
shape_cache().lock().unwrap().insert(key, built.clone());
built
}
type FallbackCache = HashMap<char, Option<Arc<Glyph>>>;
fn fallback_cache() -> &'static Mutex<FallbackCache> {
static CACHE: OnceLock<Mutex<FallbackCache>> = OnceLock::new();
CACHE.get_or_init(|| Mutex::new(HashMap::default()))
}
/// Last-resort glyph for a character missing from a stroke (LFF) font: let
/// cosmic-text pick whichever installed font covers it, then outline it from
/// that font normalized to 9-unit cap height. Returns `None` if no system font
/// has the character. Cached per character.
///
/// The result is a filled-outline glyph, so it visually differs from the
/// surrounding single-stroke text — accepted as the price of covering scripts
/// no stroke font provides.
pub fn fallback_glyph(ch: char) -> Option<Arc<Glyph>> {
if let Some(hit) = fallback_cache().lock().unwrap().get(&ch) {
return hit.clone();
}
let built = build_fallback(ch);
fallback_cache().lock().unwrap().insert(ch, built.clone());
built
}
fn build_fallback(ch: char) -> Option<Arc<Glyph>> {
use cosmic_text::{Attrs, Buffer, Metrics, Shaping};
let mut fs = font_system().lock().unwrap();
// Default family → cosmic's own fallback search chooses a covering font.
let attrs = Attrs::new();
let mut buf = Buffer::new(&mut fs, Metrics::new(SHAPE_FS, SHAPE_FS));
buf.set_size(&mut fs, None, None);
let s = ch.to_string();
buf.set_text(&mut fs, &s, &attrs, Shaping::Advanced, None);
buf.shape_until_scroll(&mut fs, false);
for run in buf.layout_runs() {
for g in run.glyphs.iter() {
if g.glyph_id == 0 {
continue; // .notdef — this font doesn't really cover it
}
let face_index = fs.db_mut().face(g.font_id).map(|f| f.index).unwrap_or(0);
let font = fs.get_font(g.font_id, g.font_weight)?;
let face = ttf_parser::Face::parse(font.data(), face_index).ok()?;
let k = cap_scale(&face);
let gid = ttf_parser::GlyphId(g.glyph_id);
let advance = face.glyph_hor_advance(gid).unwrap_or(0) as f32 * k;
let mut fl = OutlineFlattener::new(k);
face.outline_glyph(gid, &mut fl);
fl.flush();
return Some(Arc::new(Glyph {
strokes: fl.contours,
advance,
}));
}
}
None
}
fn build_shaped(family: &str, text: &str) -> Option<ShapedRun> {
use cosmic_text::{Attrs, Buffer, Family, Metrics, Shaping};
// Cap height / units-per-em of the requested family set the normalization:
// its capital letters become CAP_UNITS tall, and every fallback glyph is
// scaled into the same pixel-per-unit so sizes stay consistent.
let (upem_p, cap_p) = sysfont::with_face_data(family, |data, idx| {
let f = ttf_parser::Face::parse(data, idx).ok()?;
let upem = f.units_per_em() as f32;
let cap = f
.capital_height()
.filter(|&c| c > 0)
.map(|c| c as f32)
.unwrap_or(0.7 * upem);
Some((upem, cap))
})
.flatten()?;
// Pixel (at SHAPE_FS) → 9-unit cap-height factor.
let px_to_9 = CAP_UNITS * upem_p / (SHAPE_FS * cap_p);
let mut fs = font_system().lock().unwrap();
let attrs = Attrs::new().family(Family::Name(family));
let mut buf = Buffer::new(&mut fs, Metrics::new(SHAPE_FS, SHAPE_FS));
// No wrapping: a run is a single line.
buf.set_size(&mut fs, None, None);
buf.set_text(&mut fs, text, &attrs, Shaping::Advanced, None);
buf.shape_until_scroll(&mut fs, false);
let mut glyphs: Vec<PlacedGlyph> = Vec::new();
let mut advance = 0.0_f32;
for run in buf.layout_runs() {
advance = advance.max(run.line_w * px_to_9);
for g in run.glyphs.iter() {
let face_index = fs.db_mut().face(g.font_id).map(|f| f.index).unwrap_or(0);
let Some(font) = fs.get_font(g.font_id, g.font_weight) else {
continue;
};
let Ok(face) = ttf_parser::Face::parse(font.data(), face_index) else {
continue;
};
let upem_g = face.units_per_em() as f32;
// Glyph font-units → 9-unit: to pixels (at SHAPE_FS) then to units.
let scale_g = (SHAPE_FS / upem_g) * px_to_9;
// Absolute pen position (px) → 9-unit. `physical()` shows x_offset /
// y_offset are fractions of font size.
let pen_x = (g.x + SHAPE_FS * g.x_offset) * px_to_9;
let pen_y = -(SHAPE_FS * g.y_offset) * px_to_9; // outlines are y-up
let mut fl = OutlineFlattener::new(scale_g);
fl.offset = [pen_x, pen_y];
face.outline_glyph(ttf_parser::GlyphId(g.glyph_id), &mut fl);
fl.flush();
if !fl.contours.is_empty() {
glyphs.push(PlacedGlyph {
strokes: fl.contours,
});
}
}
}
if advance <= 0.0 && glyphs.is_empty() {
return None;
}
Some(ShapedRun { glyphs, advance })
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn shape_run_falls_back_for_missing_script() {
let fams = sysfont::families();
if fams.is_empty() {
eprintln!("no system fonts; skipping");
return;
}
// A typical Latin family lacks CJK; cosmic-text should still resolve the
// ideograph from a fallback font. If the machine has no CJK font at all
// the count stays 1 — tolerated, but never a panic or empty run.
let fam = fams
.iter()
.find(|f| glyph(f, 'A').is_some())
.expect("family");
let run = shape_run(fam, "A中").expect("shaped");
eprintln!("fallback run glyphs={}", run.glyphs.len());
assert!(!run.glyphs.is_empty());
}
#[test]
fn shape_run_positions_glyphs() {
let fams = sysfont::families();
if fams.is_empty() { eprintln!("no fonts; skip"); return; }
let fam = fams.iter().find(|f| glyph(f, 'A').is_some()).expect("family");
let run = shape_run(fam, "AVA").expect("shaped");
eprintln!("glyphs={} advance={:.3}", run.glyphs.len(), run.advance);
assert_eq!(run.glyphs.len(), 3);
assert!(run.advance > 0.0);
// glyphs must be laid out left-to-right: each glyph's strokes sit at a
// greater x than the previous glyph's start.
let xs: Vec<f32> = run.glyphs.iter()
.filter_map(|g| g.strokes.iter().flatten().map(|p| p[0]).fold(None, |m,x| Some(m.map_or(x, |mm:f32| mm.min(x)))))
.collect();
assert!(xs.windows(2).all(|w| w[1] >= w[0] - 1.0), "glyphs not L->R: {:?}", xs);
}
#[test]
fn smoke_outline_first_family() {
let fams = sysfont::families();
if fams.is_empty() {
eprintln!("no system fonts; skipping");
return;
}
// Find any family that yields an 'A' outline.
let mut ok = false;
for fam in fams.iter().take(20) {
if let Some(g) = glyph(fam, 'A') {
eprintln!(
"{}: contours={} advance={:.4} verts={}",
fam,
g.strokes.len(),
g.advance,
g.strokes.iter().map(|s| s.len()).sum::<usize>()
);
assert!(g.advance > 0.0);
assert!(!g.strokes.is_empty());
ok = true;
break;
}
}
assert!(ok, "no family produced an 'A' outline");
}
}