#5537: Merge common code from ParticleSelector into DeclarationSelector.

Expand base class for added flexibility.

radiant/ui/common/DeclarationSelector.cpp

@@ -1,5 +1,8 @@
 #include "DeclarationSelector.h"
 
+#include <wx/sizer.h>
+#include "wxutil/dataview/ResourceTreeViewToolbar.h"
+
 namespace ui
 {
 
@@ -12,28 +15,59 @@ DeclarationSelector::DeclarationSelector(wxWindow* parent, decl::Type declType,
     wxPanel(parent),
     _declType(declType),
     _columns(columns),
-    _treeView(nullptr)
+    _treeView(nullptr),
+    _horizontalSizer(nullptr),
+    _treeViewSizerItem(nullptr)
 {
     SetSizer(new wxBoxSizer(wxVERTICAL));
     createTreeView();
+
+    auto* toolbar = new wxutil::ResourceTreeViewToolbar(this, _treeView);
+
+    auto treeVbox = new wxBoxSizer(wxVERTICAL);
+    treeVbox->Add(toolbar, 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 6);
+    treeVbox->Add(_treeView, 1, wxEXPAND);
+
+    _horizontalSizer = new wxBoxSizer(wxHORIZONTAL);
+    _treeViewSizerItem = _horizontalSizer->Add(treeVbox, 1, wxEXPAND);
+    // the horizontal sizer has room for a preview widget => AddPreviewToRightPane
+
+    GetSizer()->Add(_horizontalSizer, 1, wxEXPAND);
+
+    // a preview widget can be appended to the vertical sizer => AddPreviewToBottom
+}
+
+void DeclarationSelector::AddPreviewToRightPane(wxWindow* preview, int sizerProportion)
+{
+    // Tree view no longer takes full proportion after a full-size preview has been added
+    if (sizerProportion == 1)
+    {
+        _treeViewSizerItem->SetProportion(0);
+    }
+
+    preview->Reparent(this);
+    _horizontalSizer->Add(preview, sizerProportion, wxEXPAND | wxLEFT, 6);
+}
+
+void DeclarationSelector::AddPreviewToBottom(wxWindow* preview, int sizerProportion)
+{
+    preview->Reparent(this);
+    GetSizer()->Add(preview, sizerProportion, wxEXPAND | wxTOP, 3);
 }
 
 void DeclarationSelector::createTreeView()
 {
-    _treeView = new wxutil::DeclarationTreeView(this, decl::Type::Material,
-        _columns, wxDV_NO_HEADER | wxDV_SINGLE);
+    _treeView = new wxutil::DeclarationTreeView(this, _declType, _columns, wxDV_NO_HEADER | wxDV_SINGLE);
 
     // Single visible column, containing the directory/decl name and the icon
-    _treeView->AppendIconTextColumn(_("Value"), _columns.iconAndName.getColumnIndex(),
+    _treeView->AppendIconTextColumn(decl::getTypeName(_declType), _columns.iconAndName.getColumnIndex(),
         wxDATAVIEW_CELL_INERT, wxCOL_WIDTH_AUTOSIZE, wxALIGN_NOT, wxDATAVIEW_COL_SORTABLE);
 
     // Use the TreeModel's full string search function
     _treeView->AddSearchColumn(_columns.leafName);
 
     // Get selection and connect the changed callback
     _treeView->Bind(wxEVT_DATAVIEW_SELECTION_CHANGED, &DeclarationSelector::onTreeViewSelectionChanged, this);
-
-    GetSizer()->Add(_treeView, 1, wxEXPAND);
 }
 
 wxutil::DeclarationTreeView* DeclarationSelector::GetTreeView() const

radiant/ui/common/DeclarationSelector.h

@@ -20,6 +20,9 @@ class DeclarationSelector :
     const wxutil::DeclarationTreeView::Columns& _columns;
     wxutil::DeclarationTreeView* _treeView;
 
+    wxSizer* _horizontalSizer;
+    wxSizerItem* _treeViewSizerItem;
+
 public:
     // Construct a selector widget with the default set of tree view columns
     DeclarationSelector(wxWindow* parent, decl::Type declType);
@@ -45,6 +48,11 @@ class DeclarationSelector :
 
 protected:
     wxutil::DeclarationTreeView* GetTreeView() const;
+
+    // Adds a preview widget to the right of the tree view
+    void AddPreviewToRightPane(wxWindow* preview, int sizerProportion = 1);
+    void AddPreviewToBottom(wxWindow* preview, int sizerProportion = 0);
+
     const wxutil::DeclarationTreeView::Columns& GetColumns() const;
 
     void PopulateTreeView(const wxutil::IResourceTreePopulator::Ptr& populator);

radiant/ui/common/ShaderSelector.cpp

@@ -81,18 +81,12 @@ ShaderSelector::ShaderSelector(wxWindow* parent, const std::function<void()>& se
     _textureFilter(textureFilter),
 	_selectionChanged(selectionChanged)
 {
-    // Pack in info panel
-	createPreview();
+    _previewCombo = new TexturePreviewCombo(this);
+    AddPreviewToBottom(_previewCombo);
 
     PopulateTreeView(std::make_shared<ThreadedMaterialLoader>(GetColumns(), _textureFilter));
 }
 
-void ShaderSelector::createPreview()
-{
-    _previewCombo = new TexturePreviewCombo(this);
-    GetSizer()->Add(_previewCombo, 0, wxEXPAND | wxTOP, 3);
-}
-
 MaterialPtr ShaderSelector::getSelectedShader()
 {
 	return GlobalMaterialManager().getMaterial(GetSelectedDeclName());

radiant/ui/common/ShaderSelector.h

@@ -56,9 +56,6 @@ class ShaderSelector :
 
 protected:
     void onTreeViewSelectionChanged() override;
-
-private:
-	void createPreview();
 };
 
 } // namespace ui

radiant/ui/particles/ParticleChooserDialog.cpp

@@ -77,15 +77,15 @@ ParticleChooserDialog::SelectionResult ParticleChooserDialog::RunDialog(bool sho
 {
     auto* dialog = new ParticleChooserDialog(showClassnameSelector);
 
-    dialog->_selector->setSelectedParticle(currentParticle);
+    dialog->_selector->SetSelectedParticle(currentParticle);
 
     auto result = dialog->ShowModal();
 
     SelectionResult selectionResult;
 
     if (result == wxID_OK)
     {
-        selectionResult.selectedParticle = result == wxID_OK ? dialog->_selector->getSelectedParticle() : "";
+        selectionResult.selectedParticle = result == wxID_OK ? dialog->_selector->GetSelectedParticle() : "";
         selectionResult.selectedClassname = showClassnameSelector ? dialog->getSelectedClassname() : "";
     }
 

radiant/ui/particles/ParticleSelector.cpp

@@ -7,81 +7,45 @@ namespace ui
 {
 
 ParticleSelector::ParticleSelector(wxWindow* parent) :
-    wxPanel(parent, wxID_ANY),
+    DeclarationSelector(parent, decl::Type::Particle),
     _preview(new wxutil::ParticlePreview(this))
 {
-    SetSizer(new wxBoxSizer(wxVERTICAL));
-
-    // Tree view plus toolbar
-    auto* treeView = createTreeView(this);
-    auto* toolbar = new wxutil::ResourceTreeViewToolbar(this, treeView);
-
-    auto treeVbox = new wxBoxSizer(wxVERTICAL);
-    treeVbox->Add(toolbar, 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 6);
-    treeVbox->Add(treeView, 1, wxEXPAND);
-
-    // Treeview to the left, preview to the right
-    auto hbox = new wxBoxSizer(wxHORIZONTAL);
-
-    hbox->Add(treeVbox, 1, wxEXPAND);
-    hbox->Add(_preview->getWidget(), 0, wxEXPAND | wxLEFT, 6);
-
-    GetSizer()->Add(hbox, 1, wxEXPAND | wxALL, 12);
+    AddPreviewToRightPane(_preview->getWidget());
 
     GlobalParticlesManager().signal_particlesReloaded().connect(
         sigc::mem_fun(this, &ParticleSelector::reloadParticles)
     );
-}
 
-wxutil::ResourceTreeView* ParticleSelector::createTreeView(wxWindow* parent)
-{
-    _treeView = new wxutil::DeclarationTreeView(parent, decl::Type::Particle, _columns, wxDV_NO_HEADER);
-    _treeView->SetSize(300, -1);
-
-    _treeView->AppendIconTextColumn(_("Particle"), _columns.iconAndName.getColumnIndex(),
-        wxDATAVIEW_CELL_INERT, wxCOL_WIDTH_AUTOSIZE, wxALIGN_NOT, wxDATAVIEW_COL_SORTABLE);
-
-    // Apply full-text search to the column
-    _treeView->AddSearchColumn(_columns.leafName);
-
-    // Start loading particles into the view
     populateParticleList();
-
-    // Connect up the selection changed callback
-    _treeView->Bind(wxEVT_DATAVIEW_SELECTION_CHANGED, &ParticleSelector::_onSelChanged, this);
-
-    return _treeView;
 }
 
 void ParticleSelector::populateParticleList()
 {
-    _treeView->Populate(std::make_shared<ThreadedParticlesLoader>(_columns));
+    PopulateTreeView(std::make_shared<ThreadedParticlesLoader>(GetColumns()));
 }
 
 void ParticleSelector::reloadParticles()
 {
     populateParticleList();
 }
 
-std::string ParticleSelector::getSelectedParticle()
+std::string ParticleSelector::GetSelectedParticle()
 {
-    return _treeView->GetSelectedFullname();
+    return GetTreeView()->GetSelectedFullname();
 }
 
-void ParticleSelector::setSelectedParticle(const std::string& particleName)
+void ParticleSelector::SetSelectedParticle(const std::string& particleName)
 {
-    _treeView->SetSelectedFullname(particleName);
+    GetTreeView()->SetSelectedFullname(particleName);
 }
 
-void ParticleSelector::_onSelChanged(wxDataViewEvent& ev)
+void ParticleSelector::onTreeViewSelectionChanged()
 {
-    // Get the selection and store it
-    auto item = _treeView->GetSelection();
+    auto selectedParticle = GetSelectedParticle();
 
-    if (item.IsOk())
+    if (!selectedParticle.empty())
     {
-        wxutil::TreeModel::Row row(item, *_treeView->GetTreeModel());
-        _preview->setParticle(row[_columns.leafName]);
+        _preview->setParticle(selectedParticle);
     }
 }
 

radiant/ui/particles/ParticleSelector.h

@@ -1,8 +1,8 @@
 #pragma once
 
 #include <sigc++/trackable.h>
-#include <wx/panel.h>
 
+#include "../common/DeclarationSelector.h"
 #include "wxutil/dataview/DeclarationTreeView.h"
 #include "wxutil/preview/ParticlePreview.h"
 
@@ -15,32 +15,26 @@ namespace ui
  * Features a resource tree view on the left and a render preview on the right.
  */
 class ParticleSelector :
-    public wxPanel,
+    public DeclarationSelector,
     public sigc::trackable
 {
 private:
-    wxutil::DeclarationTreeView::Columns _columns;
-
-    // Tree view listing all the particles
-    wxutil::DeclarationTreeView* _treeView;
-
     // The preview widget
     wxutil::ParticlePreviewPtr _preview;
 
 public:
     ParticleSelector(wxWindow* parent);
 
-    std::string getSelectedParticle();
-    void setSelectedParticle(const std::string& particleName);
+    std::string GetSelectedParticle();
+    void SetSelectedParticle(const std::string& particleName);
 
-private:
-    wxutil::ResourceTreeView* createTreeView(wxWindow* parent);
+protected:
+    void onTreeViewSelectionChanged() override;
 
+private:
     // Populate the list of particles
     void populateParticleList();
     void reloadParticles();
-
-    void _onSelChanged(wxDataViewEvent& ev);
 };
 
 }