SampleEditorController Class Reference

Description

Class to modify a sample from the layer oriented sample editor.

Use this class to modify the sample model. It takes care of notifications and creating undo/redo commands. It operates on one MultiLayerItem (which is a sample).

Definition at line 50 of file SampleEditorController.h.

Inheritance diagram for SampleEditorController:

Collaboration diagram for SampleEditorController:

Signals
void	aboutToRemoveItem (SampleItem item)
void	modified ()
void	requestViewInRealSpace (SampleItem item)

Public Member Functions
	SampleEditorController (ProjectDocument *document, MultiLayerItem *multi)
void	addLayer (LayerItem *before)
void	addLayerFromUndo (int atIndex)
void	addLayout (LayerForm *layerItem)
void	addParticle (ParticleCompositionItem *composition, FormFactorItemCatalog::Type type)
void	addParticle (ParticleCompositionItem *composition, ItemWithParticlesCatalog::Type type)
void	addParticle (ParticleLayoutItem *layout, FormFactorItemCatalog::Type t)
void	addParticle (ParticleLayoutItem *layout, ItemWithParticlesCatalog::Type type)
MaterialItems *	materialItems () const
	The materials of the current document. More...
void	onStartingToMoveLayer ()
void	onStoppedToMoveLayer (QWidget *widgetToMove, QWidget *moveAboveThisWidget)
ProjectDocument *	projectDocument () const
	The current document. More...
void	removeLayer (LayerItem *layerItem)
void	removeLayerFromUndo (int atIndex)
void	removeLayout (LayerForm *layerItem, ParticleLayoutItem *layout)
void	removeParticle (ItemWithParticles *item)
MultiLayerForm *	sampleForm () const
	The current form. More...
MultiLayerItem *	sampleItem () const
	The item on which this controller operates. More...
void	selectInterference (InterferenceForm *widget, int newIndex)
void	selectMaterial (ItemWithMaterial *item, const QString &newMaterialIdentifier)
void	setCoreFormFactor (ParticleCoreShellForm *widget, FormFactorItemCatalog::Type type)
void	setCurrentIndex (AbstractSelectionContainerForm *widget, int index, const AbstractSelectionDescriptor &d)
void	setDensityRelatedValue (InterferenceItem *interferenceItem, double newValue, DoubleDescriptor d)
	Set an interference function's value which affects the total particle density of the containing particle layout. More...
void	setDouble (double newValue, DoubleDescriptor d)
void	setDoubleFromUndo (double newValue, const QString &path)
void	setInt (int newValue, UIntDescriptor d)
void	setIntegrateOverXi (LatticeTypeSelectionForm *widget, bool newValue)
void	setMaterialValue (ItemWithMaterial *item, double newValue, DoubleDescriptor d)
void	setMesoCrystalBasis (MesoCrystalForm *widget, FormFactorItemCatalog::Type type)
void	setMesoCrystalBasis (MesoCrystalForm *widget, ItemWithParticlesCatalog::Type type)
void	setMultiLayerForm (MultiLayerForm *view)
	Set the current form. More...
void	setSampleDescription (const QString &description)
void	setSampleName (const QString &name)
void	setShellFormFactor (ParticleCoreShellForm *widget, FormFactorItemCatalog::Type type)
QUndoStack *	undoStack ()
	The contained undo stack. More...

Private Member Functions
ItemWithParticles *	createAndInitParticle (FormFactorItemCatalog::Type formFactorType) const
ItemWithParticles *	createAndInitParticle (ItemWithParticlesCatalog::Type itemType) const

Private Attributes
ProjectDocument *	m_document
MultiLayerForm *	m_sampleForm
MultiLayerItem *	m_sampleItem
QUndoStack	m_undoStack

Constructor & Destructor Documentation

SampleEditorController()

SampleEditorController::SampleEditorController	(	ProjectDocument *	document,
		MultiLayerItem *	multi
	)

Definition at line 41 of file SampleEditorController.cpp.

    : m_sampleItem(multi)
    , m_sampleForm(nullptr)
    , m_document(document)
{
}

Member Function Documentation

aboutToRemoveItem

void SampleEditorController::aboutToRemoveItem ( SampleItem  item )

signal

Referenced by removeLayerFromUndo(), removeLayout(), removeParticle(), and LayerOrientedSampleEditor::setCurrentSample().

addLayer()

void SampleEditorController::addLayer

(

LayerItem *

before

)

Definition at line 63 of file SampleEditorController.cpp.

{
    const int newIndex = (before != nullptr) ? m_sampleItem->layers().indexOf(before)
                                             : m_sampleItem->layers().size();
    m_undoStack.push(new CommandAddLayer(this, newIndex));
}

References MultiLayerItem::layers(), m_sampleItem, and m_undoStack.

Here is the call graph for this function:

addLayerFromUndo()

void SampleEditorController::addLayerFromUndo

(

int

atIndex

)

Definition at line 70 of file SampleEditorController.cpp.

{
 
    // -- find a color for the new layer
    QColor color;
    auto unusedColors = LayerEditorUtils::predefinedLayerColors();
    for (auto* l : m_sampleItem->layers())
        unusedColors.removeAll(l->color());
    if (!unusedColors.isEmpty())
        color = unusedColors.first();
    else {
        // search for a color which has been used the less, and which is not the same as in the
        // layers above and below
        QMap<QString, int> usage;
        for (auto* l : m_sampleItem->layers())
            usage[l->color().name()] += 1;
 
        auto sortedByUsage = LayerEditorUtils::predefinedLayerColors();
        std::stable_sort(
            sortedByUsage.begin(), sortedByUsage.end(),
            [&](const QColor& a, const QColor& b) { return usage[a.name()] < usage[b.name()]; });
 
 
        const QColor above =
            (atIndex > 0) ? m_sampleItem->layers()[atIndex - 1]->color() : QColor();
        const QColor below = (atIndex < m_sampleItem->layers().size())
                                 ? m_sampleItem->layers()[atIndex]->color()
                                 : QColor();
 
        for (const auto& col : sortedByUsage)
            if (col != above && col != below) {
                color = col;
                break;
            }
    }
 
    // - create new layer
    LayerItem* layer = m_sampleItem->addLayer(atIndex);
    layer->setMaterial(materialItems()->defaultMaterial());
    layer->setColor(color);
 
    ASSERT(m_sampleForm);
    m_sampleForm->onLayerAdded(layer);
    m_sampleForm->updateUnits();
 
    emit modified();
 
    // expand the new layer's form for better workflow
    for (auto* c : m_sampleForm->findChildren<LayerForm*>())
        if (c->layerItem() == layer)
            c->expand();
}

References MultiLayerItem::addLayer(), MultiLayerItem::layers(), m_sampleForm, m_sampleItem, materialItems(), modified(), MultiLayerForm::onLayerAdded(), LayerEditorUtils::predefinedLayerColors(), LayerItem::setColor(), ItemWithMaterial::setMaterial(), and MultiLayerForm::updateUnits().

Referenced by CommandAddLayer::redo().

Here is the call graph for this function:

addLayout()

void SampleEditorController::addLayout

(

LayerForm *

layerItem

)

Definition at line 123 of file SampleEditorController.cpp.

{
    auto* newLayoutItem = layerItemWidget->layerItem()->addLayout();
    layerItemWidget->onLayoutAdded(newLayoutItem);
    m_sampleForm->updateUnits();
 
    for (auto* layoutForms : layerItemWidget->findChildren<ParticleLayoutForm*>())
        layoutForms->updateTitle(layerItemWidget->layerItem());
 
    emit modified();
}

References LayerItem::addLayout(), LayerForm::layerItem(), m_sampleForm, modified(), LayerForm::onLayoutAdded(), and MultiLayerForm::updateUnits().

Referenced by LayerForm::LayerForm().

Here is the call graph for this function:

addParticle() [1/4]

void SampleEditorController::addParticle	(	ParticleCompositionItem *	composition,
		FormFactorItemCatalog::Type	type
	)

Definition at line 210 of file SampleEditorController.cpp.

{
    auto* newParticle = createAndInitParticle(formFactorType);
    compositionItem->addParticle(newParticle);
 
    emit modified();
 
    //  search for composition widget for notification
    ASSERT(m_sampleForm);
    for (auto* c : m_sampleForm->findChildren<ParticleCompositionForm*>())
        if (c->compositionItem() == compositionItem)
            c->onParticleAdded(newParticle);
    m_sampleForm->updateUnits();
}

References ParticleCompositionItem::addParticle(), createAndInitParticle(), m_sampleForm, modified(), and MultiLayerForm::updateUnits().

Here is the call graph for this function:

addParticle() [2/4]

void SampleEditorController::addParticle	(	ParticleCompositionItem *	composition,
		ItemWithParticlesCatalog::Type	type
	)

Definition at line 194 of file SampleEditorController.cpp.

{
    auto* newItem = createAndInitParticle(type);
    compositionItem->addParticle(newItem);
 
    emit modified();
 
    //  search for composition widget for notification
    ASSERT(m_sampleForm);
    for (auto* c : m_sampleForm->findChildren<ParticleCompositionForm*>())
        if (c->compositionItem() == compositionItem)
            c->onParticleAdded(newItem);
    m_sampleForm->updateUnits();
}

References ParticleCompositionItem::addParticle(), createAndInitParticle(), m_sampleForm, modified(), and MultiLayerForm::updateUnits().

Here is the call graph for this function:

addParticle() [3/4]

void SampleEditorController::addParticle	(	ParticleLayoutItem *	layout,
		FormFactorItemCatalog::Type	t
	)

Definition at line 162 of file SampleEditorController.cpp.

{
    auto* newParticle = createAndInitParticle(formFactorType);
    layoutItem->addParticle(newParticle);
 
    emit modified();
 
    //  search for particle layout widget for notification
    ASSERT(m_sampleForm);
    for (auto* w : m_sampleForm->findChildren<ParticleLayoutForm*>())
        if (w->layoutItem() == layoutItem)
            w->onParticleAdded(newParticle);
    m_sampleForm->updateUnits();
}

References ParticleLayoutItem::addParticle(), createAndInitParticle(), m_sampleForm, modified(), and MultiLayerForm::updateUnits().

Here is the call graph for this function:

addParticle() [4/4]

void SampleEditorController::addParticle	(	ParticleLayoutItem *	layout,
		ItemWithParticlesCatalog::Type	type
	)

Definition at line 178 of file SampleEditorController.cpp.

{
    auto* newItem = createAndInitParticle(type);
    layoutItem->addParticle(newItem);
 
    emit modified();
 
    //  search for particle layout widget for notification
    ASSERT(m_sampleForm);
    for (auto* w : m_sampleForm->findChildren<ParticleLayoutForm*>())
        if (w->layoutItem() == layoutItem)
            w->onParticleAdded(newItem);
    m_sampleForm->updateUnits();
}

References ParticleLayoutItem::addParticle(), createAndInitParticle(), m_sampleForm, modified(), and MultiLayerForm::updateUnits().

Referenced by ParticleCompositionForm::ParticleCompositionForm(), and ParticleLayoutForm::ParticleLayoutForm().

Here is the call graph for this function:

createAndInitParticle() [1/2]

ItemWithParticles * SampleEditorController::createAndInitParticle ( FormFactorItemCatalog::Type  formFactorType ) const

private

Definition at line 227 of file SampleEditorController.cpp.

{
    auto* newParticle = new ParticleItem(materialItems());
    newParticle->setFormFactor(FormFactorItemCatalog::create(formFactorType));
    newParticle->setMaterial(materialItems()->defaultMaterial());
    return newParticle;
}

References FormFactorItemCatalog::create(), and materialItems().

Referenced by addParticle(), and setMesoCrystalBasis().

Here is the call graph for this function:

createAndInitParticle() [2/2]

ItemWithParticles * SampleEditorController::createAndInitParticle ( ItemWithParticlesCatalog::Type  itemType ) const

private

Definition at line 236 of file SampleEditorController.cpp.

{
    auto* newItem = ItemWithParticlesCatalog::create(itemType, materialItems());
 
    if (auto* p = dynamic_cast<ItemWithMaterial*>(newItem))
        p->setMaterial(materialItems()->defaultMaterial());
 
    if (auto* cs = dynamic_cast<ParticleCoreShellItem*>(newItem)) {
        cs->createCore(materialItems());
        cs->createShell(materialItems());
        cs->core()->setFormFactor(new CylinderItem());
        cs->shell()->setFormFactor(new CylinderItem());
    }
 
    if (auto* meso = dynamic_cast<MesoCrystalItem*>(newItem); meso && meso->basisParticle())
        if (auto* p = dynamic_cast<ItemWithMaterial*>(meso->basisParticle()))
            p->setMaterial(materialItems()->defaultMaterial());
 
    return newItem;
}

References MesoCrystalItem::basisParticle(), ItemWithParticlesCatalog::create(), and materialItems().

Here is the call graph for this function:

materialItems()

MaterialItems * SampleEditorController::materialItems

(

)

const

The materials of the current document.

Definition at line 363 of file SampleEditorController.cpp.

{
    return &m_sampleItem->materialItems();
}

References m_sampleItem, and MultiLayerItem::materialItems().

Referenced by LayerForm::LayerForm(), addLayerFromUndo(), createAndInitParticle(), setCoreFormFactor(), and setShellFormFactor().

Here is the call graph for this function:

modified

void SampleEditorController::modified ( )

signal

Referenced by addLayerFromUndo(), addLayout(), addParticle(), onStoppedToMoveLayer(), removeLayerFromUndo(), removeLayout(), removeParticle(), selectInterference(), MaterialInplaceForm::selectMaterial(), selectMaterial(), setCoreFormFactor(), setCurrentIndex(), LayerOrientedSampleEditor::setCurrentSample(), setDouble(), setDoubleFromUndo(), setInt(), setIntegrateOverXi(), setMaterialValue(), setMesoCrystalBasis(), setSampleDescription(), setSampleName(), setShellFormFactor(), and CommandRemoveLayer::undo().

onStartingToMoveLayer()

void SampleEditorController::onStartingToMoveLayer

(

)

Definition at line 416 of file SampleEditorController.cpp.

{
    ASSERT(m_sampleForm);
    m_sampleForm->showAddLayerButtons(false);
}

References m_sampleForm, and MultiLayerForm::showAddLayerButtons().

Referenced by LayerForm::LayerForm().

Here is the call graph for this function:

onStoppedToMoveLayer()

void SampleEditorController::onStoppedToMoveLayer	(	QWidget *	widgetToMove,
		QWidget *	moveAboveThisWidget
	)

Definition at line 422 of file SampleEditorController.cpp.

{
    ASSERT(m_sampleForm);
    m_sampleForm->showAddLayerButtons(true);
    const auto* moveAboveThisLayerForm = m_sampleForm->findNextLayerForm(moveAboveThisWidget);
    auto* itemToMove = dynamic_cast<LayerForm*>(widgetToMove)->layerItem();
    auto* moveBeforeThisItem =
        moveAboveThisLayerForm != nullptr ? moveAboveThisLayerForm->layerItem() : nullptr;
 
    m_sampleItem->moveLayer(itemToMove, moveBeforeThisItem);
    m_sampleForm->onLayerMoved(itemToMove);
 
    // #baLayerEditor: tab order!
 
    emit modified();
}

References MultiLayerForm::findNextLayerForm(), LayerForm::layerItem(), m_sampleForm, m_sampleItem, modified(), MultiLayerItem::moveLayer(), MultiLayerForm::onLayerMoved(), and MultiLayerForm::showAddLayerButtons().

Referenced by LayerForm::LayerForm().

Here is the call graph for this function:

projectDocument()

ProjectDocument * SampleEditorController::projectDocument

(

)

const

The current document.

Definition at line 368 of file SampleEditorController.cpp.

{
    return m_document;
}

References m_document.

removeLayer()

void SampleEditorController::removeLayer

(

LayerItem *

layerItem

)

Definition at line 135 of file SampleEditorController.cpp.

{
    m_undoStack.push(new CommandRemoveLayer(this, layerItem));
}

References m_undoStack.

Referenced by LayerForm::LayerForm().

removeLayerFromUndo()

void SampleEditorController::removeLayerFromUndo

(

int

atIndex

)

Definition at line 140 of file SampleEditorController.cpp.

{
    auto* layer = m_sampleItem->layers()[atIndex];
    emit aboutToRemoveItem(layer);
    m_sampleForm->onAboutToRemoveLayer(layer);
    m_sampleItem->removeLayer(layer);
    m_sampleForm->updateRowVisibilities();
    emit modified();
}

References aboutToRemoveItem(), MultiLayerItem::layers(), m_sampleForm, m_sampleItem, modified(), MultiLayerForm::onAboutToRemoveLayer(), MultiLayerItem::removeLayer(), and MultiLayerForm::updateRowVisibilities().

Referenced by CommandRemoveLayer::redo(), and CommandAddLayer::undo().

Here is the call graph for this function:

removeLayout()

void SampleEditorController::removeLayout	(	LayerForm *	layerItem,
		ParticleLayoutItem *	layout
	)

Definition at line 150 of file SampleEditorController.cpp.

{
    emit aboutToRemoveItem(layout);
    layerItemWidget->onAboutToRemoveLayout(layout);
    layerItemWidget->layerItem()->removeLayout(layout);
 
    for (auto* layoutForms : layerItemWidget->findChildren<ParticleLayoutForm*>())
        layoutForms->updateTitle(layerItemWidget->layerItem());
 
    emit modified();
}

References aboutToRemoveItem(), LayerForm::layerItem(), modified(), LayerForm::onAboutToRemoveLayout(), and LayerItem::removeLayout().

Referenced by ParticleLayoutForm::ParticleLayoutForm().

Here is the call graph for this function:

removeParticle()

void SampleEditorController::removeParticle

(

ItemWithParticles *

item

)

Definition at line 285 of file SampleEditorController.cpp.

{
    ASSERT(m_sampleForm);
 
    for (auto* layoutForm : m_sampleForm->findChildren<ParticleLayoutForm*>())
        if (layoutForm->layoutItem()->particles().contains(itemToRemove)) {
            layoutForm->onAboutToRemoveParticle(itemToRemove);
 
            emit aboutToRemoveItem(itemToRemove);
            layoutForm->layoutItem()->removeParticle(itemToRemove);
            emit modified();
            return;
        }
 
    for (auto* c : m_sampleForm->findChildren<ParticleCompositionForm*>())
        if (c->compositionItem()->particles().contains(itemToRemove)) {
            c->onAboutToRemoveParticle(itemToRemove);
 
            emit aboutToRemoveItem(itemToRemove);
            c->compositionItem()->removeParticle(itemToRemove);
            emit modified();
            return;
        }
}

References aboutToRemoveItem(), m_sampleForm, and modified().

Referenced by MesoCrystalForm::MesoCrystalForm(), ParticleCompositionForm::ParticleCompositionForm(), ParticleCoreShellForm::ParticleCoreShellForm(), and ParticleForm::ParticleForm().

requestViewInRealSpace

void SampleEditorController::requestViewInRealSpace ( SampleItem  item )

signal

Referenced by LayerForm::LayerForm(), MesoCrystalForm::MesoCrystalForm(), MultiLayerForm::MultiLayerForm(), ParticleCompositionForm::ParticleCompositionForm(), ParticleCoreShellForm::ParticleCoreShellForm(), ParticleForm::ParticleForm(), ParticleLayoutForm::ParticleLayoutForm(), LayerOrientedSampleEditor::setCurrentSample(), ParticleCoreShellForm::showCoreInRealSpace(), and ParticleCoreShellForm::showShellInRealSpace().

sampleForm()

MultiLayerForm * SampleEditorController::sampleForm

(

)

const

The current form.

Definition at line 53 of file SampleEditorController.cpp.

{
    return m_sampleForm;
}

References m_sampleForm.

Referenced by CommandRemoveLayer::undo().

sampleItem()

MultiLayerItem * SampleEditorController::sampleItem

(

)

const

The item on which this controller operates.

Definition at line 58 of file SampleEditorController.cpp.

{
    return m_sampleItem;
}

References m_sampleItem.

Referenced by CommandRemoveLayer::CommandRemoveLayer(), LayerForm::enableStructureEditing(), MaterialInplaceForm::selectMaterial(), CommandRemoveLayer::undo(), LayerForm::updateLayerPositionDependentElements(), and LayerForm::updateTitle().

selectInterference()

void SampleEditorController::selectInterference	(	InterferenceForm *	widget,
		int	newIndex
	)

Definition at line 472 of file SampleEditorController.cpp.

{
    widget->layoutItem()->interference().setCurrentIndex(newIndex);
    widget->onInterferenceTypeChanged();
    m_sampleForm->updateUnits();
 
    // Disable/enable total density property in the particle layout, depending on type of
    // interference function.
    QWidget* parent = widget->parentWidget();
    while (parent != nullptr && dynamic_cast<ParticleLayoutForm*>(parent) == nullptr)
        parent = parent->parentWidget();
 
    if (auto* particleLayoutForm = dynamic_cast<ParticleLayoutForm*>(parent)) {
        particleLayoutForm->updateDensityEnabling();
        particleLayoutForm->updateDensityValue();
    }
 
    emit modified();
}

References ParticleLayoutItem::interference(), InterferenceForm::layoutItem(), m_sampleForm, modified(), InterferenceForm::onInterferenceTypeChanged(), and MultiLayerForm::updateUnits().

Referenced by InterferenceForm::InterferenceForm().

Here is the call graph for this function:

selectMaterial()

void SampleEditorController::selectMaterial	(	ItemWithMaterial *	item,
		const QString &	newMaterialIdentifier
	)

Definition at line 373 of file SampleEditorController.cpp.

{
    item->setMaterial(newMaterialIdentifier);
 
    //  update Layer title
    ASSERT(m_sampleForm);
    for (auto* c : m_sampleForm->findChildren<LayerForm*>())
        if (c->layerItem() == item)
            c->updateTitle();
 
    // #baLayerEditor notify all material users (update link info)
    emit modified();
}

References m_sampleForm, modified(), and ItemWithMaterial::setMaterial().

Referenced by MaterialInplaceForm::selectMaterial().

Here is the call graph for this function:

setCoreFormFactor()

void SampleEditorController::setCoreFormFactor	(	ParticleCoreShellForm *	widget,
		FormFactorItemCatalog::Type	type
	)

Definition at line 257 of file SampleEditorController.cpp.

{
    auto* particleCoreShell = widget->coreShellItem();
 
    if (particleCoreShell->core() == nullptr)
        particleCoreShell->createCore(materialItems());
 
    particleCoreShell->core()->setFormFactor(FormFactorItemCatalog::create(type));
    widget->createCoreWidgets();
    m_sampleForm->updateUnits();
    emit modified();
}

References ParticleCoreShellForm::coreShellItem(), FormFactorItemCatalog::create(), ParticleCoreShellItem::createCore(), ParticleCoreShellForm::createCoreWidgets(), m_sampleForm, materialItems(), modified(), ParticleItem::setFormFactor(), and MultiLayerForm::updateUnits().

Referenced by ParticleCoreShellForm::onCoreComboChanged().

Here is the call graph for this function:

setCurrentIndex()

void SampleEditorController::setCurrentIndex	(	AbstractSelectionContainerForm *	widget,
		int	index,
		const AbstractSelectionDescriptor &	d
	)

Definition at line 349 of file SampleEditorController.cpp.

{
    d.setCurrentIndex(index);
    widget->createContent();
    m_sampleForm->updateUnits();
    emit modified();
}

References AbstractSelectionContainerForm::createContent(), m_sampleForm, modified(), AbstractSelectionDescriptor::setCurrentIndex(), and MultiLayerForm::updateUnits().

Referenced by AbstractSelectionContainerForm::initUI().

Here is the call graph for this function:

setDensityRelatedValue()

void SampleEditorController::setDensityRelatedValue	(	InterferenceItem *	interferenceItem,
		double	newValue,
		DoubleDescriptor	d
	)

Set an interference function's value which affects the total particle density of the containing particle layout.

Some values in interference settings affect the total density in the particle layout which contains this interference function. Call this method to provide all the related updating (data & UI).

Definition at line 402 of file SampleEditorController.cpp.

{
    setDouble(newValue, d);
 
    // -- notify the containing particle layout UI about changed value
    ASSERT(m_sampleForm);
    for (auto* c : m_sampleForm->findChildren<ParticleLayoutForm*>())
        if (c->layoutItem()->interference() == interferenceItem) {
            c->updateDensityValue();
            break;
        }
}

References m_sampleForm, and setDouble().

Referenced by LatticeTypeSelectionForm::createContent(), and InterferenceForm::createInterferenceWidgets().

Here is the call graph for this function:

setDouble()

void SampleEditorController::setDouble	(	double	newValue,
		DoubleDescriptor	d
	)

Definition at line 310 of file SampleEditorController.cpp.

{
    m_undoStack.push(new CommandChangeValue(d.label, this, d.get(), newValue, d.path()));
    d.set(newValue);
    emit modified();
}

References DoubleDescriptor::get, DoubleDescriptor::label, m_undoStack, modified(), DoubleDescriptor::path, and DoubleDescriptor::set.

Referenced by LayerEditorUtils::addMultiPropertyToGrid(), FormLayouter::insertValue(), setDensityRelatedValue(), and setMaterialValue().

setDoubleFromUndo()

void SampleEditorController::setDoubleFromUndo	(	double	newValue,
		const QString &	path
	)

Definition at line 317 of file SampleEditorController.cpp.

{
    ASSERT(m_sampleForm);
 
    DoubleSpinBox* spinBox = nullptr;
    for (auto* s : m_sampleForm->findChildren<DoubleSpinBox*>()) {
        if (s->valueDescriptor().path() == path) {
            spinBox = s;
            break;
        }
    }
 
    if (!spinBox)
        return;
 
    spinBox->valueDescriptor().set(newValue);
 
    m_sampleForm->ensureVisible(spinBox);
    QSignalBlocker b(spinBox);
    spinBox->setBaseValue(newValue);
    spinBox->setFocus();
    spinBox->selectAll();
 
    emit modified();
}

References MultiLayerForm::ensureVisible(), m_sampleForm, modified(), DoubleDescriptor::set, DoubleSpinBox::setBaseValue(), and DoubleSpinBox::valueDescriptor().

Referenced by CommandChangeValue::redo(), and CommandChangeValue::undo().

Here is the call graph for this function:

setInt()

void SampleEditorController::setInt	(	int	newValue,
		UIntDescriptor	d
	)

Definition at line 343 of file SampleEditorController.cpp.

{
    d.set(newValue);
    emit modified();
}

References modified(), and UIntDescriptor::set.

setIntegrateOverXi()

void SampleEditorController::setIntegrateOverXi	(	LatticeTypeSelectionForm *	widget,
		bool	newValue
	)

Definition at line 492 of file SampleEditorController.cpp.

{
    widget->interferenceItem()->setXiIntegration(newValue);
    widget->onIntegrateOverXiChanged();
    emit modified();
}

References LatticeTypeSelectionForm::interferenceItem(), modified(), LatticeTypeSelectionForm::onIntegrateOverXiChanged(), and Interference2DAbstractLatticeItem::setXiIntegration().

Referenced by LatticeTypeSelectionForm::createContent().

Here is the call graph for this function:

setMaterialValue()

void SampleEditorController::setMaterialValue	(	ItemWithMaterial *	item,
		double	newValue,
		DoubleDescriptor	d
	)

Definition at line 388 of file SampleEditorController.cpp.

{
    setDouble(newValue, d);
 
    // -- notify all other users of this material (update values in the UI)
    ASSERT(m_sampleForm);
    for (auto* c : m_sampleForm->findChildren<MaterialInplaceForm*>())
        if (c->itemWithMaterial() != item
            && c->itemWithMaterial()->materialIdentifier() == item->materialIdentifier())
            c->updateValues();
    emit modified();
}

References m_sampleForm, ItemWithMaterial::materialIdentifier(), modified(), and setDouble().

Referenced by MaterialInplaceForm::createWidgets().

Here is the call graph for this function:

setMesoCrystalBasis() [1/2]

void SampleEditorController::setMesoCrystalBasis	(	MesoCrystalForm *	widget,
		FormFactorItemCatalog::Type	type
	)

Definition at line 462 of file SampleEditorController.cpp.

{
    auto* meso = widget->mesoCrystalItem();
    meso->setBasis(createAndInitParticle(type));
    widget->createBasisWidgets();
    m_sampleForm->updateUnits();
    emit modified();
}

References createAndInitParticle(), MesoCrystalForm::createBasisWidgets(), m_sampleForm, MesoCrystalForm::mesoCrystalItem(), modified(), MesoCrystalItem::setBasis(), and MultiLayerForm::updateUnits().

Here is the call graph for this function:

setMesoCrystalBasis() [2/2]

void SampleEditorController::setMesoCrystalBasis	(	MesoCrystalForm *	widget,
		ItemWithParticlesCatalog::Type	type
	)

Definition at line 452 of file SampleEditorController.cpp.

{
    auto* meso = widget->mesoCrystalItem();
    meso->setBasis(createAndInitParticle(type));
    widget->createBasisWidgets();
    m_sampleForm->updateUnits();
    emit modified();
}

References createAndInitParticle(), MesoCrystalForm::createBasisWidgets(), m_sampleForm, MesoCrystalForm::mesoCrystalItem(), modified(), MesoCrystalItem::setBasis(), and MultiLayerForm::updateUnits().

Referenced by MesoCrystalForm::onBasisComboChanged().

Here is the call graph for this function:

setMultiLayerForm()

void SampleEditorController::setMultiLayerForm

(

MultiLayerForm *

view

)

Set the current form.

The form can change e.g. when a different sample gets the current one in the layer editor. Also nullptr is allowed.

Definition at line 48 of file SampleEditorController.cpp.

{
    m_sampleForm = view;
}

References m_sampleForm.

setSampleDescription()

void SampleEditorController::setSampleDescription

(

const QString &

description

)

Definition at line 446 of file SampleEditorController.cpp.

{
    m_sampleItem->setDescription(description);
    emit modified();
}

References m_sampleItem, modified(), and MultiLayerItem::setDescription().

Referenced by MultiLayerForm::MultiLayerForm().

Here is the call graph for this function:

setSampleName()

void SampleEditorController::setSampleName

(

const QString &

name

)

Definition at line 440 of file SampleEditorController.cpp.

{
    m_sampleItem->setSampleName(name);
    emit modified();
}

References m_sampleItem, modified(), GUI::RealSpace::Particles::name(), and MultiLayerItem::setSampleName().

Referenced by MultiLayerForm::MultiLayerForm().

Here is the call graph for this function:

setShellFormFactor()

void SampleEditorController::setShellFormFactor	(	ParticleCoreShellForm *	widget,
		FormFactorItemCatalog::Type	type
	)

Definition at line 271 of file SampleEditorController.cpp.

{
    auto* particleCoreShell = widget->coreShellItem();
 
    if (particleCoreShell->shell() == nullptr)
        particleCoreShell->createShell(materialItems());
 
    particleCoreShell->shell()->setFormFactor(FormFactorItemCatalog::create(type));
    widget->createShellWidgets();
    m_sampleForm->updateUnits();
    emit modified();
}

References ParticleCoreShellForm::coreShellItem(), FormFactorItemCatalog::create(), ParticleCoreShellItem::createShell(), ParticleCoreShellForm::createShellWidgets(), m_sampleForm, materialItems(), modified(), ParticleItem::setFormFactor(), and MultiLayerForm::updateUnits().

Referenced by ParticleCoreShellForm::onShellComboChanged().

Here is the call graph for this function:

undoStack()

QUndoStack * SampleEditorController::undoStack

(

)

The contained undo stack.

Definition at line 358 of file SampleEditorController.cpp.

{
    return &m_undoStack;
}

References m_undoStack.

Member Data Documentation

m_document

ProjectDocument* SampleEditorController::m_document

private

Definition at line 133 of file SampleEditorController.h.

Referenced by projectDocument().

m_sampleForm

MultiLayerForm* SampleEditorController::m_sampleForm

private

Definition at line 132 of file SampleEditorController.h.

Referenced by addLayerFromUndo(), addLayout(), addParticle(), onStartingToMoveLayer(), onStoppedToMoveLayer(), removeLayerFromUndo(), removeParticle(), sampleForm(), selectInterference(), selectMaterial(), setCoreFormFactor(), setCurrentIndex(), setDensityRelatedValue(), setDoubleFromUndo(), setMaterialValue(), setMesoCrystalBasis(), setMultiLayerForm(), and setShellFormFactor().

m_sampleItem

MultiLayerItem* SampleEditorController::m_sampleItem

private

Definition at line 131 of file SampleEditorController.h.

Referenced by addLayer(), addLayerFromUndo(), materialItems(), onStoppedToMoveLayer(), removeLayerFromUndo(), sampleItem(), setSampleDescription(), and setSampleName().

m_undoStack

QUndoStack SampleEditorController::m_undoStack

private

Definition at line 130 of file SampleEditorController.h.

Referenced by addLayer(), removeLayer(), setDouble(), and undoStack().

---

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

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