wowlib::formats::m2::AnimBuffers Class Reference

The per-sequence external write buffers every M2-family write path shares: an external sequence's data lands in its own per-key buffer as the tracks route their blocks through sink(); inline sequences (and aliases, whose flags never mark them external) stay in the entity image. More...

#include <wowlib/formats/m2/satellites.hpp>

Public Member Functions
template<typename Sequence>
OffsetWriteContext	sink (const std::vector< Sequence > &sequences)
	The write context routing external sequences into this buffer set.
const std::map< SequenceKey, FileBuffer > &	entries () const
	The filled buffers, keyed and ordered by sequence key.
void	appendChunkTo (FileBuffer &out, std::uint32_t fourcc, SequenceKey key) const
	Append this set's buffer for key to out as one fourcc+size+payload chunk (assembling .anim files).

Static Public Member Functions
static std::set< SequenceKey >	mergedKeys (std::initializer_list< const AnimBuffers * > sets)
	The union of every set's keys — one .anim file exists per key across all sections (AFM2 + AFSA + AFSB).

Detailed Description

The per-sequence external write buffers every M2-family write path shares: an external sequence's data lands in its own per-key buffer as the tracks route their blocks through sink(); inline sequences (and aliases, whose flags never mark them external) stay in the entity image.

The buffers then assemble into .anim files chunk by chunk.

Definition at line 181 of file satellites.hpp.

Member Function Documentation

appendChunkTo()

void wowlib::formats::m2::AnimBuffers::appendChunkTo ( FileBuffer & out, std::uint32_t fourcc, SequenceKey key ) const

inline

Append this set's buffer for key to out as one fourcc+size+payload chunk (assembling .anim files).

A key this set never filled still appends an EMPTY section — the client requests the file and expects the chunk whenever the flags say so.

Definition at line 206 of file satellites.hpp.

References wowlib::formats::fourcc().

Referenced by wowlib::formats::m2::detail::Skeleton< V >::write().

entries()

const std::map< SequenceKey, FileBuffer > & wowlib::formats::m2::AnimBuffers::entries ( ) const

inline

The filled buffers, keyed and ordered by sequence key.

Definition at line 200 of file satellites.hpp.

mergedKeys()

std::set< SequenceKey > wowlib::formats::m2::AnimBuffers::mergedKeys ( std::initializer_list< const AnimBuffers * > sets )

inlinestatic

The union of every set's keys — one .anim file exists per key across all sections (AFM2 + AFSA + AFSB).

Definition at line 214 of file satellites.hpp.

Referenced by wowlib::formats::m2::detail::Skeleton< V >::write().

sink()

template<typename Sequence>

OffsetWriteContext wowlib::formats::m2::AnimBuffers::sink ( const std::vector< Sequence > & sequences )

inline

The write context routing external sequences into this buffer set.

Parameters

sequences

the sequence table driving the flags; taken by reference and read lazily, like the read resolver.

Returns

the context with OffsetWriteContext::sequenceSink installed.

Definition at line 188 of file satellites.hpp.

References wowlib::formats::m2::OffsetWriteContext::sequenceSink.

Referenced by wowlib::formats::m2::detail::Skeleton< V >::write().

---

The documentation for this class was generated from the following file:

• src/wowlib/formats/m2/satellites.hpp