SampleView Class Reference

Description

Definition at line 28 of file SampleView.h.

Inheritance diagram for SampleView:

Collaboration diagram for SampleView:

Public Types
enum	ESubWindows { PYTHONPANEL , REALSPACEPANEL , SAMPLE_LIST }

Public Member Functions
	SampleView (QWidget *parent, ProjectDocument *document)
void	fillViewMenu (QMenu *menu)
void	toggleRealSpaceView ()

Protected Member Functions
void	showEvent (QShowEvent *) override

Private Member Functions
void	onAboutToRemoveItem (SampleItem item)
void	onRequestViewInRealSpace (SampleItem itemToView)
	Show the item in the real space view. More...
void	resetLayout ()
void	updateSingleSampleMode ()

Private Attributes
DocksController *	m_docks = nullptr
ProjectDocument *	m_document = nullptr
RealSpacePanel *	m_realSpacePanel = nullptr
SampleListView *	m_sampleSelectionView = nullptr

Member Enumeration Documentation

ESubWindows

enum SampleView::ESubWindows

Enumerator
PYTHONPANEL
REALSPACEPANEL
SAMPLE_LIST

Definition at line 31 of file SampleView.h.

{ PYTHONPANEL, REALSPACEPANEL, SAMPLE_LIST };

Constructor & Destructor Documentation

SampleView()

SampleView::SampleView	(	QWidget *	parent,
		ProjectDocument *	document
	)

Definition at line 34 of file SampleView.cpp.

    : QMainWindow(parent)
    , m_document(document)
{
    setObjectName("SampleView");
 
    connect(m_document, &ProjectDocument::singleSampleModeChanged, this,
            &SampleView::updateSingleSampleMode);
 
    m_docks = new DocksController(this);
 
    auto* editor = new LayerOrientedSampleEditor(this, document);
 
    auto* sampleSelectionPane = new QWidget(this);
    auto* sampleSelectionLayout = new QVBoxLayout(sampleSelectionPane);
    sampleSelectionLayout->setContentsMargins(0, 0, 0, 0);
    sampleSelectionLayout->setSpacing(0);
 
    auto* sampleSelectionToolbar = new StyledToolbar(sampleSelectionPane);
    m_sampleSelectionView = new SampleListView(this, m_document);
    sampleSelectionToolbar->addAction(m_sampleSelectionView->newSampleAction());
#ifdef BORNAGAIN_PYTHON
    sampleSelectionToolbar->addAction(m_sampleSelectionView->importSampleAction());
#endif
    sampleSelectionToolbar->addAction(m_sampleSelectionView->chooseFromLibraryAction());
    if (auto* btn = dynamic_cast<QToolButton*>(sampleSelectionToolbar->widgetForAction(
            m_sampleSelectionView->chooseFromLibraryAction())))
        btn->setPopupMode(QToolButton::InstantPopup);
 
    sampleSelectionToolbar->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
    sampleSelectionLayout->addWidget(sampleSelectionToolbar);
    sampleSelectionLayout->addWidget(m_sampleSelectionView);
    m_sampleSelectionView->setSizePolicy(QSizePolicy::MinimumExpanding,
                                         QSizePolicy::MinimumExpanding);
 
    auto* scriptPanel = new ScriptPanel(this);
    m_realSpacePanel = new RealSpacePanel(this);
 
    sampleSelectionPane->setWindowTitle("Samples");
 
    m_docks->addWidget(SAMPLE_LIST, sampleSelectionPane, Qt::LeftDockWidgetArea);
    m_docks->addWidget(REALSPACEPANEL, m_realSpacePanel, Qt::BottomDockWidgetArea);
    m_docks->addWidget(PYTHONPANEL, scriptPanel, Qt::BottomDockWidgetArea);
 
    connect(m_sampleSelectionView, &SampleListView::currentSampleChanged, editor,
            &LayerOrientedSampleEditor::setCurrentSample);
 
    connect(m_sampleSelectionView, &SampleListView::currentSampleChanged,
            [&](MultiLayerItem* m) { onRequestViewInRealSpace(m); });
 
    connect(m_sampleSelectionView, &SampleListView::currentSampleChanged, scriptPanel,
            &ScriptPanel::setCurrentSample);
 
    connect(editor, &LayerOrientedSampleEditor::modified, scriptPanel,
            &ScriptPanel::onSampleModified);
 
    connect(editor, &LayerOrientedSampleEditor::modified, m_sampleSelectionView,
            &SampleListView::onSampleModified);
 
    connect(editor, &LayerOrientedSampleEditor::requestViewInRealSpace, this,
            &SampleView::onRequestViewInRealSpace);
 
    connect(editor, &LayerOrientedSampleEditor::aboutToRemoveItem, this,
            &SampleView::onAboutToRemoveItem);
 
    connect(editor, &LayerOrientedSampleEditor::requestCreateNewSample,
            m_sampleSelectionView->newSampleAction(), &QAction::trigger, Qt::QueuedConnection);
 
    connect(editor, &LayerOrientedSampleEditor::modified, m_realSpacePanel->canvas(),
            &RealSpaceCanvas::updateScene);
 
    connect(editor, &LayerOrientedSampleEditor::modified, m_document, &ProjectDocument::setModified,
            Qt::UniqueConnection);
 
    setCentralWidget(editor);
    resetLayout();
}

References LayerOrientedSampleEditor::aboutToRemoveItem(), DocksController::addWidget(), RealSpacePanel::canvas(), SampleListView::chooseFromLibraryAction(), SampleListView::currentSampleChanged(), SampleListView::importSampleAction(), m_docks, m_document, m_realSpacePanel, m_sampleSelectionView, LayerOrientedSampleEditor::modified(), SampleListView::newSampleAction(), onAboutToRemoveItem(), onRequestViewInRealSpace(), SampleListView::onSampleModified(), ScriptPanel::onSampleModified(), PYTHONPANEL, REALSPACEPANEL, LayerOrientedSampleEditor::requestCreateNewSample(), LayerOrientedSampleEditor::requestViewInRealSpace(), resetLayout(), SAMPLE_LIST, LayerOrientedSampleEditor::setCurrentSample(), ScriptPanel::setCurrentSample(), ProjectDocument::setModified(), ProjectDocument::singleSampleModeChanged(), RealSpaceCanvas::updateScene(), and updateSingleSampleMode().

Here is the call graph for this function:

Member Function Documentation

fillViewMenu()

void SampleView::fillViewMenu

(

QMenu *

menu

)

Definition at line 175 of file SampleView.cpp.

{
    m_docks->addDockActionsToMenu(menu);
 
    menu->addSeparator();
 
    auto* action = new QAction(menu);
    action->setText("Reset to default layout");
    connect(action, &QAction::triggered, this, &SampleView::resetLayout);
    menu->addAction(action);
}

References DocksController::addDockActionsToMenu(), m_docks, and resetLayout().

Here is the call graph for this function:

onAboutToRemoveItem()

void SampleView::onAboutToRemoveItem ( SampleItem  item )

private

Definition at line 136 of file SampleView.cpp.

{
    // If an item shall be deleted from the sample, check whether RealSpace is affected.
    // Its current item could be itemToRemmove itself, or it could be a child of itemToRemove.
 
    // -- for convenience access later on
    auto* canvas = m_realSpacePanel->canvas();
    auto* currentAsLayer = canvas->currentItemAs<LayerItem*>();
    auto* currentAsLayout = canvas->currentItemAs<ParticleLayoutItem*>();
    auto* currentAsParticle = canvas->currentItemAs<ItemWithParticles*>();
    const auto resetIf = [&](bool b) {
        if (b)
            canvas->resetScene();
    };
 
    if (itemToRemove.get_if<MultiLayerItem*>()) {
        // -- itemToRemove is a sample. In this case: always reset
        canvas->resetScene();
    } else if (auto* layerToRemove = itemToRemove.get_if<LayerItem*>()) {
        // -- itemToRemove is a layer
        resetIf(layerToRemove == currentAsLayer);
        resetIf(layerToRemove->layouts().contains(currentAsLayout));
        resetIf(layerToRemove->itemsWithParticles().contains(currentAsParticle));
    } else if (auto* layoutToRemove = itemToRemove.get_if<ParticleLayoutItem*>()) {
        // -- itemToRemove is a particle layout
        resetIf(layoutToRemove == currentAsLayout);
        resetIf(layoutToRemove->containedItemsWithParticles().contains(currentAsParticle));
    } else if (auto* particleToRemove = itemToRemove.get_if<ItemWithParticles*>()) {
        // -- itemToRemove is a particle
        resetIf(particleToRemove == currentAsParticle);
        resetIf(particleToRemove->containedItemsWithParticles().contains(currentAsParticle));
    }
}

References RealSpacePanel::canvas(), RealSpaceCanvas::currentItemAs(), SampleItem::get_if(), and m_realSpacePanel.

Referenced by SampleView().

Here is the call graph for this function:

onRequestViewInRealSpace()

void SampleView::onRequestViewInRealSpace ( SampleItem  itemToView )

private

Show the item in the real space view.

If the real space view is not visible at the moment, it will be shown.

Definition at line 117 of file SampleView.cpp.

{
    RealSpaceCanvas::ItemForRealSpace itemForRealSpace;
    if (auto* p = itemToView.get_if<MultiLayerItem*>())
        itemForRealSpace = p;
    else if (auto* p = itemToView.get_if<LayerItem*>())
        itemForRealSpace = p;
    else if (auto* p = itemToView.get_if<ParticleLayoutItem*>())
        itemForRealSpace = p;
    else if (auto* p = itemToView.get_if<ItemWithParticles*>())
        itemForRealSpace = p;
    else
        return;
 
    m_docks->setDockVisible(REALSPACEPANEL);
    m_realSpacePanel->canvas()->setCurrentItem(m_sampleSelectionView->currentSample(),
                                               itemForRealSpace);
}

References RealSpacePanel::canvas(), SampleListView::currentSample(), SampleItem::get_if(), m_docks, m_realSpacePanel, m_sampleSelectionView, REALSPACEPANEL, RealSpaceCanvas::setCurrentItem(), and DocksController::setDockVisible().

Referenced by SampleView().

Here is the call graph for this function:

resetLayout()

void SampleView::resetLayout ( )

private

Definition at line 193 of file SampleView.cpp.

{
    m_docks->resetLayout();
 
    tabifyDockWidget(m_docks->findDock(REALSPACEPANEL), m_docks->findDock(PYTHONPANEL));
    m_docks->findDock(REALSPACEPANEL)->raise(); // makes first tab active
 
    m_docks->findDock(REALSPACEPANEL)->hide();
    m_docks->findDock(PYTHONPANEL)->hide();
 
    if (auto* d = m_docks->findDock(SAMPLE_LIST)) {
        if (m_document->singleSampleMode())
            d->hide();
        else
            d->show();
    }
}

References DocksController::findDock(), m_docks, m_document, PYTHONPANEL, REALSPACEPANEL, DocksController::resetLayout(), SAMPLE_LIST, and ProjectDocument::singleSampleMode().

Referenced by SampleView(), and fillViewMenu().

Here is the call graph for this function:

showEvent()

void SampleView::showEvent ( QShowEvent *  )

overrideprotected

Definition at line 187 of file SampleView.cpp.

{
    if (!m_sampleSelectionView->currentSample())
        m_sampleSelectionView->selectFirstSample();
}

References SampleListView::currentSample(), m_sampleSelectionView, and SampleListView::selectFirstSample().

Here is the call graph for this function:

toggleRealSpaceView()

void SampleView::toggleRealSpaceView

(

)

Definition at line 170 of file SampleView.cpp.

{
    m_docks->toggleDock(REALSPACEPANEL);
}

References m_docks, REALSPACEPANEL, and DocksController::toggleDock().

Here is the call graph for this function:

updateSingleSampleMode()

void SampleView::updateSingleSampleMode ( )

private

Definition at line 112 of file SampleView.cpp.

{
    m_docks->setDockVisible(SAMPLE_LIST, !m_document->singleSampleMode());
}

References m_docks, m_document, SAMPLE_LIST, DocksController::setDockVisible(), and ProjectDocument::singleSampleMode().

Referenced by SampleView().

Here is the call graph for this function:

Member Data Documentation

m_docks

DocksController* SampleView::m_docks = nullptr

private

Definition at line 52 of file SampleView.h.

Referenced by SampleView(), fillViewMenu(), onRequestViewInRealSpace(), resetLayout(), toggleRealSpaceView(), and updateSingleSampleMode().

m_document

ProjectDocument* SampleView::m_document = nullptr

private

Definition at line 53 of file SampleView.h.

Referenced by SampleView(), resetLayout(), and updateSingleSampleMode().

m_realSpacePanel

RealSpacePanel* SampleView::m_realSpacePanel = nullptr

private

Definition at line 54 of file SampleView.h.

Referenced by SampleView(), onAboutToRemoveItem(), and onRequestViewInRealSpace().

m_sampleSelectionView

SampleListView* SampleView::m_sampleSelectionView = nullptr

private

Definition at line 55 of file SampleView.h.

Referenced by SampleView(), onRequestViewInRealSpace(), and showEvent().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/SampleDesigner/SampleView.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/SampleDesigner/SampleView.cpp