fogs.hpp

Go to the documentation of this file.

#pragma once

 
#include <cstdint>
#include <vector>
 
#include <wowlib/core/client_builds.hpp>
#include <wowlib/core/client_version.hpp>
#include <wowlib/core/lang.hpp>
#include <wowlib/formats/common/chunked_file.hpp>
#include <wowlib/formats/common/fourcc.hpp>
#include <wowlib/formats/common/version_slot.hpp>
#include <wowlib/formats/wdt/boundaries.hpp>
#include <wowlib/formats/wdt/fogs/chunks/records.hpp>
 
namespace wowlib::formats::wdt::fogs {
  using namespace wowlib::formats::wdt::fogs::chunks;

  struct [[
      =welder::weld,
      =welder::weld_as("WDTFogs"),
  WOWLIB_CS_FAMILY_SURFACE
      =welder::doc(R"(
        A _fogs.wdt volumetric-fog satellite (Legion 7.2.5+), abstract over
        the client version. Construct a concrete version with
        WDTFogs.for_version(expansion). See https://wowdev.wiki/WDT.)")
    ]] WDTFogsBase {};
 
  namespace detail {
    // --- version-range trait bases (unwelded) ---------------------------------

    struct FogsBfa {
      [[
        =chunk("VFOG"),
        =since(builds::BfA_Beta_25902),
        =formats::Optional,
        =welder::mark::no_reassign,
        =welder::doc("The volumetric fogs (VFOG, 8.0+).")]]
      std::vector<VolumetricFog> fogs;
    };

    struct FogsTww {
      [[
        =chunk("VFEX"),
        =since(builds::TWW_Alpha_54935),
        =formats::Optional,
        =welder::mark::no_reassign,
        =welder::doc(
          "The VFOG extension records (VFEX, 11.0+, format version 2), "
          "matched to fogs by id.")]]
      std::vector<VolumetricFogExtra> fogExtras;
    };
  }
 
  namespace detail {
    template <ClientVersion V>
    struct [[
        =welder::weld,
        =welder::doc(R"(
          A _fogs.wdt volumetric-fog satellite for one client version (Legion
          7.2.5+): the map's placed fog volumes. Most maps ship it empty. See
          https://wowdev.wiki/WDT.)")
      ]] WDTFogs
      : ChunkedFile<WDTFogs<V>>,
        WDTFogsBase,
        Slot<V, builds::BfA_Beta_25902, FogsBfa>,
        Slot<V, builds::TWW_Alpha_54935, FogsTww> {
      static constexpr ClientVersion Version = V;
 
      [[
        =chunk("MVER"),
        =welder::doc("The file format version: 1 since Legion 7.2.5, 2 since "
          "11.0.0.54935 (adds VFEX).")]]
      std::uint32_t mver = V >= builds::TWW_Alpha_54935 ? 2 : 1;

      static constexpr std::array ChunkOrder = {fourcc("MVER"), fourcc("VFOG"), fourcc("VFEX"),};
    };
  }

  template <ClientVersion V> requires(V >= builds::Legion_TombOfSargeras)
  using WDTFogs = detail::WDTFogs<canonicalVersion(V, WdtFogsPivots, WdtFogsVersions)>;
}