gox 0.2.0

Library for loading Goxel .gox files.
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

#![forbid(overflowing_literals)]
#![deny(missing_copy_implementations)]
#![deny(missing_debug_implementations)]
//#![deny(missing_docs)]
#![deny(intra_doc_link_resolution_failure)]
#![deny(path_statements)]
#![deny(trivial_bounds)]
#![deny(type_alias_bounds)]
#![deny(unconditional_recursion)]
#![deny(unused)]
#![deny(bad_style)]
#![deny(future_incompatible)]
#![deny(rust_2018_compatibility)]
#![deny(rust_2018_idioms)]
#![allow(unused_unsafe)]

use std::io::Read;

mod block;
mod bounded;
mod camera;
mod chunk;
mod data;
mod image;
mod layer;
mod memory;
mod utils;

pub use self::{
    block::Block, bounded::Bounded, camera::Camera, chunk::Chunk, data::Data, image::Image,
    layer::Layer, layer::Shape, memory::Memory, utils::get_box_size, utils::get_value,
    utils::get_value_int, utils::get_value_string, utils::parse_float, utils::read,
    utils::read_dict, utils::read_int, utils::read_str, utils::read_u8,
};

/*
 * File format, version 2:
 *
 * This is inspired by the png format, where the file consists of a list of
 * chunks with different types.
 *
 *  4 bytes magic string        : "GOX "
 *  4 bytes version             : 2
 *  List of chunks:
 *      4 bytes: type
 *      4 bytes: data length
 *      n bytes: data
 *      4 bytes: CRC
 *
 *  The layer can end with a DICT:
 *      for each entry:
 *          4 byte : key size (0 = end of dict)
 *          n bytes: key
 *          4 bytes: value size
 *          n bytes: value
 *
 *  chunks types:
 *
 *  IMG : a dict of info:
 *      - box: the image gox.
 *
 *  PREV: a png image for preview.
 *
 *  BL16: a 16^3 block saved as a 64x64 png image.
 *
 *  LAYR: a layer:
 *      4 bytes: number of blocks.
 *      for each block:
 *          4 bytes: block index
 *          4 bytes: x
 *          4 bytes: y
 *          4 bytes: z
 *          4 bytes: 0
 *      [DICT]
 *
 *  CAMR: a camera:
 *      [DICT] containing the following entries:
 *          name: string
 *          dist: float
 *          rot: quaternion
 *          ofs: offset
 *          ortho: bool
 *
 */

#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub enum Only {
    Blocks,
    Camera,
    Layers,
    //    Preview,
}

#[derive(Debug)]
pub struct Gox {
    pub version: i32,
    pub data: Vec<Data>,
}

impl Gox {
    pub fn new(stream: &mut dyn Read, only: Vec<Only>) -> Self {
        let _magic = read(stream, 4);
        let version = read_int(stream);
        let data = Data::parse(stream);
        let mut chunks = vec![];

        if only.len() == 0 {
            chunks = data;
        } else {
            for chunk in data {
                match chunk {
                    Data::Blocks(_) => {
                        if only.contains(&Only::Blocks) {
                            chunks.push(chunk);
                        }
                    }
                    Data::Camera(_) => {
                        if only.contains(&Only::Camera) {
                            chunks.push(chunk);
                        }
                    }
                    Data::Layers(_, _) => {
                        if only.contains(&Only::Layers) {
                            chunks.push(chunk);
                        }
                    } //                Chunk::Preview(_) => {
                      //                    if only.contains(&Only::Preview) {
                      //                        chunks.push(chunk);
                      //                    }
                      //                }
                }
            }
        }

        Gox {
            version,
            data: chunks,
        }
    }
}