ToxicMushroom/Penumbra
1
0
Fork 0
mirror of https://github.com/xivdev/Penumbra.git synced 2026-02-21 23:37:47 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge remote-tracking branch 'ackwell/mdl-io-triage-6'

Browse source
This commit is contained in:
Ottermandias 2024-05-04 11:19:17 +02:00
commit d72008b4b9
9 changed files with 154 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Penumbra/UI/AdvancedWindow/FileEditor.cs
View file

@ -204,8 +204,9 @@ public class FileEditor<T>(
private void SaveButton()
{
var canSave = _changed && _currentFile != null && _currentFile.Valid;
if (ImGuiUtil.DrawDisabledButton("Save to File", Vector2.Zero,
$"Save the selected {fileType} file with all changes applied. This is not revertible.", !_changed))
$"Save the selected {fileType} file with all changes applied. This is not revertible.", !canSave))
{
compactor.WriteAllBytes(_currentPath!.File.FullName, _currentFile!.Write());
if (owner.Mod != null)

16
Penumbra/UI/AdvancedWindow/ModEditWindow.Models.MdlTab.cs
View file

@ -49,7 +49,7 @@ public partial class ModEditWindow
/// <inheritdoc/>
public bool Valid
=> Mdl.Valid;
=> Mdl.Valid && Mdl.Materials.All(ValidateMaterial);
/// <inheritdoc/>
public byte[] Write()
@ -285,6 +285,20 @@ public partial class ModEditWindow
: _edit._gameData.GetFile(resolvedPath.InternalName.ToString())?.Data;
}
/// <summary> Validate the specified material. </summary>
/// <remarks>
/// While materials can be relative (`/mt_...`) or absolute (`bg/...`),
/// they invariably must contain at least one directory seperator.
/// Missing this can lead to a crash.
///
/// They must also be at least one character (though this is enforced
/// by containing a `/`), and end with `.mtrl`.
/// </remarks>
public bool ValidateMaterial(string material)
{
return material.Contains('/') && material.EndsWith(".mtrl");
}
/// <summary> Remove the material given by the index. </summary>
/// <remarks> Meshes using the removed material are redirected to material 0, and those after the index are corrected. </remarks>
public void RemoveMaterial(int materialIndex)

127
Penumbra/UI/AdvancedWindow/ModEditWindow.Models.cs
View file

@ -1,5 +1,7 @@
using Dalamud.Interface;
using Dalamud.Interface.Components;
using ImGuiNET;
using Lumina.Data.Parsing;
using OtterGui;
using OtterGui.Custom;
using OtterGui.Raii;
@ -7,7 +9,6 @@ using OtterGui.Widgets;
using Penumbra.GameData;
using Penumbra.GameData.Files;
using Penumbra.Import.Models;
using Penumbra.Mods;
using Penumbra.String.Classes;
using Penumbra.UI.Classes;
@ -145,8 +146,8 @@ public partial class ModEditWindow
if (ImGuiUtil.DrawDisabledButton("Export to glTF", Vector2.Zero, "Exports this mdl file to glTF, for use in 3D authoring applications.",
tab.PendingIo || gamePath.IsEmpty))
_fileDialog.OpenSavePicker("Save model as glTF.", ".gltf", Path.GetFileNameWithoutExtension(gamePath.Filename().ToString()),
".gltf", (valid, path) =>
_fileDialog.OpenSavePicker("Save model as glTF.", ".glb", Path.GetFileNameWithoutExtension(gamePath.Filename().ToString()),
".glb", (valid, path) =>
{
if (!valid)
return;
@ -292,10 +293,24 @@ public partial class ModEditWindow
private bool DrawModelMaterialDetails(MdlTab tab, bool disabled)
{
if (!ImGui.CollapsingHeader("Materials"))
var invalidMaterialCount = tab.Mdl.Materials.Count(material => !tab.ValidateMaterial(material));
var oldPos = ImGui.GetCursorPosY();
var header = ImGui.CollapsingHeader("Materials");
var newPos = ImGui.GetCursorPos();
if (invalidMaterialCount > 0)
{
var text = $"{invalidMaterialCount} invalid material{(invalidMaterialCount > 1 ? "s" : "")}";
var size = ImGui.CalcTextSize(text).X;
ImGui.SetCursorPos(new Vector2(ImGui.GetContentRegionAvail().X - size, oldPos + ImGui.GetStyle().FramePadding.Y));
ImGuiUtil.TextColored(0xFF0000FF, text);
ImGui.SetCursorPos(newPos);
}
if (!header)
return false;
using var table = ImRaii.Table(string.Empty, disabled ? 2 : 3, ImGuiTableFlags.SizingFixedFit);
using var table = ImRaii.Table(string.Empty, disabled ? 2 : 4, ImGuiTableFlags.SizingFixedFit);
if (!table)
return false;
@ -305,7 +320,10 @@ public partial class ModEditWindow
ImGui.TableSetupColumn("index", ImGuiTableColumnFlags.WidthFixed, 80 * UiHelpers.Scale);
ImGui.TableSetupColumn("path", ImGuiTableColumnFlags.WidthStretch, 1);
if (!disabled)
{
ImGui.TableSetupColumn("actions", ImGuiTableColumnFlags.WidthFixed, UiHelpers.IconButtonSize.X);
ImGui.TableSetupColumn("help", ImGuiTableColumnFlags.WidthFixed, UiHelpers.IconButtonSize.X);
}
var inputFlags = disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None;
for (var materialIndex = 0; materialIndex < materials.Length; materialIndex++)
@ -319,14 +337,19 @@ public partial class ModEditWindow
ImGui.TableNextColumn();
ImGui.SetNextItemWidth(-1);
ImGui.InputTextWithHint("##newMaterial", "Add new material...", ref _modelNewMaterial, Utf8GamePath.MaxGamePathLength, inputFlags);
var validName = _modelNewMaterial.Length > 0 && _modelNewMaterial[0] == '/';
var validName = tab.ValidateMaterial(_modelNewMaterial);
ImGui.TableNextColumn();
if (!ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), UiHelpers.IconButtonSize, string.Empty, !validName, true))
return ret;
if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), UiHelpers.IconButtonSize, string.Empty, !validName, true))
{
ret |= true;
tab.Mdl.Materials = materials.AddItem(_modelNewMaterial);
_modelNewMaterial = string.Empty;
}
ImGui.TableNextColumn();
if (!validName && _modelNewMaterial.Length > 0)
DrawInvalidMaterialMarker();
tab.Mdl.Materials = materials.AddItem(_modelNewMaterial);
_modelNewMaterial = string.Empty;
return true;
return ret;
}
private bool DrawMaterialRow(MdlTab tab, bool disabled, string[] materials, int materialIndex, ImGuiInputTextFlags inputFlags)
@ -353,20 +376,38 @@ public partial class ModEditWindow
return ret;
ImGui.TableNextColumn();
// Need to have at least one material.
if (materials.Length <= 1)
return ret;
if (materials.Length > 1)
{
var tt = "Delete this material.\nAny meshes targeting this material will be updated to use material #1.";
var modifierActive = _config.DeleteModModifier.IsActive();
if (!modifierActive)
tt += $"\nHold {_config.DeleteModModifier} to delete.";
var tt = "Delete this material.\nAny meshes targeting this material will be updated to use material #1.";
var modifierActive = _config.DeleteModModifier.IsActive();
if (!modifierActive)
tt += $"\nHold {_config.DeleteModModifier} to delete.";
if (!ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Trash.ToIconString(), UiHelpers.IconButtonSize, tt, !modifierActive, true))
return ret;
if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Trash.ToIconString(), UiHelpers.IconButtonSize, tt, !modifierActive, true))
{
tab.RemoveMaterial(materialIndex);
ret |= true;
}
}
tab.RemoveMaterial(materialIndex);
return true;
ImGui.TableNextColumn();
// Add markers to invalid materials.
if (!tab.ValidateMaterial(temp))
DrawInvalidMaterialMarker();
return ret;
}
private void DrawInvalidMaterialMarker()
{
using var colorHandle = ImRaii.PushColor(ImGuiCol.TextDisabled, 0xFF0000FF, true);
ImGuiComponents.HelpMarker(
"Materials must be either relative (e.g. \"/filename.mtrl\")\n"
+ "or absolute (e.g. \"bg/full/path/to/filename.mtrl\"),\n"
+ "and must end in \".mtrl\".",
FontAwesomeIcon.TimesCircle);
}
private bool DrawModelLodDetails(MdlTab tab, int lodIndex, bool disabled)
@ -401,6 +442,14 @@ public partial class ModEditWindow
var file = tab.Mdl;
var mesh = file.Meshes[meshIndex];
// Vertex elements
ImGui.TableNextColumn();
ImGui.AlignTextToFramePadding();
ImGui.TextUnformatted("Vertex Elements");
ImGui.TableNextColumn();
DrawVertexElementDetails(file.VertexDeclarations[meshIndex].VertexElements);
// Mesh material
ImGui.TableNextColumn();
ImGui.AlignTextToFramePadding();
@ -416,6 +465,40 @@ public partial class ModEditWindow
return ret;
}
private static void DrawVertexElementDetails(MdlStructs.VertexElement[] vertexElements)
{
using var node = ImRaii.TreeNode($"Click to expand");
if (!node)
return;
var flags = ImGuiTableFlags.SizingFixedFit
| ImGuiTableFlags.RowBg
| ImGuiTableFlags.Borders
| ImGuiTableFlags.NoHostExtendX;
using var table = ImRaii.Table(string.Empty, 4, flags);
if (!table)
return;
ImGui.TableSetupColumn("Usage");
ImGui.TableSetupColumn("Type");
ImGui.TableSetupColumn("Stream");
ImGui.TableSetupColumn("Offset");
ImGui.TableHeadersRow();
foreach (var element in vertexElements)
{
ImGui.TableNextColumn();
ImGui.TextUnformatted($"{(MdlFile.VertexUsage)element.Usage}");
ImGui.TableNextColumn();
ImGui.TextUnformatted($"{(MdlFile.VertexType)element.Type}");
ImGui.TableNextColumn();
ImGui.TextUnformatted($"{element.Stream}");
ImGui.TableNextColumn();
ImGui.TextUnformatted($"{element.Offset}");
}
}
private static bool DrawMaterialCombo(MdlTab tab, int meshIndex, bool disabled)
{
var mesh = tab.Mdl.Meshes[meshIndex];