feat: use new UiBuilder class for plugins, DalamudPluginInterface is now IDisposable

This commit is contained in:
goat 2020-01-13 21:06:58 +09:00
parent 72a4e6278d
commit 24450cf830
3 changed files with 45 additions and 13 deletions

View file

@ -32,7 +32,7 @@ namespace Dalamud.Interface
private RawDX11Scene scene;
/// <summary>
/// This event gets called when ImGUI is ready to draw your UI.
/// This event gets called by a plugin UiBuilder when read
/// </summary>
public event RawDX11Scene.BuildUIDelegate OnDraw;
@ -109,14 +109,7 @@ namespace Dalamud.Interface
// Doing this here because it's somewhat application-specific behavior
ImGui.GetIO().MouseDrawCursor = ImGui.GetIO().WantCaptureMouse;
// invoke all our external ui handlers, giving each a custom id to prevent name collisions
// because ImGui control names are globally shared
foreach (var del in this.OnDraw?.GetInvocationList())
{
//ImGui.PushID(someId);
del.DynamicInvoke();
//ImGui.PopID();
}
OnDraw?.Invoke();
}
}
}

View file

@ -0,0 +1,35 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using ImGuiNET;
using ImGuiScene;
namespace Dalamud.Interface
{
public class UiBuilder : IDisposable {
private readonly string namespaceName;
public event RawDX11Scene.BuildUIDelegate OnBuildUi;
private InterfaceManager interfaceManager;
public UiBuilder(InterfaceManager interfaceManager, string namespaceName) {
this.namespaceName = namespaceName;
this.interfaceManager = interfaceManager;
this.interfaceManager.OnDraw += OnDraw;
}
public void Dispose() {
this.interfaceManager.OnDraw -= OnDraw;
}
private void OnDraw() {
ImGui.PushID(this.namespaceName);
OnBuildUi?.Invoke();
ImGui.PopID();
}
}
}

View file

@ -18,7 +18,7 @@ namespace Dalamud.Plugin
/// <summary>
/// This class acts as an interface to various objects needed to interact with Dalamud and the game.
/// </summary>
public class DalamudPluginInterface {
public class DalamudPluginInterface : IDisposable {
/// <summary>
/// The CommandManager object that allows you to add and remove custom chat commands.
/// </summary>
@ -35,9 +35,9 @@ namespace Dalamud.Plugin
public readonly Framework Framework;
/// <summary>
/// A <see cref="InterfaceManager">InterfaceManager</see> instance which allows you to draw UI into the game via ImGui draw calls.
/// A <see cref="UiBuilder">UiBuilder</see> instance which allows you to draw UI into the game via ImGui draw calls.
/// </summary>
public readonly InterfaceManager Interface;
public readonly UiBuilder UiBuilder;
/// A <see cref="SigScanner">SigScanner</see> instance targeting the main module of the FFXIV process.
/// </summary>
@ -54,13 +54,17 @@ namespace Dalamud.Plugin
this.CommandManager = dalamud.CommandManager;
this.Framework = dalamud.Framework;
this.ClientState = dalamud.ClientState;
this.Interface = dalamud.InterfaceManager;
this.UiBuilder = new UiBuilder(dalamud.InterfaceManager, pluginName);
this.TargetModuleScanner = new SigScanner(dalamud.TargetModule);
this.dalamud = dalamud;
this.pluginName = pluginName;
}
public void Dispose() {
this.UiBuilder.Dispose();
}
/// <summary>
/// Save a plugin configuration(inheriting IPluginConfiguration).
/// </summary>