✨ Create Common Editor Dockable Tool Windows and Panes

[softwareantics]

Description

• Create dockable windows for the following (to be implemented) tools:
  • Project Explorer - a tool to show resources to be used by the current project/game (projects are yet to be created).
  • Scene Hierarchy - a tool to show all entities within a scene (scenes are yet to be created)
  • Properties - a tool that will show different properties depending on the context (entity components, rendering settings, etc).
  • Console - a tool that shows an errors or warnings to do with the project, code, etc.
  • Entity Systems - a tool that will allow the user to add, remove and order entity systems to be be used within a scene.
• Created a dockable document pane to be used to display the currently loaded scene within the editor.
• Created a ManageWindowLayoutsView and associated view model to manage applying and deleting saved layouts.
• Created a SaveWindowLayoutView and associated view model used to save the currently setup layout to the applications roaming data.
• Added a standard default layout that is used once a user first starts up the application.
• Created a LayoutManager and LayoutManagerFactory that ensures we do not need to use the code-behind to handle saving and loading window layouts.
• Ensured that the application will save it's current layout so that when the user runs the application again the layout is the same as it was once closed.

Issues to Close

• Closes [FEATURE REQUEST] Create Common Editor Dockable Tool Windows and Panes #223
• Closes [FEATURE REQUEST] Add support for multiple window layouts. #228
• Closes [FEATURE REQUEST] Add a standard default window layout. #230

Dependencies

• FinalEngine.Editor.Common
  • Microsoft.Extensions.DependencyInjection.Abstractions 7.0.0 - adds extension methods to te IoC container.
  • System.IO.Abstractions 19.2.29
• FinalEngine.Editor.Desktop
  • Dirkster.AvalonDock 4.72.0 - Dockable tool and pane windows.
  • Dirkster.AvalonDock.Themes.VS2013 .72.0 - Visual Studio like styling to AvalonDock
  • EventBinder 2.5.2 - Used to bind commands to events in XAML.

Type of change

• This feature is related to the epic: [EPIC] Editor #231.
• New feature (non-breaking change which adds functionality).

How Has This Been Tested?

I provided unit tests for all testable changes. Final Code Coverage is showing 100% code coverage as I went ahead and fixed up a few areas in this PR that needed to be addressed anyways. Furthermore, I ran the editor and ensured that all tool windows could be toggled via the View > Tool Windows menu and the through the use of key bindings. I checked to make sure I could reset, save, delete and apply window layouts_. I also ensured that the last state of the window layout was used upon starting up the application.

Test Configuration:

• Operating System: Windows 10 Home
• Hardware: Intel i7-6700HQ @ 2.60GHz, 32GB RAM, GTX 950M
• Toolchain: VS Community 2022 17.5.4

Example Video

2023-08-11.19-58-36.mp4

Possible Issues

• [DISCUSSION] Stop using Dispatcher.ShutdownStarted in DockView code-behind #229
• ✨ Focus and select LayoutName text in TextBox for SaveWindowLayoutView. #232
• 🐛 Tests in ApplicationContextTests will sometimes fail. #233
• ✨ Display all ErrorContent inside tooltip for TextBox. #235
• ✨ Use two-way bindings in ManageWindowLayoutsViewModel to manage LayoutNames. #236

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added unit tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
  • See 🐛 Tests in ApplicationContextTests will sometimes fail. #233 if all tests do not pass locally on your machine.
• My changes generate no new warnings

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

The version of Java (11.0.20) you have used to run this analysis is deprecated and we will stop accepting it soon. Please update to at least Java 17.
Read more here