ds3 0.1.0

Pure-Rust parser for Autodesk 3D Studio (.3ds) binary 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
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 crate::Mesh3ds;

#[cfg(not(feature = "std"))]
use alloc::{collections::BTreeMap, vec, vec::Vec};
#[cfg(feature = "std")]
use std::collections::BTreeMap;

/// Buffers produced by [`Mesh3ds::to_flat_buffers`] or [`Mesh3ds::to_smooth_buffers`].
#[derive(Debug, Clone)]
pub struct MeshBuffers {
    /// Vertex positions.
    pub positions: Vec<[f32; 3]>,
    /// Per-vertex surface normals (unit length).
    pub normals: Vec<[f32; 3]>,
    /// Texture coordinates, parallel to `positions`.
    pub uvs: Vec<[f32; 2]>,
    /// Triangle index buffer; every 3 consecutive elements form one triangle.
    pub indices: Vec<u32>,
}

// ── Flat shading ─────────────────────────────────────────────────────────────

pub(crate) fn to_flat(mesh: &Mesh3ds) -> MeshBuffers {
    let face_count = mesh.faces.len();
    let mut positions = Vec::with_capacity(face_count * 3);
    let mut normals = Vec::with_capacity(face_count * 3);
    let mut uvs = Vec::with_capacity(face_count * 3);
    let mut indices = Vec::with_capacity(face_count * 3);

    for (fi, &[a, b, c]) in mesh.faces.iter().enumerate() {
        let va = mesh.vertices[a as usize];
        let vb = mesh.vertices[b as usize];
        let vc = mesh.vertices[c as usize];

        let n = face_normal(va, vb, vc);

        positions.push(va);
        positions.push(vb);
        positions.push(vc);

        normals.push(n);
        normals.push(n);
        normals.push(n);

        if let (Some(ua), Some(ub), Some(uc)) = (
            mesh.uvs.get(a as usize),
            mesh.uvs.get(b as usize),
            mesh.uvs.get(c as usize),
        ) {
            uvs.push(*ua);
            uvs.push(*ub);
            uvs.push(*uc);
        } else {
            uvs.push([0.0, 0.0]);
            uvs.push([0.0, 0.0]);
            uvs.push([0.0, 0.0]);
        }

        let base = (fi * 3) as u32;
        indices.push(base);
        indices.push(base + 1);
        indices.push(base + 2);
    }

    MeshBuffers { positions, normals, uvs, indices }
}

// ── Smooth shading ───────────────────────────────────────────────────────────

pub(crate) fn to_smooth(mesh: &Mesh3ds) -> MeshBuffers {
    if mesh.smooth_groups.is_empty() || mesh.smooth_groups.len() != mesh.faces.len() {
        return to_flat(mesh);
    }

    // 1. Precompute area-weighted face normals.
    let face_normals: Vec<[f32; 3]> = mesh
        .faces
        .iter()
        .map(|&[a, b, c]| {
            let va = mesh.vertices[a as usize];
            let vb = mesh.vertices[b as usize];
            let vc = mesh.vertices[c as usize];
            area_weighted_normal(va, vb, vc)
        })
        .collect();

    // 2. Build incident-face list for each vertex.
    //    incident[v] = list of (face_index, corner_index_in_face)
    let mut incident: Vec<Vec<(usize, usize)>> = vec![Vec::new(); mesh.vertices.len()];
    for (fi, &[a, b, c]) in mesh.faces.iter().enumerate() {
        incident[a as usize].push((fi, 0));
        incident[b as usize].push((fi, 1));
        incident[c as usize].push((fi, 2));
    }

    // 3. For each face corner, compute the smoothed normal.
    //    corner_normals[face_index][corner_index] = normal
    let mut corner_normals: Vec<[[f32; 3]; 3]> = vec![[[0.0; 3]; 3]; mesh.faces.len()];

    for refs in &incident {
        if refs.is_empty() {
            continue;
        }

        // Union-find over the incident faces at this vertex.
        let mut uf = UnionFind::new(refs.len());
        for (i, &(f1, _)) in refs.iter().enumerate() {
            let sg1 = mesh.smooth_groups[f1];
            for (j, &(f2, _)) in refs.iter().enumerate().skip(i + 1) {
                let sg2 = mesh.smooth_groups[f2];
                if sg1 & sg2 != 0 {
                    uf.union(i, j);
                }
            }
        }

        // Sum area-weighted normals per component.
        let mut sums: BTreeMap<usize, [f32; 3]> = BTreeMap::new();
        for (idx, &(fi, _)) in refs.iter().enumerate() {
            let root = uf.find(idx);
            let n = face_normals[fi];
            let entry = sums.entry(root).or_insert([0.0; 3]);
            *entry = add(*entry, n);
        }

        // Normalize and assign back.
        let mut normalized: BTreeMap<usize, [f32; 3]> = BTreeMap::new();
        for (&root, &sum) in &sums {
            normalized.insert(root, normalize(sum));
        }

        for (idx, &(fi, corner)) in refs.iter().enumerate() {
            let root = uf.find(idx);
            corner_normals[fi][corner] = normalized[&root];
        }
    }

    // 4. Build output mesh, deduplicating corners with identical (vertex, normal, uv).
    //    Pre-size to mesh.vertices.len() as a lower-bound estimate before any seam splits.
    let mut positions = Vec::with_capacity(mesh.vertices.len());
    let mut normals = Vec::with_capacity(mesh.vertices.len());
    let mut uvs = Vec::with_capacity(mesh.vertices.len());
    let mut indices = Vec::with_capacity(mesh.faces.len() * 3);

    // Key: (vertex_index, normal_bits)
    // We quantize normals to f32 bit patterns for exact BTreeMap equality.
    let mut seen: BTreeMap<(u16, [u32; 3]), u32> = BTreeMap::new();

    for (fi, &[a, b, c]) in mesh.faces.iter().enumerate() {
        for (corner, &v) in [a, b, c].iter().enumerate() {
            let n = corner_normals[fi][corner];
            let uv = mesh
                .uvs
                .get(v as usize)
                .copied()
                .unwrap_or([0.0, 0.0]);

            let key = (v, [n[0].to_bits(), n[1].to_bits(), n[2].to_bits()]);

            let idx = if let Some(&idx) = seen.get(&key) {
                idx
            } else {
                let new_idx = positions.len() as u32;
                positions.push(mesh.vertices[v as usize]);
                normals.push(n);
                uvs.push(uv);
                seen.insert(key, new_idx);
                new_idx
            };

            indices.push(idx);
        }
    }

    MeshBuffers { positions, normals, uvs, indices }
}

// ── Math helpers ─────────────────────────────────────────────────────────────

fn sub(a: [f32; 3], b: [f32; 3]) -> [f32; 3] {
    [a[0] - b[0], a[1] - b[1], a[2] - b[2]]
}

fn cross(a: [f32; 3], b: [f32; 3]) -> [f32; 3] {
    [
        a[1] * b[2] - a[2] * b[1],
        a[2] * b[0] - a[0] * b[2],
        a[0] * b[1] - a[1] * b[0],
    ]
}

fn dot(a: [f32; 3], b: [f32; 3]) -> f32 {
    a[0] * b[0] + a[1] * b[1] + a[2] * b[2]
}

fn scale(a: [f32; 3], s: f32) -> [f32; 3] {
    [a[0] * s, a[1] * s, a[2] * s]
}

fn add(a: [f32; 3], b: [f32; 3]) -> [f32; 3] {
    [a[0] + b[0], a[1] + b[1], a[2] + b[2]]
}

fn len_sq(a: [f32; 3]) -> f32 {
    dot(a, a)
}

fn normalize(a: [f32; 3]) -> [f32; 3] {
    let l2 = len_sq(a);
    if l2 > 0.0 {
        scale(a, 1.0 / fsqrt(l2))
    } else {
        [0.0, 1.0, 0.0]
    }
}

/// `f32::sqrt` is only in `std`; in `no_std` builds we use two Newton
/// iterations which give < 1 ULP error for the values encountered here.
#[cfg(feature = "std")]
#[inline]
fn fsqrt(x: f32) -> f32 {
    x.sqrt()
}

#[cfg(not(feature = "std"))]
#[inline]
fn fsqrt(x: f32) -> f32 {
    if x <= 0.0 {
        return 0.0;
    }
    // IEEE 754 bit-hack initial guess, then two Newton iterations.
    let mut r = f32::from_bits((x.to_bits() >> 1).wrapping_add(0x1fbb_3f80));
    r = 0.5 * (r + x / r);
    r = 0.5 * (r + x / r);
    r
}

fn face_normal(a: [f32; 3], b: [f32; 3], c: [f32; 3]) -> [f32; 3] {
    let e1 = sub(b, a);
    let e2 = sub(c, a);
    normalize(cross(e1, e2))
}

fn area_weighted_normal(a: [f32; 3], b: [f32; 3], c: [f32; 3]) -> [f32; 3] {
    let e1 = sub(b, a);
    let e2 = sub(c, a);
    // cross(e1, e2) has magnitude 2*area. We return 0.5*cross so magnitude == area.
    scale(cross(e1, e2), 0.5)
}

// ── Union-Find ───────────────────────────────────────────────────────────────

struct UnionFind {
    parent: Vec<usize>,
}

impl UnionFind {
    fn new(n: usize) -> Self {
        Self {
            parent: (0..n).collect(),
        }
    }

    fn find(&mut self, x: usize) -> usize {
        if self.parent[x] != x {
            self.parent[x] = self.find(self.parent[x]);
        }
        self.parent[x]
    }

    fn union(&mut self, x: usize, y: usize) {
        let px = self.find(x);
        let py = self.find(y);
        if px != py {
            self.parent[px] = py;
        }
    }
}