boundaries.hpp

Go to the documentation of this file.

#pragma once

 
#include <array>
#include <cstdint>
#include <utility>
 
#include <wowlib/core/client_builds.hpp>
#include <wowlib/core/client_version.hpp>
#include <wowlib/formats/common/version_range.hpp>
 
namespace wowlib::formats::m2 {
  inline constexpr ClientVersion M2CompressedBones = builds::TBC;

  inline constexpr ClientVersion M2PerSequenceTimelines = builds::WotLK;

  inline constexpr ClientVersion M2MultitexParticles = builds::Cata;

  inline constexpr ClientVersion M2SplitBlendTimes = builds::WoD;

  inline constexpr ClientVersion M2ChunkedContainer = builds::Legion_Alpha;

  inline constexpr ClientVersion M2ChunkedOnly = builds::BfA;

  consteval std::uint32_t m2FormatVersion(ClientVersion v) {
    if (v >= M2ChunkedContainer) return 274;
    if (v >= M2MultitexParticles) return 272;
    if (v >= M2PerSequenceTimelines) return 264;
    if (v >= M2CompressedBones) return 263;
    return 256;
  }

  consteval std::pair<std::uint32_t, std::uint32_t> m2FormatVersionRange(ClientVersion v) {
    if (v >= M2ChunkedContainer) return {264, 274};
    if (v >= M2MultitexParticles) return {265, 273};
    if (v >= M2PerSequenceTimelines) return {264, 264};
    if (v >= M2CompressedBones) return {258, 263};
    return {256, 257};
  }
 
  // --- version grids and per-family canonicalization pivots -----------------
  //
  // Every versioned M2 family instantiates only for its REAL content
  // permutations: the public name is a canonicalizing alias over the nested
  // detail:: template (see formats/common/version_range.hpp), flooring the
  // requested version over the family's pivots below. A pivot that does not
  // separate two grid versions is a harmless no-op, so the lists are
  // generous — they name every documented change, not just the ones the
  // current grid straddles. The welded range tables in m2.hpp are
  // consteval-checked against these lists (rangesValid), so neither side
  // can drift.

  inline constexpr std::array M2Versions{
    versions::Vanilla,
    versions::Tbc,
    versions::Wotlk,
    versions::Cata,
    versions::Mop,
    versions::Wod,
    versions::Legion,
    versions::Bfa,
    versions::Shadowlands,
    versions::Dragonflight,
    versions::Tww
  };

  inline constexpr std::array M2SkinVersions{
    versions::Wotlk,
    versions::Cata,
    versions::Mop,
    versions::Wod,
    versions::Legion,
    versions::Bfa,
    versions::Shadowlands,
    versions::Dragonflight,
    versions::Tww
  };

  inline constexpr std::array M2ChunkedVersions{
    versions::Legion,
    versions::Bfa,
    versions::Shadowlands,
    versions::Dragonflight,
    versions::Tww
  };

  inline constexpr std::array M2TrackPivots{M2PerSequenceTimelines};

  inline constexpr std::array M2SequencePivots{M2PerSequenceTimelines, M2SplitBlendTimes};

  inline constexpr std::array M2BonePivots{M2CompressedBones, M2PerSequenceTimelines};

  inline constexpr std::array M2CameraPivots{M2PerSequenceTimelines, M2MultitexParticles};

  inline constexpr std::array M2ParticlePivots{M2CompressedBones, M2PerSequenceTimelines, M2MultitexParticles};

  inline constexpr std::array M2SkinSectionPivots{M2CompressedBones};

  inline constexpr std::array M2SkinProfilePivots{M2CompressedBones, M2MultitexParticles};

  inline constexpr std::array M2SkinPivots{M2PerSequenceTimelines, M2MultitexParticles};

  inline constexpr std::array M2DataPivots{
    M2CompressedBones,
    M2PerSequenceTimelines,
    M2MultitexParticles,
    M2SplitBlendTimes,
    M2ChunkedContainer
  };

  inline constexpr std::array M2FilePivots{
    M2ChunkedContainer,
    builds::Legion_ShadowsOfArgus_24500,
    // EXP2/PABC/PADC/PSBC/PEDC/SKID
    builds::BfA_Beta,
    // TXID/LDV1
    builds::BfA_TidesOfVengeance,
    // RPID/GPID
    builds::BfA_RiseOfAzshara,
    // WFV1/WFV2/PGD1
    builds::BfA_VisionsOfNzoth_35662,
    // PFDC (9.0.1-alpha chunk backported)
    builds::SL_Alpha_33978,
    // WFV3/EDGF/NERF/DBOC
    builds::SL_Alpha_34365,
    // DETL
    builds::DF,
    // AFRA
    builds::TWW_LegacyOfArathor
  }; // PCOL/DPIV

  inline constexpr std::array<ClientVersion, 0> M2ChunkPayloadPivots{};

  inline constexpr std::array M2AssemblyPivots{
    M2CompressedBones,
    M2PerSequenceTimelines,
    M2MultitexParticles,
    M2SplitBlendTimes,
    M2ChunkedContainer,
    M2ChunkedOnly,
    builds::Legion_ShadowsOfArgus_24500,
    builds::BfA_Beta,
    builds::BfA_TidesOfVengeance,
    builds::BfA_RiseOfAzshara,
    builds::BfA_VisionsOfNzoth_35662,
    builds::SL_Alpha_33978,
    builds::SL_Alpha_34365,
    builds::DF,
    builds::TWW_LegacyOfArathor
  };
}