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 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
use gltf_derive::Validate;
use serde_derive::{Serialize, Deserialize};
use serde::{de, ser};
use std::fmt;
use crate::validation::{Checked, Error, Validate};
use crate::{accessor, extensions, scene, Extras, Index, Path, Root};
/// All valid animation interpolation algorithms.
pub const VALID_INTERPOLATIONS: &'static [&'static str] = &[
"LINEAR",
"STEP",
"CATMULLROMSPLINE",
"CUBICSPLINE",
];
/// All valid animation property names.
pub const VALID_PROPERTIES: &'static [&'static str] = &[
"translation",
"rotation",
"scale",
"weights",
];
/// Specifies an interpolation algorithm.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize)]
pub enum Interpolation {
/// Linear interpolation.
///
/// The animated values are linearly interpolated between keyframes.
/// When targeting a rotation, spherical linear interpolation (slerp) should be
/// used to interpolate quaternions. The number output of elements must equal
/// the number of input elements.
Linear = 1,
/// Step interpolation.
///
/// The animated values remain constant to the output of the first keyframe,
/// until the next keyframe. The number of output elements must equal the number
/// of input elements.
Step,
/// Uniform Catmull-Rom spline interpolation.
///
/// The animation's interpolation is computed using a uniform Catmull-Rom spline.
/// The number of output elements must equal two more than the number of input
/// elements. The first and last output elements represent the start and end
/// tangents of the spline. There must be at least four keyframes when using this
/// interpolation.
CatmullRomSpline,
/// Cubic spline interpolation.
///
/// The animation's interpolation is computed using a uniform Catmull-Rom spline.
/// The number of output elements must equal two more than the number of input
/// elements. The first and last output elements represent the start and end
/// tangents of the spline. There must be at least four keyframes when using this
/// interpolation.
CubicSpline,
}
/// Specifies a property to animate.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize)]
pub enum Property {
/// XYZ translation vector.
Translation = 1,
/// XYZW rotation quaternion.
Rotation,
/// XYZ scale vector.
Scale,
/// Weights of morph targets.
MorphTargetWeights,
}
/// A keyframe animation.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Animation {
/// Extension specific data.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub extensions: Option<extensions::animation::Animation>,
/// Optional application specific data.
#[serde(default)]
#[cfg_attr(feature = "extras", serde(skip_serializing_if = "Option::is_none"))]
pub extras: Extras,
/// An array of channels, each of which targets an animation's sampler at a
/// node's property.
///
/// Different channels of the same animation must not have equal targets.
#[serde(skip_serializing_if = "Vec::is_empty")]
pub channels: Vec<Channel>,
/// Optional user-defined name for this object.
#[cfg(feature = "names")]
#[cfg_attr(feature = "names", serde(skip_serializing_if = "Option::is_none"))]
pub name: Option<String>,
/// An array of samplers that combine input and output accessors with an
/// interpolation algorithm to define a keyframe graph (but not its target).
#[serde(skip_serializing_if = "Vec::is_empty")]
pub samplers: Vec<Sampler>,
}
/// Targets an animation's sampler at a node's property.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Channel {
/// The index of a sampler in this animation used to compute the value for the
/// target.
pub sampler: Index<Sampler>,
/// The index of the node and TRS property to target.
pub target: Target,
/// Extension specific data.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub extensions: Option<extensions::animation::Channel>,
/// Optional application specific data.
#[serde(default)]
#[cfg_attr(feature = "extras", serde(skip_serializing_if = "Option::is_none"))]
pub extras: Extras,
}
/// The index of the node and TRS property that an animation channel targets.
#[derive(Clone, Debug, Deserialize, Serialize, Validate)]
pub struct Target {
/// Extension specific data.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub extensions: Option<extensions::animation::Target>,
/// Optional application specific data.
#[serde(default)]
#[cfg_attr(feature = "extras", serde(skip_serializing_if = "Option::is_none"))]
pub extras: Extras,
/// The index of the node to target.
pub node: Index<scene::Node>,
/// The name of the node's property to modify or the 'weights' of the
/// morph targets it instantiates.
pub path: Checked<Property>,
}
/// Defines a keyframe graph but not its target.
#[derive(Clone, Debug, Deserialize, Serialize, Validate)]
pub struct Sampler {
/// Extension specific data.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub extensions: Option<extensions::animation::Sampler>,
/// Optional application specific data.
#[serde(default)]
#[cfg_attr(feature = "extras", serde(skip_serializing_if = "Option::is_none"))]
pub extras: Extras,
/// The index of an accessor containing keyframe input values, e.g., time.
pub input: Index<accessor::Accessor>,
/// The interpolation algorithm.
#[serde(default)]
pub interpolation: Checked<Interpolation>,
/// The index of an accessor containing keyframe output values.
pub output: Index<accessor::Accessor>,
}
impl Validate for Animation {
fn validate<P, R>(&self, root: &Root, path: P, report: &mut R)
where
P: Fn() -> Path,
R: FnMut(&dyn Fn() -> Path, Error),
{
self.samplers.validate(root, || path().field("samplers"), report);
for (index, channel) in self.channels.iter().enumerate() {
if channel.sampler.value() as usize >= self.samplers.len() {
let path = || path().field("channels").index(index).field("sampler");
report(&path, Error::IndexOutOfBounds);
}
}
}
}
impl Default for Interpolation {
fn default() -> Self {
Interpolation::Linear
}
}
impl<'de> de::Deserialize<'de> for Checked<Interpolation> {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: de::Deserializer<'de>
{
struct Visitor;
impl<'de> de::Visitor<'de> for Visitor {
type Value = Checked<Interpolation>;
fn expecting(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "any of: {:?}", VALID_INTERPOLATIONS)
}
fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
where E: de::Error
{
use self::Interpolation::*;
use crate::validation::Checked::*;
Ok(match value {
"LINEAR" => Valid(Linear),
"STEP" => Valid(Step),
"CATMULLROMSPLINE" => Valid(CatmullRomSpline),
"CUBICSPLINE" => Valid(CubicSpline),
_ => Invalid,
})
}
}
deserializer.deserialize_str(Visitor)
}
}
impl ser::Serialize for Interpolation {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: ser::Serializer
{
serializer.serialize_str(match *self {
Interpolation::Linear => "LINEAR",
Interpolation::Step => "STEP",
Interpolation::CatmullRomSpline => "CATMULLROMSPLINE",
Interpolation::CubicSpline => "CUBICSPLINE",
})
}
}
impl<'de> de::Deserialize<'de> for Checked<Property> {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: de::Deserializer<'de>
{
struct Visitor;
impl<'de> de::Visitor<'de> for Visitor {
type Value = Checked<Property>;
fn expecting(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "any of: {:?}", VALID_PROPERTIES)
}
fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
where E: de::Error
{
use self::Property::*;
use crate::validation::Checked::*;
Ok(match value {
"translation" => Valid(Translation),
"rotation" => Valid(Rotation),
"scale" => Valid(Scale),
"weights" => Valid(MorphTargetWeights),
_ => Invalid,
})
}
}
deserializer.deserialize_str(Visitor)
}
}
impl ser::Serialize for Property {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: ser::Serializer
{
serializer.serialize_str(match *self {
Property::Translation => "translation",
Property::Rotation => "rotation",
Property::Scale => "scale",
Property::MorphTargetWeights => "weights",
})
}
}