bone.hpp

Go to the documentation of this file.

#pragma once

 
#include <cstdint>
 
#include <welder/vocabulary.hpp>
 
#include <wowlib/core/lang.hpp>
#include <wowlib/core/client_version.hpp>
#include <wowlib/formats/m2/boundaries.hpp>
#include <wowlib/formats/m2/root/record/track.hpp>
 
namespace wowlib::formats::m2::root::record {
  struct [[
      =welder::weld,
      =welder::weld_as("M2CompBone"),
  WOWLIB_CS_FAMILY_SURFACE
      =welder::doc(R"(
        One skeleton bone. Abstract over the client version; construct a concrete
        version with M2CompBone.ForVersion / for_version.)")
    ]] M2CompBoneBase {
    // The concretes default operator== — the base must be comparable too.
    bool operator==(const M2CompBoneBase&) const = default;
  };
 
  enum class [[
      =welder::weld,
      =welder::flags,
      =welder::doc(
        "M2CompBone flags: parent-transform exemptions, billboarding "
        "and physics participation.")
    ]] BoneFlags : std::uint32_t {
    IgnoreParentTranslate [[=welder::doc("Do not inherit parent translation.")]] = 0x1,
    IgnoreParentScale [[=welder::doc("Do not inherit parent scale.")]] = 0x2,
    IgnoreParentRotation [[=welder::doc("Do not inherit parent rotation.")]] = 0x4,
    SphericalBillboard [[=welder::doc("Always face the viewer.")]] = 0x8,
    CylindricalBillboardLockX [[=welder::doc("Billboard around the X axis.")]] = 0x10,
    CylindricalBillboardLockY [[=welder::doc("Billboard around the Y axis.")]] = 0x20,
    CylindricalBillboardLockZ [[=welder::doc("Billboard around the Z axis.")]] = 0x40,
    Transformed [[=welder::doc("Has an animated transform.")]] = 0x200,
    KinematicBone [[=welder::doc("MoP+: physics may drive this bone.")]] = 0x400,
    HelmetAnimScaled [[=welder::doc("Scale by the helmet-anim-scaling record.")]
    ] = 0x1000,
    SequenceId [[=welder::doc(
      "BfA+: parent_bone/submesh_id form a sequence id.")]] = 0x2000
  };
 
  namespace detail {
    // The annotated era layouts; instantiate through the canonicalizing
    // aliases below, never directly.
    template <ClientVersion V>
    struct M2CompBone;
 
    template <ClientVersion V>
      requires (V < M2CompressedBones)
    struct [[
        =welder::weld,
        =welder::doc(
          "A bone, vanilla layout: raw-quaternion rotations, no name CRC.")
      ]] M2CompBone<V> : M2CompBoneBase {
      [[=welder::doc("Key-bone-lookup back reference, -1 if none.")]]
      std::int32_t keyBoneId = -1;
      [[=welder::doc("See BoneFlags.")]]
      BoneFlags flags{};
      [[=welder::doc("Parent bone index, -1 for roots.")]]
      std::int16_t parentBone = -1;
      [[=welder::doc("Mesh part id.")]]
      std::uint16_t submeshId = 0;
      [[=welder::doc("Translation keyframes, relative to the parent bone.")]]
      record::M2Track<C3Vector, V> translation{};
      [[=welder::doc("Rotation keyframes as raw quaternions.")]]
      record::M2Track<C4Quaternion, V> rotation{};
      [[=welder::doc("Scale keyframes.")]]
      record::M2Track<C3Vector, V> scale{};
      [[=welder::doc("The bone's pivot point.")]]
      C3Vector pivot{};
 
      bool operator==(const M2CompBone&) const = default;
    };
 
    template <ClientVersion V>
      requires (V >= M2CompressedBones)
    struct [[
        =welder::weld,
        =welder::doc(
          "A bone (TBC+): compressed-quaternion rotations plus the debug name "
          "CRC; the track era inside follows the entity version.")
      ]] M2CompBone<V> : M2CompBoneBase {
      [[=welder::doc("Key-bone-lookup back reference, -1 if none.")]]
      std::int32_t keyBoneId = -1;
      [[=welder::doc("See BoneFlags.")]]
      BoneFlags flags{};
      [[=welder::doc("Parent bone index, -1 for roots.")]]
      std::int16_t parentBone = -1;
      [[=welder::doc("Mesh part id.")]]
      std::uint16_t submeshId = 0;
      [[=welder::doc("CRC of the authoring bone name (debug only).")]]
      std::uint32_t boneNameCrc = 0;
      [[=welder::doc("Translation keyframes, relative to the parent bone.")]]
      record::M2Track<C3Vector, V> translation{};
      [[=welder::doc("Rotation keyframes as compressed quaternions.")]]
      record::M2Track<M2CompQuat, V> rotation{};
      [[=welder::doc("Scale keyframes.")]]
      record::M2Track<C3Vector, V> scale{};
      [[=welder::doc("The bone's pivot point.")]]
      C3Vector pivot{};
 
      bool operator==(const M2CompBone&) const = default;
    };
  }

  template <ClientVersion V>
  using M2CompBone =
  detail::M2CompBone<canonicalVersion(V, M2BonePivots, M2Versions)>;
}