whiteoutlib 0.2.0

Read and write Blizzard game assets from Rust: models (MDX, M2, M3), textures (BLP, DDS, PNG, JPEG, BMP, TGA, TIFF, GIF) and archives (CASC, MPQ).
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


#pragma once

// ============================================================================
// forEachTrack — every per-sequence animation track in a Model, once each.
//
// The lazy sequence loader needs to reach the same set of tracks the parser
// filled, without holding pointers into a model that may since have been moved
// or copied. Walking the model by name is what makes that safe: the only
// requirement is that this list stays in step with the structures, which is one
// grep away (`AnimationTrack<` in structures/base.h).
//
// The client has the same list, in the same place: M2Init(M2Data&) descends
// into exactly these structures when it fixes up a single sequence, and skips
// everything else.
//
// ParticleAnimationTrack is deliberately absent — those keys run over a
// particle's lifetime, not over a sequence, so they are never split per
// sequence and never live in a `.anim`.
// ============================================================================

#include <whiteout/models/m2/structures.h>

namespace whiteout {
namespace m2 {

/// @brief Call @p f once per animation track in @p model.
///
/// @p f must accept both `AnimationTrack<T>&` (any T) and a bare
/// `AnimationTrackBase&` — Event::enabled and the PEDC parent event data are
/// timestamp-only tracks with no value array.
template <class F>
void forEachTrack(Model& model, F&& f) {
    for (auto& bone : model.bones) {
        f(bone.translation);
        f(bone.rotation);
        f(bone.scale);
    }
    for (auto& color : model.colors) {
        f(color.color);
        f(color.alpha);
    }
    for (auto& weight : model.textureWeights)
        f(weight.weight);
    for (auto& weight : model.parentTextureWeights)
        f(weight.weight);
    for (auto& transform : model.textureTransforms) {
        f(transform.translation);
        f(transform.rotation);
        f(transform.scaling);
    }
    for (auto& attachment : model.attachments)
        f(attachment.animate);
    for (auto& event : model.events)
        f(event.enabled);
    for (auto& track : model.parentEventData)
        f(track);
    for (auto& light : model.lights) {
        f(light.ambientColor);
        f(light.ambientIntensity);
        f(light.diffuseColor);
        f(light.diffuseIntensity);
        f(light.attenuationStart);
        f(light.attenuationEnd);
        f(light.visibility);
    }
    for (auto& camera : model.cameras) {
        f(camera.positions);
        f(camera.targetPositions);
        f(camera.roll);
        f(camera.fieldOfViewTrack);
    }
    for (auto& ribbon : model.ribbonEmitters) {
        f(ribbon.colorTrack);
        f(ribbon.alphaTrack);
        f(ribbon.heightAbove);
        f(ribbon.heightBelow);
        f(ribbon.texSlot);
        f(ribbon.visibility);
    }
    for (auto& emitter : model.particleEmitters) {
        f(emitter.emissionSpeed);
        f(emitter.speedVariation);
        f(emitter.verticalRange);
        f(emitter.horizontalRange);
        f(emitter.gravity);
        f(emitter.lifespan);
        f(emitter.emissionRate);
        f(emitter.emissionAreaWidth);
        f(emitter.emissionAreaLength);
        f(emitter.zSource);
        f(emitter.enabledIn);
    }
}

} // namespace m2
} // namespace whiteout