tmf 0.2.1

TMF is a 3D model compression format achieving compression ratio of between 4.2 and 1.95, while being very fast to read and having no visual difference between compressed and uncompressed models.
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
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

// Support functions may be used in the future for triangulation, when triangulating fully works, remove this allow.
#![allow(dead_code)]
use crate::{FloatType, IndexType, Vector3};
/// Fast method for pruning unused vertices. Finds the lowest used vertex and removes it. O(n), does **not** remove all unused vertices. Used mostly
/// in .obj loading. Fast because if not needed exits quickly.
pub(crate) fn fast_prune<T: Sized>(data: &mut Vec<T>, indices: &mut [IndexType]) {
    // Smallest index
    let mut min_index = data.len() as IndexType;
    if indices.is_empty() {
        min_index = 0;
    }
    for index in indices.iter() {
        if *index == 0 {
            return;
        };
        min_index = min_index.min(*index);
    }
    data.drain(0..(min_index as usize));
    // Begin index rebasing
    for index in &mut *indices {
        *index -= min_index;
    }
}
#[allow(non_camel_case_types)]
#[cfg(feature = "fast_trig")]
pub(crate) type fprec = f64;
#[cfg(feature = "fast_trig")]
#[cfg(feature = "fast_trig")]
const F_PI: fprec = std::f64::consts::PI;
// https://www.gamedev.net/forums/topic/621589-extremely-fast-sin-approximation/
#[cfg(feature = "fast_trig")]
#[inline(always)]
pub(crate) fn fsin(mut x: fprec) -> fprec {
    let mut z = (x * 0.3183098861837907) + 6755399441055744.0;
    let k: i32 = unsafe { *(&z as *const _ as *const _) };
    z = (k as fprec) * F_PI;
    x -= z;
    let y = x * x;
    let z = (0.0073524681968701 * y - 0.1652891139701474) * y + 0.9996919862959676;
    x *= z;
    let mut k = k & 1;
    k += k;
    let z = (k as fprec) * x;
    x - z
}
pub(crate) fn magnitude(i: Vector3) -> FloatType {
    let xx = i.0 * i.0;
    let yy = i.1 * i.1;
    let zz = i.2 * i.2;
    (xx + yy + zz).sqrt()
}
pub(crate) fn normalize(i: Vector3) -> Vector3 {
    let xx = i.0 * i.0;
    let yy = i.1 * i.1;
    let zz = i.2 * i.2;
    let mag = (xx + yy + zz).sqrt();
    if mag.is_nan() {
        (0.0, 0.0, 0.0)
    } else {
        (i.0 / mag, i.1 / mag, i.2 / mag)
    }
}
pub(crate) fn distance(a: Vector3, b: Vector3) -> FloatType {
    let dx = a.0 - b.0;
    let dy = a.1 - b.1;
    let dz = a.2 - b.2;
    (dx * dx + dy * dy + dz * dz).sqrt()
}
pub(crate) fn dot(a: Vector3, b: Vector3) -> FloatType {
    a.0 * b.0 + a.1 * b.1 + a.2 * b.2
}
pub(crate) fn cross(a: Vector3, b: Vector3) -> Vector3 {
    (
        a.1 * b.2 - a.2 * b.1,
        a.2 * b.0 - a.0 * b.2,
        a.0 * b.1 - a.1 * b.0,
    )
}
pub(crate) fn sub_vec3(a: Vector3, b: Vector3) -> Vector3 {
    (a.0 - b.0, a.1 - b.1, a.2 - b.2)
}
pub(crate) fn add_vec3(a: Vector3, b: Vector3) -> Vector3 {
    (a.0 + b.0, a.1 + b.1, a.2 + b.2)
}
pub(crate) fn optimize_triangle_indices<T: Sized + Copy + std::fmt::Debug>(
    indices: &[IndexType],
    data: &[T],
) -> (Box<[IndexType]>, Box<[T]>) {
    if indices.is_empty() || data.is_empty() {
        return (indices.into(), data.into());
    }
    const INDEX_NOT_MAPPED: usize = usize::MAX;
    let mut index_map = vec![INDEX_NOT_MAPPED; data.len()];
    let mut data_mapped: Vec<T> = Vec::with_capacity(data.len());
    let mut curr_map_index: usize = 0;
    for index in indices {
        if index_map[*index as usize] == INDEX_NOT_MAPPED {
            index_map[*index as usize] = curr_map_index;
            data_mapped.push(data[*index as usize]);
            //println!("mapping:{:?} to {curr_map_index}!",data[*index as usize]);
            curr_map_index += 1;
        }
    }
    let new_indices: Box<[IndexType]> = indices
        .iter()
        .map(|index| index_map[*index as usize] as IndexType)
        .collect();
    (new_indices, data_mapped.into())
}
fn calc_deltas(data: &[IndexType]) {
    let mut deltas = Vec::with_capacity(data.len());
    for index in 0..(data.len() - 1) {
        deltas.push((data[index] as isize - data[index + 1] as isize).unsigned_abs());
    }
    let avg = (deltas.iter().sum::<usize>()) / data.len();
    let mut delta_over_avg = 0;
    deltas.iter().for_each(|delta| {
        if *delta > avg {
            delta_over_avg += 1
        }
    });
    todo!("avg delta:{avg:?} delta_over_avg:{delta_over_avg}");
}
/*
#[test]
fn test_delta_encode(){
    use crate::{TMFMesh, TMFPrecisionInfo};
    crate::init_test_env();
    let mut file = std::fs::File::open("testing/susan.obj").unwrap();
    let (mut tmf_mesh, name) = TMFMesh::read_from_obj_one(&mut file).unwrap();
    tmf_mesh.optimize();
    delta_encode(tmf_mesh.get_vertex_triangles().unwrap());
}*/
#[test]
fn test_opt_tris() {
    let test_data = ["A", "B", "C", "D", "E"];
    let test_indices = [4, 2, 3, 4, 1, 3, 2, 0];
    let test_final: Vec<_> = test_indices
        .iter()
        .map(|index| test_data[*index as usize])
        .collect();
    let (new_indices, new_data) = optimize_triangle_indices(&test_indices, &test_data);
    let new_final: Vec<_> = new_indices
        .iter()
        .map(|index| new_data[*index as usize])
        .collect();
    assert_eq!(test_final, new_final);
}
#[test]
#[cfg(feature = "obj_import")]
fn save_optimized_susan_tmf() {
    use crate::{TMFMesh, TMFPrecisionInfo};
    crate::init_test_env();
    let mut file = std::fs::File::open("testing/susan.obj").unwrap();
    let (mut tmf_mesh, name) = TMFMesh::read_from_obj_one(&mut file).unwrap();
    tmf_mesh.verify().unwrap();
    tmf_mesh.reorder_data();
    tmf_mesh.verify().unwrap();
    let mut out = std::fs::File::create("target/test_res/optimized_susan.tmf").unwrap();
    assert_eq!(name, "Suzanne");
    let prec = TMFPrecisionInfo::default();
    tmf_mesh
        .write_tmf_one(&mut out, &prec, name.clone())
        .unwrap();
    let mut out = std::fs::File::create("target/test_res/optimized_susan.obj").unwrap();
    tmf_mesh.write_obj_one(&mut out, &name).unwrap();
}
/*
#[test]
#[cfg(feature = "obj_import")]
fn save_optimized_nefretiti_tmf() {
    use crate::{TMFMesh, TMFPrecisionInfo};
    crate::init_test_env();
    let mut file = std::fs::File::open("testing/Nefertiti.obj").unwrap();
    let (mut tmf_mesh, name) = TMFMesh::read_from_obj_one(&mut file).unwrap();
    tmf_mesh.verify().unwrap();
    tmf_mesh.optimize();
    tmf_mesh.verify().unwrap();
    let mut out = std::fs::File::create("target/test_res/optimized_nefretiti.tmf").unwrap();
    assert_eq!(name,"Nefertiti");
    let prec = TMFPrecisionInfo::default();
    tmf_mesh.write_tmf_one(&mut out, &prec, name.clone()).unwrap();
    let mut out = std::fs::File::create("target/test_res/optimized_nefretiti.obj").unwrap();
    tmf_mesh.write_obj_one(&mut out,&name).unwrap();
}*/