ParticleLayoutForm Class Reference

Description

Form for editing a particle layout.

Definition at line 32 of file ParticleLayoutForm.h.

Inheritance diagram for ParticleLayoutForm:

Collaboration diagram for ParticleLayoutForm:

Public Member Functions
	ParticleLayoutForm (LayerForm *parent, ParticleLayoutItem *layoutItem, SampleEditorController *ec)
void	enableStructureEditing (bool b)
ParticleLayoutItem *	layoutItem () const
void	onAboutToRemoveParticle (ItemWithParticles *item)
void	onParticleAdded (ItemWithParticles *item)
void	updateDensityEnabling ()
	Disable/enable total density property depending on type of interference function. More...
void	updateDensityValue ()
	Update the shown density value. More...
void	updateTitle (const LayerItem *layerItem)

Private Attributes
GroupBoxCollapser *	m_collapser
SampleEditorController *	m_ec
QFormLayout *	m_layout
ParticleLayoutItem *	m_layoutItem
QAction *	m_removeAction
QList< QWidget * >	m_structureEditingWidgets
DoubleSpinBox *	m_totalDensitySpinBox

Constructor & Destructor Documentation

ParticleLayoutForm()

ParticleLayoutForm::ParticleLayoutForm	(	LayerForm *	parent,
		ParticleLayoutItem *	layoutItem,
		SampleEditorController *	ec
	)

Definition at line 31 of file ParticleLayoutForm.cpp.

    : QGroupBox(parent)
    , m_layoutItem(layoutItem)
    , m_ec(ec)
{
    FormLayouter layouter(this, ec);
    layouter.setContentsMargins(30, 6, 0, 0);
    int rowOfTotalDensity = layouter.addValue(m_layoutItem->totalDensity());
    m_totalDensitySpinBox =
        layouter.widgetAt<DoubleSpinBox*>(rowOfTotalDensity, QFormLayout::FieldRole);
    ASSERT(m_totalDensitySpinBox);
    layouter.addValue(m_layoutItem->weight());
    layouter.addRow(new InterferenceForm(this, layoutItem, ec));
 
    for (auto* particle : m_layoutItem->particles())
        layouter.addRow(
            LayerEditorUtils::createWidgetForItemWithParticles(this, particle, true, ec));
 
    auto* btn = LayerEditorUtils::createAddParticleButton(
        this, [=](FormFactorItemCatalog::Type type) { ec->addParticle(layoutItem, type); },
        [=](ItemWithParticlesCatalog::Type type) { ec->addParticle(layoutItem, type); });
    m_structureEditingWidgets << btn;
    layouter.addStructureEditingRow(btn);
 
    m_removeAction = ActionFactory::createRemoveAction(
        this, "particle layout", [=] { ec->removeLayout(parent, layoutItem); });
 
    auto* showInRealSpaceAction = ActionFactory::createShowInRealSpaceAction(
        this, "particle layout", [=] { ec->requestViewInRealSpace(layoutItem); });
 
    m_collapser = GroupBoxCollapser::installIntoGroupBox(this);
    m_collapser->addAction(showInRealSpaceAction);
    m_collapser->addAction(m_removeAction);
    m_layout = layouter.layout();
 
    updateDensityEnabling();
    updateTitle(parent->layerItem());
}

References GroupBoxCollapser::addAction(), SampleEditorController::addParticle(), FormLayouter::addRow(), FormLayouter::addStructureEditingRow(), FormLayouter::addValue(), LayerEditorUtils::createAddParticleButton(), ActionFactory::createRemoveAction(), ActionFactory::createShowInRealSpaceAction(), LayerEditorUtils::createWidgetForItemWithParticles(), GroupBoxCollapser::installIntoGroupBox(), LayerForm::layerItem(), FormLayouter::layout(), layoutItem(), m_collapser, m_layout, m_layoutItem, m_removeAction, m_structureEditingWidgets, m_totalDensitySpinBox, ParticleLayoutItem::particles(), SampleEditorController::removeLayout(), SampleEditorController::requestViewInRealSpace(), FormLayouter::setContentsMargins(), ParticleLayoutItem::totalDensity(), updateDensityEnabling(), updateTitle(), ParticleLayoutItem::weight(), and FormLayouter::widgetAt().

Here is the call graph for this function:

Member Function Documentation

enableStructureEditing()

void ParticleLayoutForm::enableStructureEditing

(

bool

b

)

Definition at line 71 of file ParticleLayoutForm.cpp.

{
    m_removeAction->setVisible(b);
    for (auto* w : m_structureEditingWidgets)
        w->setVisible(b);
}

References m_removeAction, and m_structureEditingWidgets.

layoutItem()

ParticleLayoutItem * ParticleLayoutForm::layoutItem

(

)

const

Definition at line 78 of file ParticleLayoutForm.cpp.

{
    return m_layoutItem;
}

References m_layoutItem.

Referenced by ParticleLayoutForm().

onAboutToRemoveParticle()

void ParticleLayoutForm::onAboutToRemoveParticle

(

ItemWithParticles *

item

)

Definition at line 93 of file ParticleLayoutForm.cpp.

{
    int index = m_layoutItem->particles().indexOf(item);
    const int rowInLayout =
        m_layout->rowCount() - m_layoutItem->particles().size() - 1 + index; // -1: btn
 
    m_layout->removeRow(rowInLayout);
}

References m_layout, m_layoutItem, and ParticleLayoutItem::particles().

Here is the call graph for this function:

onParticleAdded()

void ParticleLayoutForm::onParticleAdded

(

ItemWithParticles *

item

)

Definition at line 83 of file ParticleLayoutForm.cpp.

{
    int index = m_layoutItem->particles().indexOf(p);
    const int rowInLayout =
        m_layout->rowCount() - 1 - (m_layoutItem->particles().size() - 1) + index; // -1: btn
 
    m_layout->insertRow(rowInLayout,
                        LayerEditorUtils::createWidgetForItemWithParticles(this, p, true, m_ec));
}

References LayerEditorUtils::createWidgetForItemWithParticles(), m_ec, m_layout, m_layoutItem, and ParticleLayoutItem::particles().

Here is the call graph for this function:

updateDensityEnabling()

void ParticleLayoutForm::updateDensityEnabling

(

)

Disable/enable total density property depending on type of interference function.

E.g. 2-dimensional interference calculates density automatically, so the property shown in the particle layout shall be disabled.

Definition at line 102 of file ParticleLayoutForm.cpp.

{
    m_totalDensitySpinBox->setEnabled(!m_layoutItem->totalDensityIsDefinedByInterference());
}

References m_layoutItem, m_totalDensitySpinBox, and ParticleLayoutItem::totalDensityIsDefinedByInterference().

Referenced by ParticleLayoutForm().

Here is the call graph for this function:

updateDensityValue()

void ParticleLayoutForm::updateDensityValue

(

)

Update the shown density value.

This does not update any internal values, it only refreshes the shown value.

Definition at line 107 of file ParticleLayoutForm.cpp.

{
    m_totalDensitySpinBox->updateValue();
}

References m_totalDensitySpinBox, and DoubleSpinBox::updateValue().

Here is the call graph for this function:

updateTitle()

void ParticleLayoutForm::updateTitle

(

const LayerItem *

layerItem

)

Definition at line 112 of file ParticleLayoutForm.cpp.

{
    const auto layouts = layerItem->layouts();
    if (layouts.size() > 1)
        m_collapser->setTitle("Particle layout "
                              + QString::number(layouts.indexOf(m_layoutItem) + 1));
    else
        m_collapser->setTitle("Particle layout");
}

References LayerItem::layouts(), m_collapser, m_layoutItem, and GroupBoxCollapser::setTitle().

Referenced by ParticleLayoutForm().

Here is the call graph for this function:

Member Data Documentation

m_collapser

GroupBoxCollapser* ParticleLayoutForm::m_collapser

private

Definition at line 63 of file ParticleLayoutForm.h.

Referenced by ParticleLayoutForm(), and updateTitle().

m_ec

SampleEditorController* ParticleLayoutForm::m_ec

private

Definition at line 60 of file ParticleLayoutForm.h.

Referenced by onParticleAdded().

m_layout

QFormLayout* ParticleLayoutForm::m_layout

private

Definition at line 57 of file ParticleLayoutForm.h.

Referenced by ParticleLayoutForm(), onAboutToRemoveParticle(), and onParticleAdded().

m_layoutItem

ParticleLayoutItem* ParticleLayoutForm::m_layoutItem

private

Definition at line 58 of file ParticleLayoutForm.h.

Referenced by ParticleLayoutForm(), layoutItem(), onAboutToRemoveParticle(), onParticleAdded(), updateDensityEnabling(), and updateTitle().

m_removeAction

QAction* ParticleLayoutForm::m_removeAction

private

Definition at line 59 of file ParticleLayoutForm.h.

Referenced by ParticleLayoutForm(), and enableStructureEditing().

m_structureEditingWidgets

QList<QWidget*> ParticleLayoutForm::m_structureEditingWidgets

private

Definition at line 61 of file ParticleLayoutForm.h.

Referenced by ParticleLayoutForm(), and enableStructureEditing().

m_totalDensitySpinBox

DoubleSpinBox* ParticleLayoutForm::m_totalDensitySpinBox

private

Definition at line 62 of file ParticleLayoutForm.h.

Referenced by ParticleLayoutForm(), updateDensityEnabling(), and updateDensityValue().

---

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

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