zone/OpenAssetTools
2
0
Fork 0
mirror of https://github.com/Laupetin/OpenAssetTools.git synced 2026-05-13 05:41:43 +00:00
Code Activity

chore: use references when possible in xmodel dumper

Browse Source
This commit is contained in:
Jan Laupetin
2026-05-03 12:54:45 +02:00
parent d6a736eb5d
commit 2527f23c10
1 changed files with 90 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ObjWriting/XModel/XModelDumper.cpp.template
+90 -90
View File
@@ -236,18 +236,18 @@ namespace
} }
} }
void AddXModelBones(XModelCommon& out, const AssetDumpingContext& context, const XModel* model) void AddXModelBones(XModelCommon& out, const AssetDumpingContext& context, const XModel& model)
{ {
for (auto boneNum = 0u; boneNum < model->numBones; boneNum++) for (auto boneNum = 0u; boneNum < model.numBones; boneNum++)
{ {
XModelBone bone; XModelBone bone;
if (model->boneNames[boneNum] < context.m_zone.m_script_strings.Count()) if (model.boneNames[boneNum] < context.m_zone.m_script_strings.Count())
bone.name = context.m_zone.m_script_strings[model->boneNames[boneNum]]; bone.name = context.m_zone.m_script_strings[model.boneNames[boneNum]];
else else
bone.name = "INVALID_BONE_NAME"; bone.name = "INVALID_BONE_NAME";
if (boneNum >= model->numRootBones) if (boneNum >= model.numRootBones)
bone.parentIndex = static_cast<int>(boneNum - static_cast<unsigned int>(model->parentList[boneNum - model->numRootBones])); bone.parentIndex = static_cast<int>(boneNum - static_cast<unsigned int>(model.parentList[boneNum - model.numRootBones]));
else else
bone.parentIndex = std::nullopt; bone.parentIndex = std::nullopt;
@@ -255,7 +255,7 @@ namespace
bone.scale[1] = 1.0f; bone.scale[1] = 1.0f;
bone.scale[2] = 1.0f; bone.scale[2] = 1.0f;
const auto& baseMat = model->baseMat[boneNum]; const auto& baseMat = model.baseMat[boneNum];
bone.globalOffset[0] = baseMat.trans.x; bone.globalOffset[0] = baseMat.trans.x;
bone.globalOffset[1] = baseMat.trans.y; bone.globalOffset[1] = baseMat.trans.y;
bone.globalOffset[2] = baseMat.trans.z; bone.globalOffset[2] = baseMat.trans.z;
@@ -266,7 +266,7 @@ namespace
.w = baseMat.quat.w, .w = baseMat.quat.w,
}; };
if (boneNum < model->numRootBones) if (boneNum < model.numRootBones)
{ {
bone.localOffset[0] = 0; bone.localOffset[0] = 0;
bone.localOffset[1] = 0; bone.localOffset[1] = 0;
@@ -275,12 +275,12 @@ namespace
} }
else else
{ {
const auto* trans = &model->trans[(boneNum - model->numRootBones) * 3]; const auto* trans = &model.trans[(boneNum - model.numRootBones) * 3];
bone.localOffset[0] = trans[0]; bone.localOffset[0] = trans[0];
bone.localOffset[1] = trans[1]; bone.localOffset[1] = trans[1];
bone.localOffset[2] = trans[2]; bone.localOffset[2] = trans[2];
const auto& quat = model->quats[boneNum - model->numRootBones]; const auto& quat = model.quats[boneNum - model.numRootBones];
bone.localRotation = { bone.localRotation = {
.x = QuatInt16::ToFloat(quat.v[0]), .x = QuatInt16::ToFloat(quat.v[0]),
.y = QuatInt16::ToFloat(quat.v[1]), .y = QuatInt16::ToFloat(quat.v[1]),
@@ -301,11 +301,11 @@ namespace
return input; return input;
} }
void AddXModelMaterials(XModelCommon& out, DistinctMapper<Material*>& materialMapper, const XModel* model) void AddXModelMaterials(XModelCommon& out, DistinctMapper<Material*>& materialMapper, const XModel& model)
{ {
for (auto surfaceMaterialNum = 0u; surfaceMaterialNum < model->numsurfs; surfaceMaterialNum++) for (auto surfaceMaterialNum = 0u; surfaceMaterialNum < model.numsurfs; surfaceMaterialNum++)
{ {
Material* material = model->materialHandles[surfaceMaterialNum]; Material* material = model.materialHandles[surfaceMaterialNum];
if (materialMapper.Add(material)) if (materialMapper.Add(material))
{ {
XModelMaterial xMaterial; XModelMaterial xMaterial;
@@ -329,10 +329,10 @@ namespace
} }
} }
void AddXModelObjects(XModelCommon& out, const XModel* model, const unsigned lod, const DistinctMapper<Material*>& materialMapper) void AddXModelObjects(XModelCommon& out, const XModel& model, const unsigned lod, const DistinctMapper<Material*>& materialMapper)
{ {
const auto surfCount = model->lodInfo[lod].numsurfs; const auto surfCount = model.lodInfo[lod].numsurfs;
const auto baseSurfaceIndex = model->lodInfo[lod].surfIndex; const auto baseSurfaceIndex = model.lodInfo[lod].surfIndex;
for (auto surfIndex = 0u; surfIndex < surfCount; surfIndex++) for (auto surfIndex = 0u; surfIndex < surfCount; surfIndex++)
{ {
@@ -344,11 +344,11 @@ namespace
} }
} }
void AddXModelVertices(XModelCommon& out, const XModel* model, const unsigned lod) void AddXModelVertices(XModelCommon& out, const XModel& model, const unsigned lod)
{ {
XSurface* surfs; XSurface* surfs;
unsigned surfCount; unsigned surfCount;
if (!GetSurfaces(*model, lod, surfs, surfCount)) if (!GetSurfaces(model, lod, surfs, surfCount))
return; return;
for (auto surfIndex = 0u; surfIndex < surfCount; surfIndex++) for (auto surfIndex = 0u; surfIndex < surfCount; surfIndex++)
@@ -372,11 +372,11 @@ namespace
} }
} }
void AllocateXModelBoneWeights(const XModel* model, const unsigned lod, XModelVertexBoneWeightCollection& weightCollection) void AllocateXModelBoneWeights(const XModel& model, const unsigned lod, XModelVertexBoneWeightCollection& weightCollection)
{ {
XSurface* surfs; XSurface* surfs;
unsigned surfCount; unsigned surfCount;
if (!GetSurfaces(*model, lod, surfs, surfCount)) if (!GetSurfaces(model, lod, surfs, surfCount))
return; return;
auto totalWeightCount = 0u; auto totalWeightCount = 0u;
@@ -406,11 +406,11 @@ namespace
return static_cast<float>(value) / static_cast<float>(std::numeric_limits<uint16_t>::max()); return static_cast<float>(value) / static_cast<float>(std::numeric_limits<uint16_t>::max());
} }
void AddXModelVertexBoneWeights(XModelCommon& out, const XModel* model, const unsigned lod) void AddXModelVertexBoneWeights(XModelCommon& out, const XModel& model, const unsigned lod)
{ {
XSurface* surfs; XSurface* surfs;
unsigned surfCount; unsigned surfCount;
if (!GetSurfaces(*model, lod, surfs, surfCount)) if (!GetSurfaces(model, lod, surfs, surfCount))
return; return;
auto& weightCollection = out.m_bone_weight_data; auto& weightCollection = out.m_bone_weight_data;
@@ -525,11 +525,11 @@ namespace
} }
} }
void AddXModelFaces(XModelCommon& out, const XModel* model, const unsigned lod) void AddXModelFaces(XModelCommon& out, const XModel& model, const unsigned lod)
{ {
XSurface* surfs; XSurface* surfs;
unsigned surfCount; unsigned surfCount;
if (!GetSurfaces(*model, lod, surfs, surfCount)) if (!GetSurfaces(model, lod, surfs, surfCount))
return; return;
for (auto surfIndex = 0u; surfIndex < surfCount; surfIndex++) for (auto surfIndex = 0u; surfIndex < surfCount; surfIndex++)
@@ -557,12 +557,12 @@ namespace
&& ObjWriting::Configuration.ModelOutputFormat != ObjWriting::Configuration_t::ModelOutputFormat_e::XMODEL_BIN; && ObjWriting::Configuration.ModelOutputFormat != ObjWriting::Configuration_t::ModelOutputFormat_e::XMODEL_BIN;
} }
void PopulateXModelWriter(XModelCommon& out, const AssetDumpingContext& context, const unsigned lod, const XModel* model) void PopulateXModelWriter(XModelCommon& out, const AssetDumpingContext& context, const unsigned lod, const XModel& model)
{ {
DistinctMapper<Material*> materialMapper(model->numsurfs); DistinctMapper<Material*> materialMapper(model.numsurfs);
AllocateXModelBoneWeights(model, lod, out.m_bone_weight_data); AllocateXModelBoneWeights(model, lod, out.m_bone_weight_data);
out.m_name = std::format("{}_lod{}", model->name, lod); out.m_name = std::format("{}_lod{}", model.name, lod);
AddXModelMaterials(out, materialMapper, model); AddXModelMaterials(out, materialMapper, model);
AddXModelObjects(out, model, lod, materialMapper); AddXModelObjects(out, model, lod, materialMapper);
AddXModelVertices(out, model, lod); AddXModelVertices(out, model, lod);
@@ -570,7 +570,7 @@ namespace
// Keep armature handling consistent across all LODs so dumped GLTF/GLB round-trips // Keep armature handling consistent across all LODs so dumped GLTF/GLB round-trips
// preserve the same bone layout when re-imported. // preserve the same bone layout when re-imported.
if (!CanOmitDefaultArmature() || !HasDefaultArmatureForAllLods(*model)) if (!CanOmitDefaultArmature() || !HasDefaultArmatureForAllLods(model))
{ {
AddXModelBones(out, context, model); AddXModelBones(out, context, model);
AddXModelVertexBoneWeights(out, model, lod); AddXModelVertexBoneWeights(out, model, lod);
@@ -583,39 +583,39 @@ namespace
void DumpObjMtl(const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset) void DumpObjMtl(const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset)
{ {
const auto* model = asset.Asset(); const auto& model = *asset.Asset();
const auto mtlFile = context.OpenAssetFile(std::format("model_export/{}.mtl", model->name)); const auto mtlFile = context.OpenAssetFile(std::format("model_export/{}.mtl", model.name));
if (!mtlFile) if (!mtlFile)
return; return;
const auto* game = IGame::GetGameById(context.m_zone.m_game_id); const auto* game = IGame::GetGameById(context.m_zone.m_game_id);
const auto writer = obj::CreateMtlWriter(*mtlFile, game->GetShortName(), context.m_zone.m_name); const auto writer = obj::CreateMtlWriter(*mtlFile, game->GetShortName(), context.m_zone.m_name);
DistinctMapper<Material*> materialMapper(model->numsurfs); DistinctMapper<Material*> materialMapper(model.numsurfs);
writer->Write(common); writer->Write(common);
} }
void DumpObjLod(const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset, const unsigned lod) void DumpObjLod(const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset, const unsigned lod)
{ {
const auto* model = asset.Asset(); const auto& model = *asset.Asset();
const auto assetFile = context.OpenAssetFile(GetFileNameForLod(model->name, lod, ".obj")); const auto assetFile = context.OpenAssetFile(GetFileNameForLod(model.name, lod, ".obj"));
if (!assetFile) if (!assetFile)
return; return;
const auto* game = IGame::GetGameById(context.m_zone.m_game_id); const auto* game = IGame::GetGameById(context.m_zone.m_game_id);
const auto writer = const auto writer =
obj::CreateObjWriter(*assetFile, std::format("{}.mtl", model->name), game->GetShortName(), context.m_zone.m_name); obj::CreateObjWriter(*assetFile, std::format("{}.mtl", model.name), game->GetShortName(), context.m_zone.m_name);
DistinctMapper<Material*> materialMapper(model->numsurfs); DistinctMapper<Material*> materialMapper(model.numsurfs);
writer->Write(common); writer->Write(common);
} }
void DumpXModelExportLod(const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset, const unsigned lod) void DumpXModelExportLod(const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset, const unsigned lod)
{ {
const auto* model = asset.Asset(); const auto model = *asset.Asset();
const auto assetFile = context.OpenAssetFile(GetFileNameForLod(model->name, lod, ".xmodel_export")); const auto assetFile = context.OpenAssetFile(GetFileNameForLod(model.name, lod, ".xmodel_export"));
if (!assetFile) if (!assetFile)
return; return;
@@ -627,8 +627,8 @@ namespace
void DumpXModelBinLod(const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset, const unsigned lod) void DumpXModelBinLod(const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset, const unsigned lod)
{ {
const auto* model = asset.Asset(); const auto& model = *asset.Asset();
const auto assetFile = context.OpenAssetFile(GetFileNameForLod(model->name, lod, ".xmodel_bin")); const auto assetFile = context.OpenAssetFile(GetFileNameForLod(model.name, lod, ".xmodel_bin"));
if (!assetFile) if (!assetFile)
return; return;
@@ -642,8 +642,8 @@ namespace
void DumpGltfLod( void DumpGltfLod(
const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset, const unsigned lod, const std::string& extension) const XModelCommon& common, const AssetDumpingContext& context, const XAssetInfo<XModel>& asset, const unsigned lod, const std::string& extension)
{ {
const auto* model = asset.Asset(); const auto& model = *asset.Asset();
const auto assetFile = context.OpenAssetFile(GetFileNameForLod(model->name, lod, extension)); const auto assetFile = context.OpenAssetFile(GetFileNameForLod(model.name, lod, extension));
if (!assetFile) if (!assetFile)
return; return;
@@ -657,12 +657,12 @@ namespace
void DumpXModelSurfs(const AssetDumpingContext& context, const XAssetInfo<XModel>& asset) void DumpXModelSurfs(const AssetDumpingContext& context, const XAssetInfo<XModel>& asset)
{ {
const auto* model = asset.Asset(); const auto& model = *asset.Asset();
for (auto currentLod = 0u; currentLod < model->numLods; currentLod++) for (auto currentLod = 0u; currentLod < model.numLods; currentLod++)
{ {
XModelCommon common; XModelCommon common;
PopulateXModelWriter(common, context, currentLod, asset.Asset()); PopulateXModelWriter(common, context, currentLod, model);
switch (ObjWriting::Configuration.ModelOutputFormat) switch (ObjWriting::Configuration.ModelOutputFormat)
{ {
@@ -703,10 +703,10 @@ namespace
{ {
} }
void Dump(AssetDumpingContext& context, const XModel* xmodel) const void Dump(AssetDumpingContext& context, const XModel& model) const
{ {
JsonXModel jsonXModel; JsonXModel jsonXModel;
CreateJsonXModel(context, jsonXModel, *xmodel); CreateJsonXModel(context, jsonXModel, model);
nlohmann::json jRoot = jsonXModel; nlohmann::json jRoot = jsonXModel;
jRoot["$schema"] = "http://openassettools.dev/schema/xmodel.v1.json"; jRoot["$schema"] = "http://openassettools.dev/schema/xmodel.v1.json";
@@ -746,26 +746,26 @@ namespace
} }
} }
static bool IsAnimated(const XModel& xmodel) static bool IsAnimated(const XModel& model)
{ {
#if defined(FEATURE_IW4) || defined(FEATURE_IW5) #if defined(FEATURE_IW4) || defined(FEATURE_IW5)
for (auto i = 0u; i < xmodel.numLods; i++) for (auto i = 0u; i < model.numLods; i++)
{ {
const auto& lod = xmodel.lodInfo[i]; const auto& lod = model.lodInfo[i];
if (lod.modelSurfs == nullptr || lod.modelSurfs->surfs == nullptr) if (lod.modelSurfs == nullptr || lod.modelSurfs->surfs == nullptr)
continue; continue;
for (auto j = 0u; j < lod.modelSurfs->numsurfs; j++) for (auto j = 0u; j < lod.modelSurfs->numsurfs; j++)
{ {
const auto& surf = xmodel.lodInfo[i].modelSurfs->surfs[j]; const auto& surf = model.lodInfo[i].modelSurfs->surfs[j];
if (surf.vertInfo.vertsBlend) if (surf.vertInfo.vertsBlend)
return true; return true;
} }
} }
#else #else
for (auto i = 0u; i < xmodel.numsurfs; i++) for (auto i = 0u; i < model.numsurfs; i++)
{ {
const auto& surf = xmodel.surfs[i]; const auto& surf = model.surfs[i];
if (surf.vertInfo.vertsBlend) if (surf.vertInfo.vertsBlend)
return true; return true;
} }
@@ -774,29 +774,29 @@ namespace
return false; return false;
} }
static bool HasNulledTrans(const XModel& xmodel) static bool HasNulledTrans(const XModel& model)
{ {
if (xmodel.trans == nullptr) if (model.trans == nullptr)
return true; return true;
const auto transCount = (xmodel.numBones - xmodel.numRootBones) * 3u; const auto transCount = (model.numBones - model.numRootBones) * 3u;
for (auto i = 0u; i < transCount; i++) for (auto i = 0u; i < transCount; i++)
{ {
if (xmodel.trans[i] != 0) if (model.trans[i] != 0)
return false; return false;
} }
return true; return true;
} }
static bool HasNonNullBoneInfoTrans(const XModel& xmodel) static bool HasNonNullBoneInfoTrans(const XModel& model)
{ {
if (xmodel.boneInfo == nullptr) if (model.boneInfo == nullptr)
return false; return false;
for (auto i = 0u; i < xmodel.numBones; i++) for (auto i = 0u; i < model.numBones; i++)
{ {
const auto& boneInfo = xmodel.boneInfo[i]; const auto& boneInfo = model.boneInfo[i];
#if defined(FEATURE_IW4) || defined(FEATURE_IW5) #if defined(FEATURE_IW4) || defined(FEATURE_IW5)
if (boneInfo.bounds.midPoint.x != 0 || boneInfo.bounds.midPoint.y != 0 || boneInfo.bounds.midPoint.z != 0) if (boneInfo.bounds.midPoint.x != 0 || boneInfo.bounds.midPoint.y != 0 || boneInfo.bounds.midPoint.z != 0)
return true; return true;
@@ -809,73 +809,73 @@ namespace
return false; return false;
} }
static JsonXModelType GetType(const XModel& xmodel) static JsonXModelType GetType(const XModel& model)
{ {
if (!IsAnimated(xmodel)) if (!IsAnimated(model))
return JsonXModelType::RIGID; return JsonXModelType::RIGID;
if (HasNulledTrans(xmodel) && HasNonNullBoneInfoTrans(xmodel)) if (HasNulledTrans(model) && HasNonNullBoneInfoTrans(model))
return JsonXModelType::VIEWHANDS; return JsonXModelType::VIEWHANDS;
return JsonXModelType::ANIMATED; return JsonXModelType::ANIMATED;
} }
static void SetJsonRootBoneName(AssetDumpingContext& context, JsonXModel& jXModel, const XModel& xmodel) static void SetJsonRootBoneName(AssetDumpingContext& context, JsonXModel& jXModel, const XModel& model)
{ {
assert(xmodel.boneNames); assert(model.boneNames);
assert(xmodel.boneNames[0] < context.m_zone.m_script_strings.Count()); assert(model.boneNames[0] < context.m_zone.m_script_strings.Count());
assert(xmodel.numRootBones <= 1); assert(model.numRootBones <= 1);
if (!xmodel.boneNames || xmodel.boneNames[0] >= context.m_zone.m_script_strings.Count() || xmodel.numRootBones == 0) if (!model.boneNames || model.boneNames[0] >= context.m_zone.m_script_strings.Count() || model.numRootBones == 0)
return; return;
jXModel.rootBoneName = context.m_zone.m_script_strings[xmodel.boneNames[0]]; jXModel.rootBoneName = context.m_zone.m_script_strings[model.boneNames[0]];
} }
static void CreateJsonXModel(AssetDumpingContext& context, JsonXModel& jXModel, const XModel& xmodel) static void CreateJsonXModel(AssetDumpingContext& context, JsonXModel& jXModel, const XModel& model)
{ {
if (xmodel.collLod >= 0) if (model.collLod >= 0)
jXModel.collLod = xmodel.collLod; jXModel.collLod = model.collLod;
jXModel.type = GetType(xmodel); jXModel.type = GetType(model);
if (CanOmitDefaultArmature() && HasDefaultArmatureForAllLods(xmodel)) if (CanOmitDefaultArmature() && HasDefaultArmatureForAllLods(model))
{ {
// If we are going to omit the armature, we need to make sure we remember the root bone name. // If we are going to omit the armature, we need to make sure we remember the root bone name.
// It does not follow a specific pattern, may not be identical to the xmodel name and // It does not follow a specific pattern, may not be identical to the xmodel name and
// may be required for attaching the xmodel. // may be required for attaching the xmodel.
SetJsonRootBoneName(context, jXModel, xmodel); SetJsonRootBoneName(context, jXModel, model);
} }
for (auto lodNumber = 0u; lodNumber < xmodel.numLods; lodNumber++) for (auto lodNumber = 0u; lodNumber < model.numLods; lodNumber++)
{ {
JsonXModelLod lod; JsonXModelLod lod;
lod.file = std::format("model_export/{}_lod{}{}", xmodel.name, lodNumber, GetExtensionForModelByConfig()); lod.file = std::format("model_export/{}_lod{}{}", model.name, lodNumber, GetExtensionForModelByConfig());
lod.distance = xmodel.lodInfo[lodNumber].dist; lod.distance = model.lodInfo[lodNumber].dist;
jXModel.lods.emplace_back(std::move(lod)); jXModel.lods.emplace_back(std::move(lod));
} }
if (xmodel.physPreset && xmodel.physPreset->name) if (model.physPreset && model.physPreset->name)
jXModel.physPreset = AssetName(xmodel.physPreset->name); jXModel.physPreset = AssetName(model.physPreset->name);
#if defined(FEATURE_IW4) || defined(FEATURE_IW5) #if defined(FEATURE_IW4) || defined(FEATURE_IW5)
if (xmodel.physCollmap && xmodel.physCollmap->name) if (model.physCollmap && model.physCollmap->name)
jXModel.physCollmap = AssetName(xmodel.physCollmap->name); jXModel.physCollmap = AssetName(model.physCollmap->name);
#endif #endif
#if defined(FEATURE_T5) || defined(FEATURE_T6) #if defined(FEATURE_T5) || defined(FEATURE_T6)
if (xmodel.physConstraints && xmodel.physConstraints->name) if (model.physConstraints && model.physConstraints->name)
jXModel.physConstraints = AssetName(xmodel.physConstraints->name); jXModel.physConstraints = AssetName(model.physConstraints->name);
#endif #endif
jXModel.flags = xmodel.flags; jXModel.flags = model.flags;
#ifdef FEATURE_T6 #ifdef FEATURE_T6
jXModel.lightingOriginOffset.x = xmodel.lightingOriginOffset.x; jXModel.lightingOriginOffset.x = model.lightingOriginOffset.x;
jXModel.lightingOriginOffset.y = xmodel.lightingOriginOffset.y; jXModel.lightingOriginOffset.y = model.lightingOriginOffset.y;
jXModel.lightingOriginOffset.z = xmodel.lightingOriginOffset.z; jXModel.lightingOriginOffset.z = model.lightingOriginOffset.z;
jXModel.lightingOriginRange = xmodel.lightingOriginRange; jXModel.lightingOriginRange = model.lightingOriginRange;
#endif #endif
} }
@@ -889,7 +889,7 @@ namespace
return; return;
const JsonDumper dumper(*assetFile); const JsonDumper dumper(*assetFile);
dumper.Dump(context, asset.Asset()); dumper.Dump(context, *asset.Asset());
} }
} // namespace } // namespace