Skip to main content

oxihuman_viewer/
force_vector_view.rs

1// Copyright (C) 2026 COOLJAPAN OU (Team KitaSan)
2// SPDX-License-Identifier: Apache-2.0
3#![allow(dead_code)]
4
5//! Force/torque vector visualization — renders arrow glyphs for applied forces.
6
7/// Force vector view configuration.
8#[derive(Debug, Clone)]
9pub struct ForceVectorView {
10    pub enabled: bool,
11    pub scale: f32,
12    pub min_display_magnitude: f32,
13    pub color_force: [f32; 4],
14    pub color_torque: [f32; 4],
15    pub show_torque: bool,
16}
17
18impl ForceVectorView {
19    pub fn new() -> Self {
20        Self {
21            enabled: false,
22            scale: 0.01,
23            min_display_magnitude: 0.1,
24            color_force: [1.0, 0.5, 0.0, 1.0],
25            color_torque: [0.5, 0.0, 1.0, 1.0],
26            show_torque: true,
27        }
28    }
29}
30
31impl Default for ForceVectorView {
32    fn default() -> Self {
33        Self::new()
34    }
35}
36
37/// Create a new force vector view.
38pub fn new_force_vector_view() -> ForceVectorView {
39    ForceVectorView::new()
40}
41
42/// Enable or disable force vector display.
43pub fn fvv_set_enabled(v: &mut ForceVectorView, enabled: bool) {
44    v.enabled = enabled;
45}
46
47/// Set arrow scale factor.
48pub fn fvv_set_scale(v: &mut ForceVectorView, scale: f32) {
49    v.scale = scale.clamp(0.0001, 1.0);
50}
51
52/// Set minimum magnitude to display.
53pub fn fvv_set_min_magnitude(v: &mut ForceVectorView, mag: f32) {
54    v.min_display_magnitude = mag.max(0.0);
55}
56
57/// Toggle torque vector display.
58pub fn fvv_set_show_torque(v: &mut ForceVectorView, show: bool) {
59    v.show_torque = show;
60}
61
62/// Returns scaled display length for a given force magnitude.
63pub fn fvv_display_length(v: &ForceVectorView, magnitude: f32) -> f32 {
64    if magnitude < v.min_display_magnitude {
65        return 0.0;
66    }
67    magnitude * v.scale
68}
69
70/// Serialize to JSON-like string.
71pub fn force_vector_view_to_json(v: &ForceVectorView) -> String {
72    format!(
73        r#"{{"enabled":{},"scale":{:.6},"min_display_magnitude":{:.4},"show_torque":{}}}"#,
74        v.enabled, v.scale, v.min_display_magnitude, v.show_torque
75    )
76}
77
78#[cfg(test)]
79mod tests {
80    use super::*;
81
82    #[test]
83    fn test_defaults() {
84        let v = new_force_vector_view();
85        assert!(!v.enabled);
86        assert!(v.show_torque);
87    }
88
89    #[test]
90    fn test_enable() {
91        let mut v = new_force_vector_view();
92        fvv_set_enabled(&mut v, true);
93        assert!(v.enabled);
94    }
95
96    #[test]
97    fn test_scale_clamp() {
98        let mut v = new_force_vector_view();
99        fvv_set_scale(&mut v, 0.0);
100        assert_eq!(v.scale, 0.0001);
101    }
102
103    #[test]
104    fn test_min_magnitude() {
105        let mut v = new_force_vector_view();
106        fvv_set_min_magnitude(&mut v, 1.0);
107        assert!((v.min_display_magnitude - 1.0).abs() < 1e-6);
108    }
109
110    #[test]
111    fn test_display_length_below_min() {
112        let v = new_force_vector_view();
113        assert_eq!(fvv_display_length(&v, 0.0), 0.0);
114    }
115
116    #[test]
117    fn test_display_length_above_min() {
118        let v = new_force_vector_view();
119        let len = fvv_display_length(&v, 100.0);
120        assert!(len > 0.0);
121    }
122
123    #[test]
124    fn test_toggle_torque() {
125        let mut v = new_force_vector_view();
126        fvv_set_show_torque(&mut v, false);
127        assert!(!v.show_torque);
128    }
129
130    #[test]
131    fn test_json_keys() {
132        let v = new_force_vector_view();
133        let s = force_vector_view_to_json(&v);
134        assert!(s.contains("show_torque"));
135    }
136
137    #[test]
138    fn test_clone() {
139        let v = new_force_vector_view();
140        let v2 = v.clone();
141        assert_eq!(v2.show_torque, v.show_torque);
142    }
143}