From 3c2a42586925115df891df4146181e8d08563e31 Mon Sep 17 00:00:00 2001
From: Marc-Antoine Lortie <malortie@users.noreply.github.com>
Date: Sat, 11 Mar 2023 20:46:42 -0500
Subject: [PATCH] Added a test to validate HL1 MDL bone hierarchy.

---
 test/models/MDL/MDL (HL1)/multiple_roots.mdl  | Bin 0 -> 15372 bytes
 .../MDL/utMDLImporter_HL1_Nodes.cpp           |  67 ++++++++++++++++++
 2 files changed, 67 insertions(+)
 create mode 100644 test/models/MDL/MDL (HL1)/multiple_roots.mdl

diff --git a/test/models/MDL/MDL (HL1)/multiple_roots.mdl b/test/models/MDL/MDL (HL1)/multiple_roots.mdl
new file mode 100644
index 0000000000000000000000000000000000000000..f8fc1eed708c8b3f95c5faf7c55e78cb07434771
GIT binary patch
literal 15372
zcmeI2dz2LQmB;VAV0cOMRAa!xNq7pj!iYjo|0?kTL_|i6Z=t{$5_AxR0R*Cy7$d#_
zqY)p8R3aF&W{m-c5S-~MV>S<??oqRvbFwCF)J?K+vo2Y7QH0*l{Z$o@<2Xoi^3R^B
zvHO1S{eAEE-ru8ZdJ3nUJ>#P8A~I&oDg1Z!g82*QH8nQOn!li-v1#!s^OrO=&s*5k
zIBU^@1<i}c%x`Fd+V0ge*KYWzg8g9scam{-w-~4`15Tw$wI3vQ$8eFJBjT9Gs}tPN
z<6vHl4u98ioy@7T<}A3b@zlcy6R*UjP;GnHkndd({&>aKf^vSm<xTTi(}2QHp55Cj
zW&XtUHNVf4@yY9qgY{0+l#jgHtEDkbIB&w24aWcc<|)R1`rpE~@n5M;YpFe?-uQ#{
z#<g2Z*GsRC>ea2j#MUbx{d)d)T_(HG{Ug__RoM?+M^mqU^~L5>@4l_`YdLbgu^*~+
zXrQC{rR(|HHwW8!+PwDn?~wI8{ZRP>xH3T<)bsy1>IPe<Y2_?)@gtALH9M$x+TU<K
zH%$0L+g<&x)f)2loafA}5$8?VKIv@tBi7TN&$wRu=d;U^=O_PE=G%H#Ju}l(I~zXc
z{Mz5Yqp5dR^U3C%xzQ0n5ApokKcCe{o}Yi&9T(a8Jz8;$dHncAc~Uz3JjC_d|NI@z
z{7yPyb-b3^;}OqG`{z^d?|OA`KILb_vUYwW-xzH+Oz7*{gbwPB{Tt3_)txowr;VHJ
z{d3x%e{Qy|m)0q-?lvDWKYKpodhMUjp0?Qz=jW&A^R|KKm{;cRFh{z-#P!-gpGQ;g
zrK;=A`dd$kXtBfd64z`0yc|uv<r9{Dtn(7rYyb1m`^f7lH@z{$o|jqwImSFx-A(7$
z;rWc~wSPV{Ho3$7lb<)opM&my8EPJ1bh)0LkFlQP6XnCr(bOCEzgx}T7k}O1{pBtB
zLsH<K!wVgy_qcpF$$080GY_XX$-*SieE7iM;FXn+C@U+!vs6}IT2)ql8g|eA7=I7E
zTNKZ0Xlm@Z#Jiu-as57!ekaiHbLB~r;*PG3HC55e4|I#p9n`<=;oiH<W1rY>w&YH6
zRV)3zczAyNJL&M)L9d~4?rgr`9t`}Q(BkGL4f7WK_2TJzJ*D4W8|OAIYP|01BP{e0
zi>anRNaO*m!wu$!ULyLT+5vu`|A*5nldCGZ%95)*xhj&YOLA2wSGVNqo?JbWt7mc@
zlU%)$E0bJ(ldDg1bxp3`$#t;9w6n^}w706Nv^$RMfh+B>q9X0FOP93E>gu%5Zr##O
zyLV4}?a?Fcwr9_@-(!wRJMPsh?KzW4yYAaJ?YmE(wDYcA)82b?gI)Kd-EBID?yo)C
z2ChqRo%)J32DWkK#{MlvW9oN*&0_4M7N>lT>-dN(d)wcyjJJaGiGEIf#To<KzuJ_m
z{<<G6QT?3y32s%s;*_7@0`as@?IG>c_LkIAY~#vR&aHo{*WT*XPq5C*Vjb5pjqAAf
z5bM;`Y3&4~Q)4yberjwF%2mIv`z7So*xUqDtENtI%1<!!i+dY!<vQDg>Vv7Z&T493
z>T6uN>Ob`0W$3K4eI{5rHlFe|u6*qy*3@-A(6jAR;~LYx6Kv=8?Cv$%Cu>{Nmf*bh
ztvKZ;n7RjYb-&W}VZUn9J=MDDUMF>Z)zR}nU5hyn%J<Xtfp4+$ZExuu)E;`JH8rMO
z_1{<#e@9k7#X7Dy<tO-nK70MK&*#ei*Xh}?=QF|fd@5Fb9ZPWGp$CsY>i$>uA7j7M
zXl{zNf5mD4igjFT>6p${=aAsM`ieD{<|tSF_C80-Pd{tQPjK#?`W^QCJUQu&Hn2U1
z;5zkHUt{VgIN|t4V{xv<Z86_B2l*BsI6s=7_Nh3%4vlG#>T_1?`lz2`<ttA42|lpD
zI-ZUxPOn2_s;B<CAJrbvPqFe9r~CxBySJ&%AvF&0H1_1An^nig60G}`SFGbYb|}_Z
zd;6GhS&xHfKy|b?jj2w8?fFdm*RiyJ_Sx>^j=@#B=XM{#1@%>5W9lcEd(@J;{!dOa
z8q?ea=asKG<tO;B+TRzRpL$>&QmpkA>--MEf7SjzIVt{|AztSgtER?N{R9`vCCeW}
zepoIKYy)r8`x1EE{^`5&TVCjAuADJ4Y~(fSg?{0f3wIUXx^QGz^<qD>rhZp}xFK$c
z=hx2Im46ma1LNQV*nkau13!eHN3(!th^E<Bx}Zht?kkyb`$}W^1IZ`0vG%`$n*0cI
z&)hpT+`#MV=lg}vZK^4(2EY1zKl7`NH3i~^xFMeJ{YXvzCuqL&{?rg$02{D@Z{UaU
z^Jo^(4AG=U$RC?p_lg$q*0}B!wJU3en`ShBe&wD*@zOnopTU2oW_bAO6??4a6DJK1
ziRXzM;${o4^>Ef+wx<9N!3La%Z~K97&<xQG(ai5Jt+I7Xr6+2^wl273>itU#x3HeC
z?3fh3y>n7{GW_4&vo!y8@V;O4GxZym=7}5PhIrxi2bLDDqi)j=CxzfV*nkau13!dc
zKr@eKh^E<Fx<c1Be4qN|66s!>3VC<ji_2ch|ApLzZ;msYc%6%8#qyU5Gr>EEZ@J;6
z0`ZWzA)asMwV2+rZ;dmhB`+0jq@Uq$j|<_4@I&}{Gz(~kXmXw$TUXE02c<W4uUY#a
zj9c4hN_ZEVr!Q(Kyt$yE;KP5W56@bg8wz#A9|0536F0=edS3UyxoAm40c^kqoQI!>
zAHomOG-!rs<|`*(YwK35*?v0M)&*~OzO%gTd3yfS!s+2MUUT4Aet&u0ec+4H+_`ai
z9dSe45N~_;+soT-hclOPa2?oy4SWMXgx`i{9hxDUrklS<KRaQSRJTaf&DIqeclz5`
z&1|h>fB$*k^zfSf)5F>1p4B`v=ai<04fJ!?<e53*hPWZ#I_&tFt+%mv0eo-{Y`_M-
zfgi$eMKgzHh$d@lcv$0yACy+LRLFOA?tFe_+q$8<>bjsGy*w>^;-zWfXzKoO+^)9C
z;QiG4{fJ#{#0_ynyl&;#U3Jf)zlU*f8`yvid;>p(Ux#KJnjxCzz0z;&d48YIZ~64s
z?RhSfGitYdyKd(%Ik#_hsSm$VRUdwn+-`q#C+xuQi{?8yGl94vZiw%^sb%ucnat%_
zxZnw312*st{1E<5G$)`LqRD(uwClXTR8hOP^n1I`AC$(|p4elW=|}Eu-{_gYdt=Xh
zH|qYh$F%U55BJO$soSgPw2*j#xFK#FUggxi<B^_ua0oWw0{jB}5WYb(L^DLQP`>7V
z9;$Gk%nm-i{J8Dg?K+=PyM66|!RFWK|3_FI{<2UVzCzsx2Mi9^;Ga+Ynt_8gZipM=
z=3!pF;cR9c9D)tlz&G$i_y)}o%@9pf5&S~;l+RPpQs#`b^Ti)~><gn>N7M7GQXl@N
ztUhdo|DA_N<tCKZhi6iE(B@G&;)b{(-ny{r<klDAJP#L~0~@e`Z{UaUThYv+8KTKL
z|BLQvsJ}PBy4Uu1*7el`b9%qpjLs)3>cgevZhL+}>&?`i%3Nj)7}!eO5I4kgf8IMF
z*9*<};e%Vj25jIP_#ylpnyq@jLeuOit+Mld@3(JpfBv;%voD-dd(L~)!ztuG*Zc0)
z(f#gj{daQLyf@t}F5acstOpa%DJC91$m?}DC;a}dR<HpZa1Oq5Liiz?2F(!7T$xPP
zwGGQ;Q!Uum1-GmnxV!FQ>Smsu7W%v%Blov8yW3s?e+kX69k;uUxFK$c*FDvHcb)$3
z_$lMyHvN48Ht-Gn5Plt+ZD@vQno?<)t*dr_sboJ#rP9qU+qUJxm#JI!<E@4H&u%RY
zVx9kId(QNDW@{l}ZHN3IXNc#C8{*;SmRz_3{blgM25i82_<8st{18opW{76KRGO%B
z3`?c1wUx3k`Mq#yOXJodxfRrP*so3O=|$we`0|j}EPH(~pX+a}AJR(P5I4kgmFtG&
zj-~D(xM0o@XOD6C27U-Xhh{69A(}?~MOuq<6^-4$aj?#vv-W6h>m&OnUX13@%KGpe
zUPGz-=*ay~-$>oF(A*sDdz!c*Zir7j@#TFJ^{oDiy5Oh525jIP_#ym>Xg-Z*h^Bdq
zb9~<*J<aj+7q#7`t9>SBq(Zug;iponh-Z0fR*jb>+7;h{)eYZav=U#RYgXWAl6>_v
zUln@`4|c#k7*)ldL{zbx^u^1{G13R$f!Pn=kzPbpu^Oa`alRz^s(7pnw2J-Y6EKYQ
zm*cHsANeF+meCWeVqY1A@5lf-&MIceRK+-7sHgd=cp@zA@dWu4?*^S3{4Bad@v<^l
zK8^3dABOLsdlG&I-68myBwvzzRU9TGtzwOgfnm@cZ54;0riw%56svfWoQm(Df3j6{
zWE6fT$rt+2d{sO}I40mxat7}PzCL5l$_SZ&mxXsGzC+!K_zv~-nRiBpOD%pT$(JNw
z6~~Kyu{JVRKFhm7|1(zcR5=?jOa56_@iaLH-$BR4&oH9wOp-52zA74-48zdDRLjZ9
zdH7j6n}(mI-ud_r9bbU&NS%DnDxM)z@b!FXz9jjoI7u$VH*|6_?}pAkkDsN}OYyRD
zu3UoeFoVnR9Xh=TKSQT8@H0uiB>Ad%fm~@7&l3-Zq0?Dbaf-~r%hKs=tN1y&8sDMg
znO1SKT!o)W^7(gho3DzO$Xu&9L#}~g=wO~ztd}OdES+C#6)%+e_zpApqE(zOU%<~K
z`9jB<uZpwmb95tDNHY;b$BV7vWwI16OGitr;^ndo-=VWbR`F7~9zT=hOOmgOUyv0r
z40F1PcOwmQqg9;EKW3=nTv=rm=g7_Yjx@@btfD6?@iR%jB>AeiK)!4huaz}040FBB
zD$bKT@Un89+-?=Gkvs7n=Kd9{_(i!DKa=DOYoqz9xJ=e!4Rie}?}oYGgP&zi_u*xk
z`@Q%MbNw2=!y2r|&#+eO@H0uiB>Aei%06W_%;D=W40C$eDlV5t@UpDMH>~0c*@*A3
zCJ$M~8{|R!Op?!Y7@Mz(x5>9)7`a6r<K3_Zo2}x_@;F|WIeyzJu9olMJIr;HRrKXi
z{7jNBNxmwsv;X#DSf!_67`aQnXBBUkEqGbh<oj0f4%v$D$lda!Ra_(gh@VOFCCOLC
z4Z@c(#_pA!yc<^UhgR_(X~oOR{qnR`{HnC!JFMmotGHf%fS*b7CCL}=@a2q;WULI^
zAFG!tS0t#CyM38uRAF_b606LvHb?#L{HR7Ztd3M;mDvNUYL(pgdss#<td8`=Dzi5>
zX7t5ZjXqc%$=G+poxFd-7|7jT83XuHjs93=9*d1NKEd5w8OLLF<T$J{Pr$~E!Q9W4
zF$k+8pTsKjM1Eq%N!(SHF$Ak44px~p*qAYt`?4}Vjn$D)VU;-y8#6}AX_hept0Tj)
z${dA_8DqG!s>W!nj+~5D<|){iahl{T<5aAUWU<N|i;WqlbB|SxTC9$Y!zyz;HfBuV
z9;%Epu{v@FR+$sAF(c1iR2g+x9m!#pX|OTlvohT>K7-W}7pvoEVPnR*Qg0dOV0Gkd
ztTHEIW5(y?a?6;4)se|qWuAwP8Pm9*X&>ifbz~}5nHOMV#)aJ1lu?h>k?B}v&cMcu
zi@CEY<MUV@xd^MwORzEHa_(HpxD2Z!mtvK91vX~P<ld!>tFSt9C03cUurXtf++Z2A
zu{z>mm3cKbX3Ul4meGjSkp`?XzkrPy*T`zin1|JoFJhH>EjDIc$6ZAGn2*(wCaf|S
zU}MH2?k38(9;+h@vC3SGjTuY1pD1GqR!5q#%3Owx87sJ7C}TNRM{d9>b0s!r+{7J2
z88>2e<V#p(uENHQ)e>07%~&1rvC6y!8#BHl-?WTdu{!c)tTJ!I#*91UA1vc`td6X~
zD)UZk%vdW=SjOF09k~mu%yrn9@m1Mo8TVjyWIa}y_hMtl{nBC?U&HFieOP5~z$!!J
z{MpToi{{O48Z&2p`j6d2kM44z>r4MXLcKof|Bva6cdkI^3UsbO=L&SLK<5f{u0ZDs
zbgn?>3UsbO=L&SLK<5hl|5*VZ0r>XiTjS&Te#G^!(PPiO>pJ2&;yV&J5;;<I^x=Wy
zitCE!itkF`O5{q>6&^G>p17WPp7@>wo<yD$Jwea$#r4JW5thK0$d@9u0&xOy1Mvd!
z0|^3&0x1R}kvNgKk$92#kpz)MkrX45qBuoyi{cf<FG^69s3^svh`5fn<9b@e4K&p)
zic6P{<GPOPIj--xf#XJwTXbBwgt<J|^<6h`-N<!|2zajJY1H#v-*W@cjXbyLxlGdW
zmFoGf@4JETM!sA0U1shCn(qa!AGkr_MuA%lT$aO$RMd-HKXQY}jUu-gxvY^>bgASO
zUBBoCMK>zC#iA>^y2$ySE{`ARr2V4!teWF!ZO`$2#}6Doa{Qv>i_S(H^0XZ)Qv^Mq
z^>sY$((`=Z^8?S1Jiq86Nj5}cdIi28`F_#&*$F4`nU6;(@PojQ0>2peY>yN9OwxlF
z`9b7Ikzb5__RJ~z%-kcn=m$kVD*DBuFM2MR9=i>RJ!HGs8Qn$4(Y5d#RScXca-yQc
z=CBXCK%T2*0$m<fLigM8bk#ghYX@Ewc~Q}0F_<?~WH#DR;75^9Wjz^ApzG@e+GP+#
kQ4kdaic<$kvLO<SN_*c8f=#~fmpCjX9(bw2#*e=K58Gku`2YX_

literal 0
HcmV?d00001

diff --git a/test/unit/ImportExport/MDL/utMDLImporter_HL1_Nodes.cpp b/test/unit/ImportExport/MDL/utMDLImporter_HL1_Nodes.cpp
index 4420727e9..d2984477b 100644
--- a/test/unit/ImportExport/MDL/utMDLImporter_HL1_Nodes.cpp
+++ b/test/unit/ImportExport/MDL/utMDLImporter_HL1_Nodes.cpp
@@ -55,6 +55,12 @@ using namespace Assimp;
 
 class utMDLImporter_HL1_Nodes : public ::testing::Test {
 
+    /**
+    * @note Represents a flattened node hierarchy where each item is a pair
+    * containing the node level and it's name.
+    */
+    typedef std::vector<std::pair<unsigned int, std::string>> Hierarchy;
+
 public:
     /**
     * @note The following tests require a basic understanding
@@ -63,6 +69,49 @@ public:
     * (Valve Developer Community).
     */
 
+    // Given a model, verify that the bones nodes hierarchy is correctly formed.
+    void checkBoneHierarchy() {
+        Assimp::Importer importer;
+        const aiScene *scene = importer.ReadFile(ASSIMP_TEST_MDL_HL1_MODELS_DIR "multiple_roots.mdl", aiProcess_ValidateDataStructure);
+        ASSERT_NE(nullptr, scene);
+        ASSERT_NE(nullptr, scene->mRootNode);
+
+        const aiNode* node_MDL_root = scene->mRootNode->FindNode(AI_MDL_HL1_NODE_ROOT);
+        ASSERT_NE(nullptr, node_MDL_root);
+
+        const aiNode *node_MDL_bones = scene->mRootNode->FindNode(AI_MDL_HL1_NODE_BONES);
+        ASSERT_NE(nullptr, node_MDL_bones);
+        ASSERT_NE(nullptr, node_MDL_bones->mParent);
+        ASSERT_EQ(node_MDL_root, node_MDL_bones->mParent);
+
+        const Hierarchy expected_hierarchy = {
+            { 0, AI_MDL_HL1_NODE_BONES },
+                { 1, "root1_bone1" },
+                    { 2, "root1_bone2" },
+                        { 3, "root1_bone4" },
+                        { 3, "root1_bone5" },
+                    { 2, "root1_bone3" },
+                        { 3, "root1_bone6" },
+                { 1, "root2_bone1" },
+                    { 2, "root2_bone2" },
+                    { 2, "root2_bone3" },
+                        { 3, "root2_bone5" },
+                    { 2, "root2_bone4" },
+                        { 3, "root2_bone6" },
+                { 1, "root3_bone1" },
+                    { 2, "root3_bone2" },
+                    { 2, "root3_bone3" },
+                    { 2, "root3_bone4" },
+                        { 3, "root3_bone5" },
+                            { 4, "root3_bone6" },
+                            { 4, "root3_bone7" },
+        };
+
+        Hierarchy actual_hierarchy;
+        flatten_hierarchy(node_MDL_bones, actual_hierarchy);
+        ASSERT_EQ(expected_hierarchy, actual_hierarchy);
+    }
+
     /*  Given a model with bones that have empty names,
         verify that all the bones of the imported model
         have unique and no empty names.
@@ -416,8 +465,26 @@ private:
                 EXPECT_NEAR(expected[i][j], actual[i][j], abs_error);
         }
     }
+
+    void flatten_hierarchy(const aiNode *node, Hierarchy &hierarchy)
+    {
+        flatten_hierarchy(node, hierarchy, 0);
+    }
+
+    void flatten_hierarchy(const aiNode *node, Hierarchy &hierarchy, unsigned int level)
+    {
+        hierarchy.push_back({ level, node->mName.C_Str() });
+        for (size_t i = 0; i < node->mNumChildren; ++i)
+        {
+            flatten_hierarchy(node->mChildren[i], hierarchy, level + 1);
+        }
+    }
 };
 
+TEST_F(utMDLImporter_HL1_Nodes, checkBoneHierarchy) {
+    checkBoneHierarchy();
+}
+
 TEST_F(utMDLImporter_HL1_Nodes, emptyBonesNames) {
     emptyBonesNames();
 }