ImguiFileSystemDialog.h

Go to the documentation of this file.

#pragma once
 
#include "EditorCore/FileSystemExplorer.h"
#include "Render/Imgui/Utility/imgui_helpers.h"
 
#include "ThirdParty/DearImGui.h"
 
#include <Common/primitive_type.h>
#include <DataIO/FileSystem/Path.h>
 
#include <cstddef>
#include <vector>
#include <string>
#include <string_view>
 
namespace ph::editor
{
 
class ImguiEditorUIProxy;
 
struct ImguiFileSystemDialogParameters
{
    bool canSelectItem = true;
    bool canSelectDirectory = false;
 
    bool requiresItemSelection = false;
 
    bool requiresDirectorySelection = false;
};
 
class ImguiFileSystemDialog final
{
public:
    static const char* const OPEN_FILE_TITLE;
    static const char* const SAVE_FILE_TITLE;
    static const char* const OPEN_FOLDER_TITLE;
    static const char* const SAVE_FOLDER_TITLE;
 
public:
    ImguiFileSystemDialog();
 
    void openPopup(
        const char* popupName);
 
    void buildFileSystemDialogPopupModal(
        const char* popupName,
        ImguiEditorUIProxy editorUI,
        const ImguiFileSystemDialogParameters& params = {});
 
    void buildFileSystemDialogPopupModal(
        const char* popupName,
        ImguiEditorUIProxy editorUI,
        const ImVec2& dialogSize,
        const ImguiFileSystemDialogParameters& params = {});
 
    void clearSelection();
 
    bool dialogClosed();
 
    Path getSelectedDirectory() const;
 
    Path getSelectedItem() const;
 
    Path getSelectedTarget() const;
 
    std::vector<Path> getSelectedItems() const;
 
    bool hasSelectedDirectory() const;
 
    bool hasSelectedItem() const;
 
private:
    void buildFileSystemDialogContent(
        const ImVec2& dialogSize,
        const ImguiFileSystemDialogParameters& params);
 
    void buildFileSystemDialogTreeNodeRecursive(
        FileSystemDirectoryEntry* baseEntry);
 
    std::string_view getEntryItemNameWithoutDecorations(std::size_t itemIndex) const;
 
    FileSystemExplorer m_explorer;
    FileSystemDirectoryEntry* m_browsingEntry;
    FileSystemDirectoryEntry* m_selectedEntry;
    bool m_dialogClosedFlag;
 
    imgui::StringCache m_fsDialogEntryPreviewBuffer;
    imgui::StringCache m_fsDialogItemPreviewBuffer;
    bool m_isEditingEntry;
    bool m_isEditingItem;
 
    // Cached for display
    std::string m_fsDialogEntryPathName;
    std::vector<std::string> m_fsDialogEntryItemNames;
 
    std::vector<std::string> m_fsDialogRootNames;
    std::size_t m_fsDialogSelectedRootIdx;
    std::vector<Path> m_fsDialogEntryItems;
    std::size_t m_fsDialogSelectedEntryItemIdx;
    std::size_t m_fsDialogNumSelectedItems;
    std::vector<uint8> m_fsDialogEntryItemSelection;
};
 
}// end namespace ph::editor