whiteoutlib 0.1.2

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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026 Fernando Sahmkow

#pragma once

#include <whiteout/models/m3/structures.h>
#include <whiteout/models/m3/types.h>
#include "../../common/binary_writer.h"
#include "inner_structure_types.h"

#include <deque>
#include <functional>

namespace whiteout {
namespace m3 {

/// Visitor that writes an M3 Model to binary format.
/// Preserves original chunk layout for byte-identical round-trip.
class BinaryWriterVisitor {
public:
    explicit BinaryWriterVisitor(common::BinaryWriter& writer, bool ismd33 = false);

    /// Write the complete model.
    void write(const Model& model);

protected:
    void visit(const Model& model, u32 version);
    void visit(const VertexBuffer& value, u32 version);
    void visit(const Sequence& seq, u32 version);
    void visit(const SubTrackContainer& container, u32 version);
    void visit(const AnimationGroup& group, u32 version);
    void visit(const BoneAnimationSet& set, u32 version);
    void visit(const AnimationState& state, u32 version);
    void visit(const Bone& bone, u32 version);
    void visit(const MeshDivision& division, u32 version);
    void visit(const AttachmentPoint& point, u32 version);
    void visit(const Light& light, u32 version);
    void visit(const ShadowBox& box, u32 version);
    void visit(const Camera& camera, u32 version);
    void visit(const MaterialMap& map, u32 version);
    void visit(const StandardMaterial& material, u32 version);
    void visit(const DisplacementMaterial& material, u32 version);
    void visit(const CompositeSection& section, u32 version);
    void visit(const CompositeMaterial& material, u32 version);
    void visit(const TerrainMaterial& material, u32 version);
    void visit(const VolumeMaterial& material, u32 version);
    void visit(const HairMaterial& material, u32 version);
    void visit(const CreepMaterial& material, u32 version);
    void visit(const VolumeNoiseMaterial& material, u32 version);
    void visit(const STBMaterial& material, u32 version);
    void visit(const ReflectionMaterial& material, u32 version);
    void visit(const LensFlare& flare, u32 version);
    void visit(const MaterialAddData& data, u32 version);
    void visit(const ParticleEmitter& emitter, u32 version);
    void visit(const ParticleEmitterCopy& copy, u32 version);
    void visit(const RibbonEmitter& emitter, u32 version);
    void visit(const Projector& projector, u32 version);
    void visit(const Force& force, u32 version);
    void visit(const Warp& warp, u32 version);
    void visit(const ViewVolume& volume, u32 version);
    void visit(const RigidBody& body, u32 version);
    void visit(const PhysicsConstraint& constraint, u32 version);
    void visit(const PhysicsJoint& joint, u32 version);
    void visit(const ClothPhysics& cloth, u32 version);
    void visit(const IKTwoJoint& joint, u32 version);
    void visit(const IKCCD& ccd, u32 version);
    void visit(const IKJoint& joint, u32 version);
    void visit(const OneBoneSolver& solver, u32 version);
    void visit(const TurretBehavior& behavior, u32 version);
    void visit(const TriggerData& trigger, u32 version);
    void visit(const InitialReference& ref, u32 version);
    void visit(const HitTestShape& shape, u32 version);
    void visit(const AttachmentVolume& volume, u32 version);
    void visit(const BillboardBehavior& behavior, u32 version);
    void visit(const TrailingModel& model, u32 version);
    void visit(const Event& event, u32 version);
    void visit(const Region& region, u32 version);
    void visit(const Batch& batch, u32 version);
    void visit(const MeshSection& section, u32 version);
    void visit(const TextureLayer& layer, u32 version);
    void visit(const SubFlare& flare, u32 version);
    void visit(const SplineRibbon& ribbon, u32 version);
    void visit(const PhysicsShape& shape, u32 version);
    void visit(const PhysicsMeshTriangle& triangle, u32 version);
    void visit(const PhysicsMeshEdge& edge, u32 version);
    void visit(const PhysicsMeshBvhNode& normal, u32 version);
    void visit(const ConvexHullHalfEdge& edge, u32 version);
    void visit(const ClothCollider& collider, u32 version);
    void visit(const ClothProxy& proxy, u32 version);

    template <typename T>
    void visit(const AnimBlock<T>& block, u32 version);

    template <typename T>
    void visit(const std::vector<T>& container);

    template <typename T>
    void visit(const std::optional<T>& container);

    void visit(const std::string& str, u32 version);
    void visit(const std::string& str);

    void transferDeferredWrites(bool pre_order = true);

    std::function<void(Reference&)> writeReferenceFunc;

    std::deque<std::function<void()>> currentLevelWrites;
    std::deque<std::function<void()>> deferredWrites;
    std::vector<IndexEntry> indexTable;

    common::BinaryWriter& writer;
    bool ismd33;
};

} // namespace m3
} // namespace whiteout