Merge pull request #108 from Ashadow700/implement-scenes

BrioScenes V1
Etheirys · Jan 10, 2025 · 8cb515d · 8cb515d
2 parents 3df5b0b + ab0ebb3
commit 8cb515d
Show file tree

Hide file tree

Showing 32 changed files with 693 additions and 48 deletions.
diff --git a/Brio/Brio.cs b/Brio/Brio.cs
@@ -24,6 +24,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using System;
 using System.Diagnostics;
+using Brio.Game.Scene;
 
 namespace Brio;
 
@@ -113,6 +114,7 @@ private static ServiceCollection SetupServices(DalamudServices dalamudServices)
         serviceCollection.AddSingleton<GameDataProvider>();
         serviceCollection.AddSingleton<WelcomeService>();
         serviceCollection.AddSingleton<InputService>();
+        serviceCollection.AddSingleton<SceneService>();
 
         // IPC
         serviceCollection.AddSingleton<BrioIPCService>();
@@ -155,8 +157,9 @@ private static ServiceCollection SetupServices(DalamudServices dalamudServices)
         serviceCollection.AddSingleton<FileTypeInfoBase, CMToolPoseFileInfo>();
         serviceCollection.AddSingleton<FileTypeInfoBase, PoseFileInfo>();
         serviceCollection.AddSingleton<FileTypeInfoBase, MareCharacterDataFileInfo>();
+        serviceCollection.AddSingleton<FileTypeInfoBase, SceneFileInfo>();
         serviceCollection.AddSingleton<FileService>();
-
+        
         serviceCollection.AddSingleton<SourceBase, GameDataNpcSource>();
         serviceCollection.AddSingleton<SourceBase, GameDataMountSource>();
         serviceCollection.AddSingleton<SourceBase, GameDataOrnamentSource>();

diff --git a/Brio/Capabilities/Actor/ActorAppearanceCapability.cs b/Brio/Capabilities/Actor/ActorAppearanceCapability.cs
@@ -166,6 +166,20 @@ public Task ToggleHide()
         return SetAppearance(appearance, AppearanceImportOptions.ExtendedAppearance);
     }
 
+    public Task Hide()
+    {
+        var appearance = _actorAppearanceService.GetActorAppearance(Character);
+        appearance.ExtendedAppearance.Transparency = 1f;
+        return SetAppearance(appearance, AppearanceImportOptions.ExtendedAppearance);
+    }
+
+    public Task Show()
+    {
+        var appearance = _actorAppearanceService.GetActorAppearance(Character);
+        appearance.ExtendedAppearance.Transparency = 0f;
+        return SetAppearance(appearance, AppearanceImportOptions.ExtendedAppearance);
+    }
+
     public Task ApplyEmperors()
     {
         var appearance = _actorAppearanceService.GetActorAppearance(Character);

diff --git a/Brio/Capabilities/Actor/ActorContainerCapability.cs b/Brio/Capabilities/Actor/ActorContainerCapability.cs
@@ -1,6 +1,8 @@
-using Brio.Capabilities.Core;
+using System;
+using Brio.Capabilities.Core;
 using Brio.Entities;
 using Brio.Entities.Actor;
+using Brio.Entities.Core;
 using Brio.Game.Actor;
 using Brio.Game.Core;
 using Brio.Game.GPose;
@@ -32,19 +34,23 @@ public void SelectActorInHierarchy(ActorEntity entity)
         _entityManager.SetSelectedEntity(entity);
     }
 
-    public void CreateCharacter(bool enableAttachments, bool targetNewInHierarchy, bool forceSpawnActorWithoutCompanion = false)
+    public (EntityId, ICharacter) CreateCharacter(bool enableAttachments, bool targetNewInHierarchy, bool forceSpawnActorWithoutCompanion = false)
     {
         SpawnFlags flags = SpawnFlags.Default;
         if(enableAttachments)
             flags |= SpawnFlags.ReserveCompanionSlot;
 
         if(_actorSpawnService.CreateCharacter(out var chara, flags, disableSpawnCompanion: forceSpawnActorWithoutCompanion))
         {
+            EntityId characterId = new EntityId(chara);
             if(targetNewInHierarchy)
             {
-                _entityManager.SetSelectedEntity(chara);
+                _entityManager.SetSelectedEntity(characterId);
             }
+            return (characterId, chara);
         }
+
+        throw new Exception("Failed to create character");
     }
 
     public void DestroyCharacter(ActorEntity entity)

diff --git a/Brio/Capabilities/Actor/CompanionCapability.cs b/Brio/Capabilities/Actor/CompanionCapability.cs
@@ -1,4 +1,5 @@
-using Brio.Entities.Actor;
+using Brio.Entities;
+using Brio.Entities.Actor;
 using Brio.Game.Actor;
 using Brio.Game.Actor.Extensions;
 using Brio.Game.Types;
@@ -14,13 +15,14 @@ internal unsafe class CompanionCapability : ActorCharacterCapability
     public ModeType Mode { get; }
 
     private readonly ActorSpawnService _actorSpawnService;
+    private readonly EntityManager _entityManager;
 
-
-    public CompanionCapability(ActorEntity parent, ModeType mode, ActorSpawnService actorSpawnService) : base(parent)
+    public CompanionCapability(ActorEntity parent, ModeType mode, ActorSpawnService actorSpawnService, EntityManager entityManager) : base(parent)
     {
-        Mode = mode;
         _actorSpawnService = actorSpawnService;
+        _entityManager = entityManager;
 
+        Mode = mode;
         Widget = new CompanionWidget(this);
     }
 
@@ -34,6 +36,19 @@ public void SetCompanion(CompanionContainer container)
         _actorSpawnService.CreateCompanion(Character, container);
     }
 
+    public unsafe Entities.Core.Entity? GetCompanionAsEntity()
+    {
+        if(Character.HasSpawnedCompanion())
+        {
+            if(_entityManager.TryGetEntity(&Character.Native()->CompanionObject->Character.GameObject, out Entities.Core.Entity? actor))
+            {
+                return actor;
+            }
+        }
+
+        return null;
+    }
+
     public static CompanionCapability? CreateIfEligible(IServiceProvider provider, ActorEntity entity)
     {
         if(entity.GameObject is ICharacter character && character.HasCompanionSlot())

diff --git a/Brio/Capabilities/Debug/DebugCapability.cs b/Brio/Capabilities/Debug/DebugCapability.cs
@@ -2,6 +2,7 @@
 using Brio.Entities.Core;
 using Brio.Game.GPose;
 using Brio.UI.Widgets.Debug;
+using Dalamud.Plugin.Services;
 using FFXIVClientStructs.FFXIV.Client.Game;
 using FFXIVClientStructs.FFXIV.Client.Game.Control;
 using FFXIVClientStructs.FFXIV.Client.Game.Event;
@@ -16,10 +17,10 @@ internal unsafe class DebugCapability : Capability
 {
     private readonly GPoseService _gPoseService;
 
-    public DebugCapability(Entity parent, GPoseService gPoseService) : base(parent)
+    public DebugCapability(IClientState clientState, Entity parent, GPoseService gPoseService) : base(parent)
     {
         _gPoseService = gPoseService;
-        Widget = new DebugWidget(this);
+        Widget = new DebugWidget(this, clientState);
     }
 
     public void EnterGPose()

diff --git a/Brio/Capabilities/Posing/ModelPosingCapability.cs b/Brio/Capabilities/Posing/ModelPosingCapability.cs
@@ -1,8 +1,10 @@
 using Brio.Capabilities.Actor;
+using Brio.Config;
 using Brio.Core;
 using Brio.Entities.Actor;
 using Brio.Files;
 using Brio.Game.Posing;
+using System.Numerics;
 
 namespace Brio.Capabilities.Posing;
 
@@ -40,7 +42,6 @@ public unsafe Transform OriginalTransform
 
     public Transform? OverrideTransform => _transformOverride;
 
-
     private Transform? _transformOverride = null;
     private Transform? _originalTransform = null;
 
@@ -66,15 +67,53 @@ public override void Dispose()
         ResetTransform();
     }
 
-    public void ImportModelPose(PoseFile poseFile, PoseImporterOptions options)
+    public void ImportModelPose(PoseFile poseFile, PoseImporterOptions options, bool isLoadingAsScene)
     {
         if(options.ApplyModelTransform)
-            Transform += poseFile.ModelDifference;
+        {
+            if(isLoadingAsScene)
+            {
+                Transform = new Transform
+                {
+                    Position = ConfigurationService.Instance.Configuration.Import.PositionTransformType switch
+                    {
+                        ScenePoseTransformType.Difference => Transform.Position + poseFile.ModelDifference.Position,
+                        ScenePoseTransformType.Absolute => poseFile.ModelAbsoluteValues.Position,
+                        _ => Transform.Position
+                    },
+                    Rotation = ConfigurationService.Instance.Configuration.Import.RotationTransformType switch
+                    {
+                        ScenePoseTransformType.Difference => Quaternion.Normalize(Transform.Rotation * poseFile.ModelDifference.Rotation),
+                        ScenePoseTransformType.Absolute => poseFile.ModelAbsoluteValues.Rotation,
+                        _ => Transform.Rotation
+                    },
+                    Scale = ConfigurationService.Instance.Configuration.Import.ScaleTransformType switch
+                    {
+                        ScenePoseTransformType.Difference => Transform.Scale + poseFile.ModelDifference.Scale,
+                        ScenePoseTransformType.Absolute => poseFile.ModelAbsoluteValues.Scale,
+                        _ => Transform.Scale
+                    }
+                };
+            }
+            else
+            {
+                Transform += poseFile.ModelDifference;
+            }
+        }
     }
 
     public void ExportModelPose(PoseFile poseFile)
     {
         if(_originalTransform.HasValue)
+        {
             poseFile.ModelDifference = Transform.CalculateDiff(_originalTransform.Value);
+        }
+
+        poseFile.ModelAbsoluteValues = Transform;
+
+        // For better support for other pose tools
+        poseFile.Position = Transform.Position;
+        poseFile.Rotation = Transform.Rotation;
+        poseFile.Scale = Transform.Scale;
     }
 }
diff --git a/Brio/Capabilities/Posing/PosingCapability.cs b/Brio/Capabilities/Posing/PosingCapability.cs
@@ -2,7 +2,6 @@
 using Brio.Config;
 using Brio.Core;
 using Brio.Entities.Actor;
-using Brio.Entities.Core;
 using Brio.Files;
 using Brio.Game.Posing;
 using Brio.Input;
@@ -180,6 +179,8 @@ internal void ImportPose_internal(OneOf<PoseFile, CMToolPoseFile> rawPoseFile, P
         else if(asScene)
         {
             options = _posingService.SceneImporterOptions;
+
+            options.ApplyModelTransform = ConfigurationService.Instance.Configuration.Import.ApplyModelTransform;
         }
         else if(asIPCpose)
         {
@@ -196,7 +197,7 @@ internal void ImportPose_internal(OneOf<PoseFile, CMToolPoseFile> rawPoseFile, P
         SkeletonPosing.ImportSkeletonPose(poseFile, options, expressionPhase2);
 
         if(asExpression == false)
-            ModelPosing.ImportModelPose(poseFile, options);
+            ModelPosing.ImportModelPose(poseFile, options, asScene);
 
         if(generateSnapshot)
             _framework.RunOnTick(() => Snapshot(reset, reconcile, asExpression: asExpression), delayTicks: 4);
@@ -295,8 +296,7 @@ private void Reconcile(bool reset = true, bool generateSnapshot = true)
             ImportPose_internal(poseFile, options: all, generateSnapshot: false);
         }, delayTicks: 2);
     }
-
-    private PoseFile GeneratePoseFile()
+    public PoseFile GeneratePoseFile()
     {
         var poseFile = new PoseFile();
         SkeletonPosing.ExportSkeletonPose(poseFile);

diff --git a/Brio/Config/Configuration.cs b/Brio/Config/Configuration.cs
@@ -26,16 +26,22 @@ internal class Configuration : IPluginConfiguration
 
     // Environment
     public EnvironmentConfiguration Environment { get; set; } = new EnvironmentConfiguration();
+
+    public SceneImportConfiguration Import { get; set; } = new SceneImportConfiguration();
 
     // Library
     public LibraryConfiguration Library { get; set; } = new LibraryConfiguration();
 
     public string LastMCDFPath { get; set; } = string.Empty;
     public string LastExportPath { get; set; } = string.Empty;
     public string LastXATPath { get; set; } = string.Empty;
+
+    public string LastScenePath { get; set; } = string.Empty;
 
     public bool UseLibraryWhenImporting { get; set; } = true;
 
+    public bool SceneDestoryActorsBeforeImport { get; set; } = false;
+
     // Input
     public InputConfiguration Input { get; set; } = new InputConfiguration();
 

diff --git a/Brio/Config/SceneImportConfiguration.cs b/Brio/Config/SceneImportConfiguration.cs
@@ -0,0 +1,17 @@
+namespace Brio.Config;
+
+internal class SceneImportConfiguration
+{
+    public bool ApplyModelTransform { get; set; } = true;
+
+    public ScenePoseTransformType PositionTransformType { get; set; } = ScenePoseTransformType.Difference;
+    public ScenePoseTransformType RotationTransformType { get; set; } = ScenePoseTransformType.Absolute;
+    public ScenePoseTransformType ScaleTransformType { get; set; } = ScenePoseTransformType.Absolute;
+}
+
+internal enum ScenePoseTransformType
+{
+    Ignore,
+    Difference,
+    Absolute
+}
diff --git a/Brio/Entities/Actor/ActorContainerEntity.cs b/Brio/Entities/Actor/ActorContainerEntity.cs
@@ -18,7 +18,7 @@ public override void OnAttached()
 
     public override void OnChildAttached() => SortChildren();
     public override void OnChildDetached() => SortChildren();
-
+    
 
     private void SortChildren()
     {

diff --git a/Brio/Entities/Actor/ActorEntity.cs b/Brio/Entities/Actor/ActorEntity.cs
@@ -17,21 +17,21 @@ internal class ActorEntity(IGameObject gameObject, IServiceProvider provider) :
 
         private readonly ConfigurationService _configService = provider.GetRequiredService<ConfigurationService>();
 
-        string name = "";
+        public string RawName = "";
         public override string FriendlyName
         {
             get
             {
-                if(string.IsNullOrEmpty(name))
+                if(string.IsNullOrEmpty(RawName))
                 {
                     return _configService.Configuration.Interface.CensorActorNames ? GameObject.GetCensoredName() : GameObject.GetFriendlyName();
                 }
 
-                return GameObject.GetAsCustomName(name);
+                return GameObject.GetAsCustomName(RawName);
             }
             set
             {
-                name = value;
+                RawName = value;
             }
         }
         public override FontAwesomeIcon Icon => IsProp ? FontAwesomeIcon.Cube : GameObject.GetFriendlyIcon();

diff --git a/Brio/Entities/EntityManager.cs b/Brio/Entities/EntityManager.cs
@@ -124,6 +124,17 @@ public bool TryGetEntity<T>(EntityId id, [MaybeNullWhen(false)] out T entity) wh
         _entityMap.TryGetValue(id, out var entity);
         return entity;
     }
+
+    public T? GetEntity<T>(EntityId id) where T : Entity
+    {
+        _entityMap.TryGetValue(id, out var entity);
+
+        if(entity is T t)
+        {
+            return t;
+        }
+        return null;
+    }
 
     public bool EntityExists(EntityId id)
     {
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,7 +18,7 @@ public override void OnAttached() @@
         public override void OnChildAttached() => SortChildren();
         public override void OnChildDetached() => SortChildren();
         private void SortChildren()
         {
@@ Expand Down @@