concinnity-dev 0.19.9

// src/editor/hook/outline_drive.rs
//
// EditorHook: the extent-outline drive. Each frame it appends the wireframes
// of the selection's spatial extents (and any category the Display menu keeps
// always-on) to the frame's world-space line buffer: trigger-volume colliders,
// light ranges and cones, camera frusta, probe bounds, prop colliders. Shapes
// read the live components (and the seeded Transform, so a gizmo drag moves
// the outline), so form edits and drags update immediately. The lines ride
// the renderer's line pass, which handles depth: occluded runs draw faint.

use super::*;
use crate::components::{
    Collider, PointLight, RectAreaLight, RectAreaLightGeometry, ReflectionProbe,
    SPOT_MAX_ANGLE_DEG, SpotLight, SpotLightGeometry, Transform, TriggerVolume,
};
use concinnity_core::gfx::lines::Line;
use outlines::shapes::{self, Stroke};

// What one entity's shape generator reads: its live entity, its authored
// entry and type, the frame's viewport, and the stroke its row draws with.
// Passed by reference so a shape takes only what it uses.
struct ShapeCtx<'a> {
    world: &'a World,
    entity: crate::ecs::Entity,
    ty: &'a str,
    entry: &'a serde_json::Value,
    vp: [f32; 2],
    stroke: Stroke,
}

type ShapeFn = fn(&ShapeCtx, &mut Vec<Line>);

// Every outlineable component type with its display category and shape. One
// row per type keeps the category map and the shape dispatch from drifting
// apart; Colliders is not type-keyed (any entity carrying a Collider).
const EXTENTS: [(&str, outlines::Category, ShapeFn); 6] = [
    ("TriggerVolume", outlines::Category::Volumes, push_trigger),
    ("PointLight", outlines::Category::Lights, push_point_light),
    ("SpotLight", outlines::Category::Lights, push_spot_light),
    ("RectAreaLight", outlines::Category::Lights, push_rect_light),
    ("Camera3D", outlines::Category::Cameras, push_camera),
    ("ReflectionProbe", outlines::Category::Probes, push_probe),
];

impl EditorHook {
    // Append this frame's extent outlines. Nothing while the HUD is hidden or
    // the sim is playing; otherwise the selection always outlines and the
    // Display menu's category toggles add their always-on layer.
    pub(super) fn push_extent_lines(&self, world: &World, vp: [f32; 2], out: &mut Vec<Line>) {
        if !self.hud_visible || self.sim.playing() {
            return;
        }
        if self.selection.iter().next().is_none() && !self.extent_show.any() {
            return;
        }
        let mut budget = outlines::MAX_OUTLINED;
        // Selected entries first, so the cap can never starve the selection.
        self.push_outline_pass(world, vp, out, true, &mut budget);
        self.push_outline_pass(world, vp, out, false, &mut budget);
    }

    fn push_outline_pass(
        &self,
        world: &World,
        vp: [f32; 2],
        out: &mut Vec<Line>,
        selected_pass: bool,
        budget: &mut usize,
    ) {
        let colliders_on = self.extent_show.contains(outlines::Category::Colliders);
        for e in &self.entries {
            if *budget == 0 {
                return;
            }
            let (Some(name), Some(ty)) = (entry_name(e), entry_type(e)) else {
                continue;
            };
            if self.name_hidden(name) || self.selection.contains(name) != selected_pass {
                continue;
            }
            let extent = EXTENTS
                .iter()
                .find(|(t, ..)| *t == ty)
                .filter(|(_, c, _)| selected_pass || self.extent_show.contains(*c));
            if extent.is_none() && !colliders_on {
                continue;
            }
            let Some(entity) = billboard_drive::entity_by_name(world, name) else {
                continue;
            };
            let before = out.len();
            if let Some((_, _, shape)) = extent {
                shape(
                    &ShapeCtx {
                        world,
                        entity,
                        ty,
                        entry: e,
                        vp,
                        stroke: outlines::stroke(ty, selected_pass),
                    },
                    out,
                );
            }
            if colliders_on {
                push_collider_outline(world, entity, out);
            }
            if out.len() > before {
                *budget -= 1;
            }
        }
    }
}

fn push_trigger(ctx: &ShapeCtx, out: &mut Vec<Line>) {
    let Some(volume) = ctx.world.get::<TriggerVolume>(ctx.entity) else {
        return;
    };
    let transform = anchored_transform(ctx.world, ctx.entity, volume.position, volume.rotation_deg);
    let s = ctx.stroke;
    let c = &volume.collider;
    match c.shape.as_str() {
        "ball" => shapes::push_sphere(out, transform.position, c.radius, s),
        "capsule" => {
            shapes::push_capsule(out, &transform.model_matrix(), c.radius, c.half_height, s);
        }
        _ => shapes::push_box(out, &transform.model_matrix(), c.half_extents, s),
    }
}

fn push_point_light(ctx: &ShapeCtx, out: &mut Vec<Line>) {
    let Some(light) = ctx.world.get::<PointLight>(ctx.entity) else {
        return;
    };
    let center = anchored_position(ctx.world, ctx.entity, light.position);
    shapes::push_sphere(out, center, light.range, ctx.stroke);
}

fn push_spot_light(ctx: &ShapeCtx, out: &mut Vec<Line>) {
    let Some(light) = ctx.world.get::<SpotLight>(ctx.entity) else {
        return;
    };
    let s = ctx.stroke;
    let apex = anchored_position(ctx.world, ctx.entity, light.position);
    let dir = light.unit_direction();
    let outer = light
        .outer_angle
        .clamp(0.0, SPOT_MAX_ANGLE_DEG)
        .to_radians();
    shapes::push_cone(out, apex, dir, outer, light.range, s);
    // The full-bright inner cone reads as one dimmer circle on the same range
    // sphere (a degenerate radius appends nothing).
    let inner = light.inner_angle.to_radians().clamp(0.0, outer);
    let center = [
        apex[0] + dir[0] * light.range * inner.cos(),
        apex[1] + dir[1] * light.range * inner.cos(),
        apex[2] + dir[2] * light.range * inner.cos(),
    ];
    shapes::push_circle(
        out,
        center,
        dir,
        light.range * inner.sin(),
        outlines::inner_stroke(s),
    );
}

fn push_rect_light(ctx: &ShapeCtx, out: &mut Vec<Line>) {
    let Some(light) = ctx.world.get::<RectAreaLight>(ctx.entity) else {
        return;
    };
    let centre = anchored_position(ctx.world, ctx.entity, light.centre);
    shapes::push_rect(
        out,
        centre,
        light.unit_normal(),
        light.half_size,
        light.range,
        ctx.stroke,
    );
}

fn push_probe(ctx: &ShapeCtx, out: &mut Vec<Line>) {
    let Some(probe) = ctx.world.get::<ReflectionProbe>(ctx.entity) else {
        return;
    };
    let position = anchored_position(ctx.world, ctx.entity, probe.position);
    let model = Transform {
        position,
        rotation_deg: [0.0; 3],
        scale: [1.0; 3],
    }
    .model_matrix();
    shapes::push_box(out, &model, probe.half_extents, ctx.stroke);
}

// The live Camera3D is the editor's own viewpoint (fly moves it), so the
// frustum builds from the authored args, anchored on the seeded Transform so
// a gizmo drag carries it. Each projection key carries a usable fallback: an
// authored value that is not a number would otherwise collapse the frustum
// and the outline would silently disappear.
fn push_camera(ctx: &ShapeCtx, out: &mut Vec<Line>) {
    let args = form::working_args(ctx.ty, ctx.entry.get("args").and_then(|v| v.as_object()));
    let num = |key: &str, default: f32| {
        args.get(key)
            .and_then(|v| v.as_f64())
            .map(|v| v as f32)
            .unwrap_or(default)
    };
    let authored = billboards::position_of(&args).unwrap_or([0.0; 3]);
    let origin = anchored_position(ctx.world, ctx.entity, authored);
    let view =
        concinnity_core::gfx::camera::view_matrix(origin, num("yaw", 0.0), num("pitch", 0.0));
    let right = [view[0][0], view[1][0], view[2][0]];
    let up = [view[0][1], view[1][1], view[2][1]];
    let forward = [-view[0][2], -view[1][2], -view[2][2]];
    let aspect = if ctx.vp[1] > 0.0 {
        ctx.vp[0] / ctx.vp[1]
    } else {
        16.0 / 9.0
    };
    shapes::push_frustum(
        out,
        &shapes::Frustum {
            origin,
            right,
            up,
            forward,
            fov_y_rad: num("fov_y_degrees", 75.0).to_radians(),
            aspect,
            near: num("near", 0.05),
            far: num("far", 200.0),
        },
        ctx.stroke,
    );
}

// The entity's collider wireframe (the Colliders category), through its live
// Transform so scale and a gizmo drag both apply.
fn push_collider_outline(world: &World, entity: crate::ecs::Entity, out: &mut Vec<Line>) {
    let (Some(collider), Some(transform)) = (
        world.get::<Collider>(entity),
        world.get::<Transform>(entity),
    ) else {
        return;
    };
    let s = outlines::stroke("Collider", false);
    let c = &collider.0;
    match c.shape.as_str() {
        "ball" => {
            let scale = transform.scale.iter().fold(0.0f32, |a, &b| a.max(b));
            shapes::push_sphere(out, transform.position, c.radius * scale, s);
        }
        "capsule" => {
            shapes::push_capsule(out, &transform.model_matrix(), c.radius, c.half_height, s)
        }
        _ => shapes::push_box(out, &transform.model_matrix(), c.half_extents, s),
    }
}

// The entity's position, preferring the seeded / gizmo-dragged Transform over
// the component's authored field.
fn anchored_position(world: &World, entity: crate::ecs::Entity, authored: [f32; 3]) -> [f32; 3] {
    world
        .get::<Transform>(entity)
        .map(|t| t.position)
        .unwrap_or(authored)
}

// The entity's full pose, preferring the live Transform.
fn anchored_transform(
    world: &World,
    entity: crate::ecs::Entity,
    position: [f32; 3],
    rotation_deg: [f32; 3],
) -> Transform {
    world
        .get::<Transform>(entity)
        .cloned()
        .unwrap_or(Transform {
            position,
            rotation_deg,
            scale: [1.0; 3],
        })
}

#[cfg(test)]
mod tests {
    use super::*;

    const VP: [f32; 2] = [1280.0, 720.0];

    fn hook(entries: Vec<serde_json::Value>) -> EditorHook {
        EditorHook::new("unused.jsonl".to_string(), entries)
    }

    fn entry(name: &str, ty: &str) -> serde_json::Value {
        serde_json::json!({"name": name, "type": ty, "args": {}})
    }

    // A world holding one named entity carrying `component`, resolvable
    // through the same EntityByName path the gizmo and billboards use.
    fn world_with<C: crate::ecs::ComponentSlot>(name: &str, component: C) -> World {
        crate::ecs::asset_id::reset_interner();
        let id = crate::ecs::asset_id::intern(name);
        let mut world = World::new();
        let entity = world.push(component);
        let mut by_name = std::collections::BTreeMap::new();
        by_name.insert(id, entity);
        world.insert_resource(concinnity_core::ecs::EntityByName(by_name));
        world
    }

    fn lines_of(h: &EditorHook, world: &World) -> Vec<Line> {
        let mut out = Vec::new();
        h.push_extent_lines(world, VP, &mut out);
        out
    }

    #[test]
    fn a_selected_point_light_outlines_its_range_sphere() {
        let world = world_with(
            "lamp",
            PointLight {
                position: [1.0, 2.0, 3.0],
                range: 6.0,
                ..Default::default()
            },
        );
        let mut h = hook(vec![entry("lamp", "PointLight")]);
        assert!(
            lines_of(&h, &world).is_empty(),
            "nothing selected, nothing drawn"
        );

        h.selection.replace("lamp".to_string());
        let lines = lines_of(&h, &world);
        assert_eq!(lines.len(), 3 * shapes::CIRCLE_SEGMENTS);
        // Every point sits on the range sphere around the light.
        for l in &lines {
            let d = [l.start[0] - 1.0, l.start[1] - 2.0, l.start[2] - 3.0];
            let r = (d[0] * d[0] + d[1] * d[1] + d[2] * d[2]).sqrt();
            assert!((r - 6.0).abs() < 1e-3, "{r}");
        }
    }

    #[test]
    fn a_category_toggle_outlines_without_selection_and_dimmer() {
        let world = world_with(
            "lamp",
            PointLight {
                range: 6.0,
                ..Default::default()
            },
        );
        let mut h = hook(vec![entry("lamp", "PointLight")]);
        h.extent_show = h.extent_show.toggled(outlines::Category::Lights);
        let layer = lines_of(&h, &world);
        assert_eq!(layer.len(), 3 * shapes::CIRCLE_SEGMENTS);

        h.selection.replace("lamp".to_string());
        let selected = lines_of(&h, &world);
        assert_eq!(selected.len(), layer.len());
        assert!(selected[0].start_color[3] > layer[0].start_color[3]);
        assert!(selected[0].width_px > layer[0].width_px);
    }

    #[test]
    fn a_spot_light_draws_its_cone_and_inner_circle() {
        let world = world_with(
            "spot",
            SpotLight {
                position: [0.0, 5.0, 0.0],
                direction: [0.0, -1.0, 0.0],
                range: 10.0,
                inner_angle: 18.0,
                outer_angle: 30.0,
                ..Default::default()
            },
        );
        let mut h = hook(vec![entry("spot", "SpotLight")]);
        h.selection.replace("spot".to_string());
        let lines = lines_of(&h, &world);
        assert_eq!(
            lines.len(),
            shapes::CONE_SIDES + 2 * shapes::CIRCLE_SEGMENTS,
            "outer cone + inner circle"
        );
        // The inner circle carries the dimmer stroke.
        let faintest = lines
            .iter()
            .map(|l| l.start_color[3])
            .fold(f32::MAX, f32::min);
        assert!(faintest < lines[0].start_color[3]);
    }

    #[test]
    fn trigger_volume_shapes_follow_the_live_transform() {
        let mut world = world_with(
            "zone",
            TriggerVolume {
                position: [0.0; 3],
                collider: crate::components::PropCollider {
                    shape: "ball".to_string(),
                    radius: 2.0,
                    ..Default::default()
                },
                ..Default::default()
            },
        );
        let mut h = hook(vec![entry("zone", "TriggerVolume")]);
        h.selection.replace("zone".to_string());

        // A gizmo-dragged Transform moves the outline off the authored spot.
        let e = world
            .resource::<concinnity_core::ecs::EntityByName>()
            .unwrap()
            .0
            .values()
            .next()
            .copied()
            .unwrap();
        world.insert(
            e,
            Transform {
                position: [10.0, 0.0, 0.0],
                rotation_deg: [0.0; 3],
                scale: [1.0; 3],
            },
        );
        let lines = lines_of(&h, &world);
        assert_eq!(lines.len(), 3 * shapes::CIRCLE_SEGMENTS);
        for l in &lines {
            let d = [l.start[0] - 10.0, l.start[1], l.start[2]];
            let r = (d[0] * d[0] + d[1] * d[1] + d[2] * d[2]).sqrt();
            assert!((r - 2.0).abs() < 1e-3, "outline follows the Transform");
        }
    }

    #[test]
    fn colliders_show_only_through_their_toggle() {
        let mut world = world_with(
            "crate",
            Collider(crate::components::PropCollider {
                shape: "cuboid".to_string(),
                half_extents: [1.0, 1.0, 1.0],
                ..Default::default()
            }),
        );
        let e = world
            .resource::<concinnity_core::ecs::EntityByName>()
            .unwrap()
            .0
            .values()
            .next()
            .copied()
            .unwrap();
        world.insert(e, Transform::default());
        let mut h = hook(vec![entry("crate", "Prop")]);

        // Selection alone never draws a collider (props carry the highlight
        // rect instead).
        h.selection.replace("crate".to_string());
        assert!(lines_of(&h, &world).is_empty());

        h.extent_show = h.extent_show.toggled(outlines::Category::Colliders);
        assert_eq!(lines_of(&h, &world).len(), shapes::BOX_EDGES);
    }

    #[test]
    fn hidden_entries_and_a_hidden_hud_draw_nothing() {
        let world = world_with(
            "lamp",
            PointLight {
                range: 6.0,
                ..Default::default()
            },
        );
        let mut h = hook(vec![entry("lamp", "PointLight")]);
        h.selection.replace("lamp".to_string());
        assert!(!lines_of(&h, &world).is_empty());

        h.hidden_assets.insert("lamp".to_string());
        assert!(
            lines_of(&h, &world).is_empty(),
            "editor-hidden entries skip"
        );
        h.hidden_assets.clear();

        h.hud_visible = false;
        assert!(
            lines_of(&h, &world).is_empty(),
            "F1 clears the outlines too"
        );
    }

    #[test]
    fn the_extent_table_is_one_row_per_type_outside_colliders() {
        let mut seen = std::collections::HashSet::new();
        for (ty, c, _) in EXTENTS {
            assert!(seen.insert(ty), "{ty} repeats");
            assert!(
                concinnity_cook::authoring::registry::RegisteredType::parse(ty).is_some(),
                "{ty} is not a registered component type"
            );
            assert_ne!(
                c,
                outlines::Category::Colliders,
                "{ty}: colliders are not type-keyed"
            );
        }
        // Every menu category except Colliders must have a row to answer its
        // toggle, or the Display menu ships a toggle that draws nothing.
        for (c, label) in outlines::Category::LABELED {
            if c == outlines::Category::Colliders {
                continue;
            }
            assert!(
                EXTENTS.iter().any(|(_, row, _)| *row == c),
                "{label} has no outlineable type"
            );
        }
    }

    #[test]
    fn rect_probe_and_camera_extents_emit_lines_when_selected() {
        // Rect: 4 edges + the normal ray.
        let world = world_with("panel", RectAreaLight::default());
        let mut h = hook(vec![entry("panel", "RectAreaLight")]);
        h.selection.replace("panel".to_string());
        assert_eq!(lines_of(&h, &world).len(), 5);

        // Probe: its bounds box.
        let world = world_with("probe", ReflectionProbe::default());
        let mut h = hook(vec![entry("probe", "ReflectionProbe")]);
        h.selection.replace("probe".to_string());
        assert_eq!(lines_of(&h, &world).len(), shapes::BOX_EDGES);

        // Camera: a frustum from the schema-default args (also guards that
        // `working_args` keeps merging the defaults the frustum relies on).
        let world = world_with(
            "shot",
            crate::components::Camera3D {
                position: [0.0; 3],
                view_matrix: concinnity_core::gfx::camera::view_matrix([0.0; 3], 0.0, 0.0),
                fov_y_degrees: 75.0,
                near: 0.05,
                far: 200.0,
                yaw: 0.0,
                pitch: 0.0,
                desired_move: [0.0; 3],
                jump_requested: false,
                interact_requested: false,
                controller: None,
            },
        );
        let mut h = hook(vec![entry("shot", "Camera3D")]);
        h.selection.replace("shot".to_string());
        assert_eq!(lines_of(&h, &world).len(), shapes::BOX_EDGES);

        // A hand-authored projection key that is not a number falls back to
        // the shipping default rather than collapsing the frustum away.
        let mut h = hook(vec![serde_json::json!({
            "name": "shot", "type": "Camera3D",
            "args": {"near": "0.05", "far": null}
        })]);
        h.selection.replace("shot".to_string());
        assert_eq!(lines_of(&h, &world).len(), shapes::BOX_EDGES);
    }
}