vrm-spec 0.1.0

VRM data structures
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

//! Data structures for the [`VRMC_vrm_animation`](https://github.com/vrm-c/vrm-specification/blob/master/specification/VRMC_vrm_animation-1.0/README.md) 1.0 glTF Extension.

#[cfg(feature = "rustc_hash")]
use rustc_hash::FxHashMap as HashMap;
use serde::{Deserialize, Serialize};
#[cfg(not(feature = "rustc_hash"))]
use std::collections::HashMap;

/// VRMC_vrm_animation extension name
pub const VRMC_VRM_ANIMATION: &str = "VRMC_vrm_animation";

/// glTF extension that defines humanoid animations.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct VRMCVrmAnimationSchema {
    /// Specification version of VRMC_vrm_animation
    pub spec_version: String,

    /// An object which describes about humanoid bones.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub humanoid: Option<VRMCVrmAnimationHumanoid>,

    /// An object which maps expressions to nodes.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expressions: Option<VRMCVrmAnimationExpressions>,

    /// An object which maps a eye gaze point to a node.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub look_at: Option<VRMCVrmAnimationLookAt>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<HashMap<String, HashMap<String, Option<serde_json::Value>>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extras: Option<serde_json::Value>,
}

/// An object which describes about humanoid bones.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct VRMCVrmAnimationHumanoid {
    /// An object which maps humanoid bones to nodes.
    pub human_bones: VRMCVrmAnimationHumanBones,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<HashMap<String, HashMap<String, Option<serde_json::Value>>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extras: Option<serde_json::Value>,
}

/// Represents a set of humanBones of a humanoid.
// FIXME: all bones are optional by now
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VRMCVrmAnimationHumanBones(
    pub HashMap<crate::vrmc_vrm_1_0::HumanBoneName, Option<VRMCVrmAnimationHumanBone>>,
);

/// Represents a single bone of a Humanoid.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VRMCVrmAnimationHumanBone {
    /// Represents a single glTF node tied to this humanBone.
    #[cfg(feature = "gltf_index")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub node: Option<gltf::json::Index<gltf::json::Node>>,
    #[cfg(not(feature = "gltf_index"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub node: Option<usize>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<HashMap<String, HashMap<String, Option<serde_json::Value>>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extras: Option<serde_json::Value>,
}

/// An object which maps expressions to nodes.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VRMCVrmAnimationExpressions {
    /// An object that contains definitions of preset expressions.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub preset: Option<VRMCVrmAnimationExpressionPreset>,

    /// An object that contains definitions of custom expressions.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom: Option<HashMap<String, VRMCVrmAnimationExpression>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<HashMap<String, HashMap<String, Option<serde_json::Value>>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extras: Option<serde_json::Value>,
}

/// An object that contains definitions of preset expressions.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VRMCVrmAnimationExpressionPreset(
    pub HashMap<crate::vrmc_vrm_1_0::ExpressionPresetName, VRMCVrmAnimationExpression>,
);

/// Represents a single expression.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VRMCVrmAnimationExpression {
    /// Represents a single glTF node mapped to this expression.
    #[cfg(feature = "gltf_index")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub node: Option<gltf::json::Index<gltf::json::Node>>,
    #[cfg(not(feature = "gltf_index"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub node: Option<usize>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<HashMap<String, HashMap<String, Option<serde_json::Value>>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extras: Option<serde_json::Value>,
}

/// An object which maps a eye gaze point to a node.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct VRMCVrmAnimationLookAt {
    /// Represents a single glTF node represents the eye gaze point.
    #[cfg(feature = "gltf_index")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub node: Option<gltf::json::Index<gltf::json::Node>>,
    #[cfg(not(feature = "gltf_index"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub node: Option<usize>,

    /// The position offset of the origin of the LookAt from the humanoid head bone
    #[serde(skip_serializing_if = "Option::is_none")]
    pub offset_from_head_bone: Option<[f64; 3]>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<HashMap<String, HashMap<String, Option<serde_json::Value>>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extras: Option<serde_json::Value>,
}