oxihuman-viewer 0.2.1

wgpu/WebGPU rendering adapter for OxiHuman
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

// Copyright (C) 2026 COOLJAPAN OU (Team KitaSan)
// SPDX-License-Identifier: Apache-2.0
#![allow(dead_code)]

//! USD stage preview panel view.

/// USD stage rendering mode.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum UsdRenderMode {
    WireFrame,
    Shaded,
    ShadedWire,
    Points,
}

/// Configuration for the USD preview panel.
#[derive(Debug, Clone)]
pub struct UsdPreviewConfig {
    pub render_mode: UsdRenderMode,
    pub show_proxy_geometry: bool,
    pub frame: f64,
}

impl Default for UsdPreviewConfig {
    fn default() -> Self {
        UsdPreviewConfig {
            render_mode: UsdRenderMode::Shaded,
            show_proxy_geometry: true,
            frame: 0.0,
        }
    }
}

/// State for the USD preview panel.
#[derive(Debug, Clone)]
pub struct UsdPreviewView {
    pub config: UsdPreviewConfig,
    pub stage_path: String,
    pub enabled: bool,
}

/// Create a new USD preview view.
pub fn new_usd_preview_view() -> UsdPreviewView {
    UsdPreviewView {
        config: UsdPreviewConfig::default(),
        stage_path: String::new(),
        enabled: true,
    }
}

/// Set the USD stage file path.
pub fn upv_set_stage(v: &mut UsdPreviewView, path: &str) {
    v.stage_path = path.to_string();
}

/// Set the current time frame.
pub fn upv_set_frame(v: &mut UsdPreviewView, frame: f64) {
    v.config.frame = frame;
}

/// Set the render mode.
pub fn upv_set_render_mode(v: &mut UsdPreviewView, mode: UsdRenderMode) {
    v.config.render_mode = mode;
}

/// Return whether the stage path is non-empty.
pub fn upv_has_stage(v: &UsdPreviewView) -> bool {
    !v.stage_path.is_empty()
}

/// Serialise to JSON.
pub fn upv_to_json(v: &UsdPreviewView) -> String {
    format!(
        r#"{{"stage_path":"{}","frame":{:.2},"enabled":{}}}"#,
        v.stage_path, v.config.frame, v.enabled
    )
}

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

    #[test]
    fn default_no_stage() {
        let v = new_usd_preview_view();
        assert!(!upv_has_stage(&v) /* no stage by default */);
    }

    #[test]
    fn set_stage_makes_has_stage_true() {
        let mut v = new_usd_preview_view();
        upv_set_stage(&mut v, "scene.usd");
        assert!(upv_has_stage(&v) /* stage set */);
    }

    #[test]
    fn set_frame() {
        let mut v = new_usd_preview_view();
        upv_set_frame(&mut v, 42.0);
        assert!((v.config.frame - 42.0).abs() < 1e-9 /* frame set */);
    }

    #[test]
    fn set_render_mode_wireframe() {
        let mut v = new_usd_preview_view();
        upv_set_render_mode(&mut v, UsdRenderMode::WireFrame);
        assert_eq!(
            v.config.render_mode,
            UsdRenderMode::WireFrame /* mode set */
        );
    }

    #[test]
    fn default_render_mode_shaded() {
        let v = new_usd_preview_view();
        assert_eq!(
            v.config.render_mode,
            UsdRenderMode::Shaded /* default mode */
        );
    }

    #[test]
    fn json_has_stage_path() {
        let mut v = new_usd_preview_view();
        upv_set_stage(&mut v, "test.usda");
        assert!(upv_to_json(&v).contains("test.usda") /* stage in json */);
    }

    #[test]
    fn enabled_default() {
        let v = new_usd_preview_view();
        assert!(v.enabled /* enabled */);
    }

    #[test]
    fn proxy_geometry_default_true() {
        let v = new_usd_preview_view();
        assert!(v.config.show_proxy_geometry /* proxy geometry on by default */);
    }
}