MaterialBrowserDialog.hpp

/*
Cafu Engine, http://www.cafu.de/
Copyright (c) Carsten Fuchs and other contributors.
This project is licensed under the terms of the MIT license.
*/

#ifndef CAFU_MATERIAL_BROWSER_DIALOG_HPP_INCLUDED
#define CAFU_MATERIAL_BROWSER_DIALOG_HPP_INCLUDED

#include "Templates/Array.hpp"

#include "wx/dialog.h"
#include "wx/aui/framemanager.h"


class DocAdapterI;
class EditorMaterialI;


namespace MaterialBrowser
{
    class ControlsBarT;
    class FilterSettingsT;
    class MaterialPropertiesT;
    class MaterialTreeT;
    class ScrolledMaterialWindowT;


    /// This class implements the "named parameter idiom" for the MaterialBrowser::DialogT.
    /// See http://www.parashift.com/c++-faq-lite/ctors.html#faq-10.20 for details.
    class ConfigT
    {
        public:

        ConfigT();

        ConfigT& InitialMaterial(EditorMaterialI* Mat) { m_InitialMaterial=Mat;      return *this; }
        ConfigT& InitialNameFilter(const wxString& s)  { m_InitialNameFilter=s;      return *this; }
        ConfigT& OnlyShowUsed(bool b=true)             { m_OnlyShowUsed=b;           return *this; }
        ConfigT& NoFilterEditorMatsOnly(bool b=true)   { m_NoFilterEditorMatsOnly=b; return *this; }
        ConfigT& NoButtonMark(bool b=true)             { m_NoButtonMark=b;           return *this; }
        ConfigT& NoButtonReplace(bool b=true)          { m_NoButtonReplace=b;        return *this; }


        private:

        friend class DialogT;
        friend class ControlsBarT;
        friend class FilterSettingsT;

        EditorMaterialI* m_InitialMaterial;
        wxString         m_InitialNameFilter;
        bool             m_OnlyShowUsed;
        bool             m_NoFilterEditorMatsOnly;
        bool             m_NoButtonMark;
        bool             m_NoButtonReplace;
    };


    class DialogT : public wxDialog
    {
        public:

        /// The constructor.
        DialogT(wxWindow* Parent, const DocAdapterI& DocAccess, const ConfigT& Config);

        /// The destructor.
        ~DialogT();

        /// Returns the currently selected material.
        EditorMaterialI* GetCurrentMaterial() const;


        private:

        const DocAdapterI&        m_DocAccess;          ///< The (access interface to the) document that this dialog is for.
        const ConfigT&            m_Config;
        wxAuiManager              m_AUIManager;

        ScrolledMaterialWindowT*  m_ScrolledMatWin;
        ControlsBarT*             m_ControlsBar;
        MaterialTreeT*            m_MaterialTree;
        MaterialPropertiesT*      m_MaterialProperties;
        FilterSettingsT*          m_FilterSettings;

        wxString                  MatFolderFilter;

        int                       DisplaySize;          ///< Maintained by the OnChoice_DisplaySize handler.
        EditorMaterialI*          m_CurrentMaterial;    ///< Currently selected material.
        ArrayT<EditorMaterialI*>* m_UsedMaterialsList;  ///< Maintained by the OnCheckbox_OnlyShowUsed handler.


        const ArrayT<wxString>& GetNameFilterHistory();
        void SelectMaterial(EditorMaterialI* Material);


        // Helper functions.
        void Init(const ArrayT<EditorMaterialI*>& Materials);
        void SaveAndQuitDialog(int ReturnValue);

        // Event handlers.
        void OnChoice_DisplaySize(wxCommandEvent& Event);
        void OnButton_Mark(wxCommandEvent& Event);
        void OnButton_Replace(wxCommandEvent& Event);
        void OnButton_ExportDiffMaps(wxCommandEvent& Event);
        void OnButton_Cancel(wxCommandEvent& Event);
        void OnCombobox_NameFilterSelection(wxCommandEvent& Event);
        void OnCombobox_NameFilterTextChange(wxCommandEvent& Event);
        void OnCheckbox_OnlyShowUsed(wxCommandEvent& Event);
        void OnCheckbox_OnlyShowEditor(wxCommandEvent& Event);

        // IDs for the controls in whose events we are interested.
        enum
        {
            ID_SCROLLED_MaterialWindow=wxID_HIGHEST+1,
            ID_CHOICE_DisplaySize,
            ID_BUTTON_Mark,
            ID_BUTTON_Replace,
            ID_BUTTON_ExportDiffMaps,
            ID_COMBO_NameFilter,
            ID_COMBO_KeywordFilter,
            ID_CHECKBOX_OnlyShowUsed,
            ID_CHECKBOX_OnlyShowEditor,
        };

        DECLARE_EVENT_TABLE()

        friend class ScrolledMaterialWindowT;
        friend class ControlsBarT;
        friend class FilterSettingsT;
        friend class MaterialTreeT;
    };
}

#endif