ParticleCompositionForm Class Reference

Description

Form for editing a particle composition.

Definition at line 28 of file ParticleCompositionForm.h.

Inheritance diagram for ParticleCompositionForm:

Collaboration diagram for ParticleCompositionForm:

Public Member Functions
	ParticleCompositionForm (QWidget *parent, ParticleCompositionItem *compositionItem, SampleEditorController *ec, bool allowRemove=true)
ParticleCompositionItem *	compositionItem () const
void	enableStructureEditing (bool b)
void	onAboutToRemoveParticle (ItemWithParticles *item)
void	onParticleAdded (ItemWithParticles *item)

Private Attributes
ParticleCompositionItem *	m_compositionItem
SampleEditorController *	m_ec
QFormLayout *	m_layout
QAction *	m_removeAction = nullptr
QList< QWidget * >	m_structureEditingWidgets

Constructor & Destructor Documentation

ParticleCompositionForm()

ParticleCompositionForm::ParticleCompositionForm	(	QWidget *	parent,
		ParticleCompositionItem *	compositionItem,
		SampleEditorController *	ec,
		bool	allowRemove = true
	)

Definition at line 26 of file ParticleCompositionForm.cpp.

    : QGroupBox(parent)
    , m_compositionItem(compositionItem)
    , m_ec(ec)
{
    setTitle("Composition of particles");
 
    FormLayouter layouter(this, ec);
    layouter.setContentsMargins(30, 6, 0, 0);
    layouter.addVector(compositionItem->positionVector(), false);
    layouter.addSelection(compositionItem->rotation());
    layouter.addValue(compositionItem->abundance());
 
    for (auto* particle : compositionItem->particles())
        layouter.addRow(
            LayerEditorUtils::createWidgetForItemWithParticles(this, particle, false, ec));
 
    auto* btn = LayerEditorUtils::createAddParticleButton(
        this, [=](FormFactorItemCatalog::Type type) { ec->addParticle(compositionItem, type); },
        [=](ItemWithParticlesCatalog::Type type) { ec->addParticle(compositionItem, type); });
 
    m_structureEditingWidgets << btn;
    layouter.addStructureEditingRow(btn);
 
    auto* collapser = GroupBoxCollapser::installIntoGroupBox(this);
 
    auto* showInRealSpaceAction = ActionFactory::createShowInRealSpaceAction(
        this, "particle composition", [=] { ec->requestViewInRealSpace(compositionItem); });
    collapser->addAction(showInRealSpaceAction);
 
    if (allowRemove) {
        m_removeAction = ActionFactory::createRemoveAction(
            this, "particle composition", [=] { ec->removeParticle(compositionItem); });
        collapser->addAction(m_removeAction);
    }
 
    m_layout = layouter.layout();
}

References ItemWithParticles::abundance(), SampleEditorController::addParticle(), FormLayouter::addRow(), FormLayouter::addSelection(), FormLayouter::addStructureEditingRow(), FormLayouter::addValue(), FormLayouter::addVector(), compositionItem(), LayerEditorUtils::createAddParticleButton(), ActionFactory::createRemoveAction(), ActionFactory::createShowInRealSpaceAction(), LayerEditorUtils::createWidgetForItemWithParticles(), GroupBoxCollapser::installIntoGroupBox(), FormLayouter::layout(), m_layout, m_removeAction, m_structureEditingWidgets, ParticleCompositionItem::particles(), ItemWithParticles::positionVector(), SampleEditorController::removeParticle(), SampleEditorController::requestViewInRealSpace(), ItemWithParticles::rotation(), and FormLayouter::setContentsMargins().

Here is the call graph for this function:

Member Function Documentation

compositionItem()

ParticleCompositionItem * ParticleCompositionForm::compositionItem

(

)

const

Definition at line 75 of file ParticleCompositionForm.cpp.

{
    return m_compositionItem;
}

References m_compositionItem.

Referenced by ParticleCompositionForm().

enableStructureEditing()

void ParticleCompositionForm::enableStructureEditing

(

bool

b

)

Definition at line 67 of file ParticleCompositionForm.cpp.

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

References m_removeAction, and m_structureEditingWidgets.

onAboutToRemoveParticle()

void ParticleCompositionForm::onAboutToRemoveParticle

(

ItemWithParticles *

item

)

Definition at line 90 of file ParticleCompositionForm.cpp.

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

References m_compositionItem, m_layout, and ParticleCompositionItem::particles().

Here is the call graph for this function:

onParticleAdded()

void ParticleCompositionForm::onParticleAdded

(

ItemWithParticles *

item

)

Definition at line 80 of file ParticleCompositionForm.cpp.

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

References LayerEditorUtils::createWidgetForItemWithParticles(), m_compositionItem, m_ec, m_layout, and ParticleCompositionItem::particles().

Here is the call graph for this function:

Member Data Documentation

m_compositionItem

ParticleCompositionItem* ParticleCompositionForm::m_compositionItem

private

Definition at line 41 of file ParticleCompositionForm.h.

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

m_ec

SampleEditorController* ParticleCompositionForm::m_ec

private

Definition at line 43 of file ParticleCompositionForm.h.

Referenced by onParticleAdded().

m_layout

QFormLayout* ParticleCompositionForm::m_layout

private

Definition at line 40 of file ParticleCompositionForm.h.

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

m_removeAction

QAction* ParticleCompositionForm::m_removeAction = nullptr

private

Definition at line 42 of file ParticleCompositionForm.h.

Referenced by ParticleCompositionForm(), and enableStructureEditing().

m_structureEditingWidgets

QList<QWidget*> ParticleCompositionForm::m_structureEditingWidgets

private

Definition at line 44 of file ParticleCompositionForm.h.

Referenced by ParticleCompositionForm(), and enableStructureEditing().

---

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

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