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 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
use gltf_derive::Validate;
use serde_derive::{Serialize, Deserialize};
use crate::{buffer, extensions, Extras, Index};
use serde::{de, ser};
use serde_json::Value;
use std::fmt;
use crate::validation::Checked;
/// The component data type.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize)]
pub enum ComponentType {
/// Corresponds to `GL_BYTE`.
I8 = 1,
/// Corresponds to `GL_UNSIGNED_BYTE`.
U8,
/// Corresponds to `GL_SHORT`.
I16,
/// Corresponds to `GL_UNSIGNED_SHORT`.
U16,
/// Corresponds to `GL_UNSIGNED_INT`.
U32,
/// Corresponds to `GL_FLOAT`.
F32,
}
/// Specifies whether an attribute, vector, or matrix.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize)]
pub enum Type {
/// Scalar quantity.
Scalar = 1,
/// 2D vector.
Vec2,
/// 3D vector.
Vec3,
/// 4D vector.
Vec4,
/// 2x2 matrix.
Mat2,
/// 3x3 matrix.
Mat3,
/// 4x4 matrix.
Mat4,
}
/// Corresponds to `GL_BYTE`.
pub const BYTE: u32 = 5120;
/// Corresponds to `GL_UNSIGNED_BYTE`.
pub const UNSIGNED_BYTE: u32 = 5121;
/// Corresponds to `GL_SHORT`.
pub const SHORT: u32 = 5122;
/// Corresponds to `GL_UNSIGNED_SHORT`.
pub const UNSIGNED_SHORT: u32 = 5123;
/// Corresponds to `GL_UNSIGNED_INT`.
pub const UNSIGNED_INT: u32 = 5125;
/// Corresponds to `GL_FLOAT`.
pub const FLOAT: u32 = 5126;
/// All valid generic vertex attribute component types.
pub const VALID_COMPONENT_TYPES: &'static [u32] = &[
BYTE,
UNSIGNED_BYTE,
SHORT,
UNSIGNED_SHORT,
UNSIGNED_INT,
FLOAT,
];
/// All valid index component types.
pub const VALID_INDEX_TYPES: &'static [u32] = &[
UNSIGNED_BYTE,
UNSIGNED_SHORT,
UNSIGNED_INT,
];
/// All valid accessor types.
pub const VALID_ACCESSOR_TYPES: &'static [&'static str] = &[
"SCALAR",
"VEC2",
"VEC3",
"VEC4",
"MAT2",
"MAT3",
"MAT4",
];
/// Contains data structures for sparse storage.
pub mod sparse {
use super::*;
use crate::extensions;
/// Indices of those attributes that deviate from their initialization value.
#[derive(Clone, Debug, Deserialize, Serialize, Validate)]
pub struct Indices {
/// The parent buffer view containing the sparse indices.
///
/// The referenced buffer view must not have `ARRAY_BUFFER` nor
/// `ELEMENT_ARRAY_BUFFER` as its target.
#[serde(rename = "bufferView")]
pub buffer_view: Index<buffer::View>,
/// The offset relative to the start of the parent `BufferView` in bytes.
#[serde(default, rename = "byteOffset")]
pub byte_offset: u32,
/// The data type of each index.
#[serde(rename = "componentType")]
pub component_type: Checked<IndexComponentType>,
/// Extension specific data.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub extensions: Option<extensions::accessor::sparse::Indices>,
/// Optional application specific data.
#[serde(default)]
#[cfg_attr(feature = "extras", serde(skip_serializing_if = "Option::is_none"))]
pub extras: Extras,
}
/// Sparse storage of attributes that deviate from their initialization value.
#[derive(Clone, Debug, Deserialize, Serialize, Validate)]
pub struct Sparse {
/// The number of attributes encoded in this sparse accessor.
pub count: u32,
/// Index array of size `count` that points to those accessor attributes
/// that deviate from their initialization value.
///
/// Indices must strictly increase.
pub indices: Indices,
/// Array of size `count * number_of_components` storing the displaced
/// accessor attributes pointed by `indices`.
///
/// Substituted values must have the same `component_type` and number of
/// components as the base `Accessor`.
pub values: Values,
/// Extension specific data.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub extensions: Option<extensions::accessor::sparse::Sparse>,
/// Optional application specific data.
#[serde(default)]
#[cfg_attr(feature = "extras", serde(skip_serializing_if = "Option::is_none"))]
pub extras: Extras,
}
/// Array of size `count * number_of_components` storing the displaced
/// accessor attributes pointed by `accessor::sparse::Indices`.
#[derive(Clone, Debug, Deserialize, Serialize, Validate)]
pub struct Values {
/// The parent buffer view containing the sparse indices.
///
/// The referenced buffer view must not have `ARRAY_BUFFER` nor
/// `ELEMENT_ARRAY_BUFFER` as its target.
#[serde(rename = "bufferView")]
pub buffer_view: Index<buffer::View>,
/// The offset relative to the start of the parent buffer view in bytes.
#[serde(default, rename = "byteOffset")]
pub byte_offset: u32,
/// Extension specific data.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub extensions: Option<extensions::accessor::sparse::Values>,
/// Optional application specific data.
#[serde(default)]
#[cfg_attr(feature = "extras", serde(skip_serializing_if = "Option::is_none"))]
pub extras: Extras,
}
}
/// A typed view into a buffer view.
#[derive(Clone, Debug, Deserialize, Serialize, Validate)]
pub struct Accessor {
/// The parent buffer view this accessor reads from.
#[serde(rename = "bufferView")]
pub buffer_view: Index<buffer::View>,
/// The offset relative to the start of the parent `BufferView` in bytes.
#[serde(default, rename = "byteOffset")]
pub byte_offset: u32,
/// The number of components within the buffer view - not to be confused
/// with the number of bytes in the buffer view.
pub count: u32,
/// The data type of components in the attribute.
#[serde(rename = "componentType")]
pub component_type: Checked<GenericComponentType>,
/// Extension specific data.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub extensions: Option<extensions::accessor::Accessor>,
/// Optional application specific data.
#[serde(default)]
#[cfg_attr(feature = "extras", serde(skip_serializing_if = "Option::is_none"))]
pub extras: Extras,
/// Specifies if the attribute is a scalar, vector, or matrix.
#[serde(rename = "type")]
pub type_: Checked<Type>,
/// Minimum value of each component in this attribute.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub min: Option<Value>,
/// Maximum value of each component in this attribute.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub max: Option<Value>,
/// 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>,
/// Specifies whether integer data values should be normalized.
#[serde(default, skip_serializing_if = "is_normalized_default")]
pub normalized: bool,
/// Sparse storage of attributes that deviate from their initialization
/// value.
#[serde(default)]
#[serde(skip_serializing_if = "Option::is_none")]
pub sparse: Option<sparse::Sparse>,
}
// Help serde avoid serializing this glTF 2.0 default value.
fn is_normalized_default(b: &bool) -> bool {
!*b
}
/// The data type of an index.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub struct IndexComponentType(pub ComponentType);
/// The data type of a generic vertex attribute.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub struct GenericComponentType(pub ComponentType);
impl<'de> de::Deserialize<'de> for Checked<GenericComponentType> {
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<GenericComponentType>;
fn expecting(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "any of: {:?}", VALID_COMPONENT_TYPES)
}
fn visit_u64<E>(self, value: u64) -> Result<Self::Value, E>
where E: de::Error
{
use self::ComponentType::*;
use crate::validation::Checked::*;
Ok(match value as u32 {
BYTE => Valid(GenericComponentType(I8)),
UNSIGNED_BYTE => Valid(GenericComponentType(U8)),
SHORT => Valid(GenericComponentType(I16)),
UNSIGNED_SHORT => Valid(GenericComponentType(U16)),
UNSIGNED_INT => Valid(GenericComponentType(U32)),
FLOAT => Valid(GenericComponentType(F32)),
_ => Invalid,
})
}
}
deserializer.deserialize_u64(Visitor)
}
}
impl<'de> de::Deserialize<'de> for Checked<IndexComponentType> {
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<IndexComponentType>;
fn expecting(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "any of: {:?}", VALID_INDEX_TYPES)
}
fn visit_u64<E>(self, value: u64) -> Result<Self::Value, E>
where E: de::Error
{
use self::ComponentType::*;
use crate::validation::Checked::*;
Ok(match value as u32 {
UNSIGNED_BYTE => Valid(IndexComponentType(U8)),
UNSIGNED_SHORT => Valid(IndexComponentType(U16)),
UNSIGNED_INT => Valid(IndexComponentType(U32)),
_ => Invalid,
})
}
}
deserializer.deserialize_u64(Visitor)
}
}
impl<'de> de::Deserialize<'de> for Checked<Type> {
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<Type>;
fn expecting(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "any of: {:?}", VALID_ACCESSOR_TYPES)
}
fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
where E: de::Error
{
use self::Type::*;
use crate::validation::Checked::*;
Ok(match value {
"SCALAR" => Valid(Scalar),
"VEC2" => Valid(Vec2),
"VEC3" => Valid(Vec3),
"VEC4" => Valid(Vec4),
"MAT2" => Valid(Mat2),
"MAT3" => Valid(Mat3),
"MAT4" => Valid(Mat4),
_ => Invalid,
})
}
}
deserializer.deserialize_str(Visitor)
}
}
impl ser::Serialize for Type {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: ser::Serializer
{
serializer.serialize_str(match *self {
Type::Scalar => "SCALAR",
Type::Vec2 => "VEC2",
Type::Vec3 => "VEC3",
Type::Vec4 => "VEC4",
Type::Mat2 => "MAT2",
Type::Mat3 => "MAT3",
Type::Mat4 => "MAT4",
})
}
}
impl ComponentType {
/// Returns the number of bytes this value represents.
pub fn size(&self) -> usize {
use self::ComponentType::*;
match *self {
I8 | U8 => 1,
I16 | U16 => 2,
F32 | U32 => 4,
}
}
/// Returns the corresponding `GLenum`.
pub fn as_gl_enum(self) -> u32 {
match self {
ComponentType::I8 => BYTE,
ComponentType::U8 => UNSIGNED_BYTE,
ComponentType::I16 => SHORT,
ComponentType::U16 => UNSIGNED_SHORT,
ComponentType::U32 => UNSIGNED_INT,
ComponentType::F32 => FLOAT,
}
}
}
impl ser::Serialize for ComponentType {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: ser::Serializer
{
serializer.serialize_u32(self.as_gl_enum())
}
}
impl Type {
/// Returns the equivalent number of scalar quantities this type represents.
pub fn multiplicity(&self) -> usize {
use self::Type::*;
match *self {
Scalar => 1,
Vec2 => 2,
Vec3 => 3,
Vec4 | Mat2 => 4,
Mat3 => 9,
Mat4 => 16,
}
}
}