MaterialEditorDialog Class Reference

Description

Dialog to select a material and also to edit the list of existing materials. The dialog operates on a copy of the current materials. The original material store is only updated if changes have been made and the dialog has been closed with OK. Use this dialog only with the two static methods to edit the list, or to choose a material.

Definition at line 35 of file MaterialEditorDialog.h.

Inheritance diagram for MaterialEditorDialog:

Collaboration diagram for MaterialEditorDialog:

Static Public Member Functions
static QString	chooseMaterial (QWidget *parent, MultiLayerItem *sample, const QString &identifierOfPreviousMaterial)
	Use this to choose a material. identifierOfPreviousMaterial is the material which should be selected when opening the dialog. Returns the identifier of the newly selected material. Returns an empty string, if the dialog is cancelled. More...
static void	editMaterials (QWidget *parent, MultiLayerItem *sample)
	Use this to edit the list of existing materials. More...

Private Member Functions
	MaterialEditorDialog (MultiLayerItem *sample, QWidget *parent=nullptr)
	~MaterialEditorDialog () override
void	accept () override
	updates original material model with the edited model More...
void	addRefractiveMaterial ()
void	addSldMaterial ()
void	cloneCurrentMaterial ()
QModelIndex	currentIndex () const
MaterialItem *	currentMaterial ()
void	fill ()
QStringList	identifiersOfUsedMaterials () const
	Returns the list of material identifiers of the materials currently used in the sample. E.g. the material selected in a particle. More...
void	onSelectColor ()
void	removeCurrentMaterial ()
void	setCurrentMaterial (const MaterialItem *m)
void	setCurrentMaterial (const QString &identifier)
void	updateActionEnabling ()

Private Attributes
QAction *	m_cloneMaterialAction
	Materials for working within this dialog. More...
MaterialEditorModel *	m_model
QAction *	m_removeMaterialAction
MultiLayerItem *	m_sample
	Model for the left list. Works on m_tmpMaterialItems. More...
MaterialItems	m_tmpMaterialItems
Ui::MaterialEditorDialog *	m_ui

Constructor & Destructor Documentation

MaterialEditorDialog()

MaterialEditorDialog::MaterialEditorDialog ( MultiLayerItem *  sample, QWidget *  parent = nullptr  )

private

Definition at line 35 of file MaterialEditorDialog.cpp.

    : QDialog(parent)
    , m_ui(new Ui::MaterialEditorDialog)
    , m_sample(sample)
{
    m_tmpMaterialItems.initFrom(m_sample->materialItems());
 
    m_model = new MaterialEditorModel(&m_tmpMaterialItems);
 
    m_ui->setupUi(this);
 
    using GUI::View::EditUtil::configScientificDoubleEdit;
    configScientificDoubleEdit(m_ui->deltaEdit, RealLimits::limitless());
    configScientificDoubleEdit(m_ui->betaEdit, RealLimits::limitless());
    configScientificDoubleEdit(m_ui->realEdit, RealLimits::limitless());
    configScientificDoubleEdit(m_ui->imaginaryEdit, RealLimits::limitless());
 
    using GUI::View::EditUtil::configSpinbox;
    configSpinbox(m_ui->xSpinBox, 3, RealLimits::limitless());
    configSpinbox(m_ui->ySpinBox, 3, RealLimits::limitless());
    configSpinbox(m_ui->zSpinBox, 3, RealLimits::limitless());
 
    auto* addRefractiveMaterialAction = new QAction("Add material (refractive index)", parent);
    addRefractiveMaterialAction->setIcon(QIcon(":/images/shape-square-plus.svg"));
    addRefractiveMaterialAction->setToolTip("Add new material");
    connect(addRefractiveMaterialAction, &QAction::triggered, this,
            &MaterialEditorDialog::addRefractiveMaterial);
 
    auto* addSldMaterialAction = new QAction("Add material (SLD)", parent);
    addSldMaterialAction->setIcon(QIcon(":/images/shape-square-plus.svg"));
    addSldMaterialAction->setToolTip("Add new material");
    connect(addSldMaterialAction, &QAction::triggered, this, &MaterialEditorDialog::addSldMaterial);
 
    m_cloneMaterialAction = new QAction("Copy", parent);
    m_cloneMaterialAction->setIcon(QIcon(":/images/content-copy.svg"));
    m_cloneMaterialAction->setToolTip("Copy selected material");
    connect(m_cloneMaterialAction, &QAction::triggered, this,
            &MaterialEditorDialog::cloneCurrentMaterial);
 
    m_removeMaterialAction = new QAction("Remove", parent);
    m_removeMaterialAction->setIcon(QIcon(":/images/delete.svg"));
    m_removeMaterialAction->setToolTip("Remove selected material");
    connect(m_removeMaterialAction, &QAction::triggered, this,
            &MaterialEditorDialog::removeCurrentMaterial);
 
    m_ui->treeView->addAction(addRefractiveMaterialAction);
    m_ui->treeView->addAction(addSldMaterialAction);
    m_ui->treeView->addAction(m_cloneMaterialAction);
    auto* separator = new QAction(this);
    separator->setSeparator(true);
    m_ui->treeView->addAction(separator);
    m_ui->treeView->addAction(m_removeMaterialAction);
    m_ui->treeView->setModel(m_model);
    m_ui->treeView->header()->setSectionResizeMode(QHeaderView::ResizeToContents);
 
    auto* toolbar = new QToolBar(this);
    toolbar->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
    toolbar->addAction(addRefractiveMaterialAction);
    toolbar->addAction(addSldMaterialAction);
    toolbar->addAction(m_cloneMaterialAction);
    toolbar->addAction(m_removeMaterialAction);
    m_ui->mainLayout->insertWidget(0, toolbar);
 
    GUI::Util::Style::setResizable(this);
    appSettings->loadWindowSizeAndPos(this);
 
    connect(m_ui->treeView->selectionModel(), &QItemSelectionModel::currentChanged, this,
            &MaterialEditorDialog::fill);
 
    connect(m_ui->treeView->selectionModel(), &QItemSelectionModel::currentChanged, this,
            &MaterialEditorDialog::updateActionEnabling);
 
    connect(m_ui->selectColorButton, &QPushButton::clicked, this,
            &MaterialEditorDialog::onSelectColor);
 
    connect(m_ui->nameEdit, &QLineEdit::textEdited,
            [&](const QString& t) { m_model->setMaterialItemName(currentIndex(), t); });
 
    connect(m_ui->xSpinBox, qOverload<double>(&QDoubleSpinBox::valueChanged),
            [&](double value) { m_model->setX(currentIndex(), value); });
 
    connect(m_ui->ySpinBox, qOverload<double>(&QDoubleSpinBox::valueChanged),
            [&](double value) { m_model->setY(currentIndex(), value); });
 
    connect(m_ui->zSpinBox, qOverload<double>(&QDoubleSpinBox::valueChanged),
            [&](double value) { m_model->setZ(currentIndex(), value); });
 
    connect(m_ui->deltaEdit, &QLineEdit::editingFinished,
            [&]() { m_model->setDelta(currentIndex(), m_ui->deltaEdit->text().toDouble()); });
 
    connect(m_ui->betaEdit, &QLineEdit::editingFinished,
            [&]() { m_model->setBeta(currentIndex(), m_ui->betaEdit->text().toDouble()); });
 
    connect(m_ui->realEdit, &QLineEdit::editingFinished,
            [&]() { m_model->setRe(currentIndex(), m_ui->realEdit->text().toDouble()); });
 
    connect(m_ui->imaginaryEdit, &QLineEdit::editingFinished,
            [&]() { m_model->setIm(currentIndex(), m_ui->imaginaryEdit->text().toDouble()); });
 
 
    if (m_model->rowCount() > 0)
        m_ui->treeView->setCurrentIndex(m_model->first());
    else {
        m_ui->sldGroupBox->hide();
        m_ui->propertiesWidget->setEnabled(false);
    }
}

References addRefractiveMaterial(), addSldMaterial(), appSettings, cloneCurrentMaterial(), GUI::View::EditUtil::configScientificDoubleEdit(), GUI::View::EditUtil::configSpinbox(), fill(), MaterialEditorModel::first(), MaterialItems::initFrom(), ApplicationSettings::loadWindowSizeAndPos(), m_cloneMaterialAction, m_model, m_removeMaterialAction, m_sample, m_tmpMaterialItems, m_ui, MultiLayerItem::materialItems(), onSelectColor(), removeCurrentMaterial(), MaterialEditorModel::rowCount(), GUI::Util::Style::setResizable(), and updateActionEnabling().

Here is the call graph for this function:

~MaterialEditorDialog()

MaterialEditorDialog::~MaterialEditorDialog ( )

overrideprivate

Definition at line 143 of file MaterialEditorDialog.cpp.

{
    appSettings->saveWindowSizeAndPos(this);
}

References appSettings, and ApplicationSettings::saveWindowSizeAndPos().

Here is the call graph for this function:

Member Function Documentation

accept()

void MaterialEditorDialog::accept ( )

overrideprivate

updates original material model with the edited model

Definition at line 148 of file MaterialEditorDialog.cpp.

{
    m_sample->materialItems().initFrom(m_tmpMaterialItems);
    QDialog::accept();
}

References MaterialItems::initFrom(), m_sample, m_tmpMaterialItems, and MultiLayerItem::materialItems().

Here is the call graph for this function:

addRefractiveMaterial()

void MaterialEditorDialog::addRefractiveMaterial ( )

private

Definition at line 172 of file MaterialEditorDialog.cpp.

{
    setCurrentMaterial(m_model->addRefractiveMaterial("unnamed", 0.0, 0.0));
}

References MaterialEditorModel::addRefractiveMaterial(), m_model, and setCurrentMaterial().

Referenced by MaterialEditorDialog().

Here is the call graph for this function:

addSldMaterial()

void MaterialEditorDialog::addSldMaterial ( )

private

Definition at line 177 of file MaterialEditorDialog.cpp.

{
    setCurrentMaterial(m_model->addSLDMaterial("unnamed", 0.0, 0.0));
}

References MaterialEditorModel::addSLDMaterial(), m_model, and setCurrentMaterial().

Referenced by MaterialEditorDialog().

Here is the call graph for this function:

chooseMaterial()

QString MaterialEditorDialog::chooseMaterial ( QWidget *  parent, MultiLayerItem *  sample, const QString &  identifierOfPreviousMaterial  )

static

Use this to choose a material. identifierOfPreviousMaterial is the material which should be selected when opening the dialog. Returns the identifier of the newly selected material. Returns an empty string, if the dialog is cancelled.

Definition at line 154 of file MaterialEditorDialog.cpp.

{
    MaterialEditorDialog dialog(sample, parent);
    dialog.setCurrentMaterial(identifierOfPreviousMaterial);
    if (dialog.exec() == QDialog::Accepted)
        if (MaterialItem* material = dialog.currentMaterial())
            return material->identifier();
 
    return QString();
}

References currentMaterial(), and setCurrentMaterial().

Referenced by MaterialInplaceForm::selectMaterial().

Here is the call graph for this function:

cloneCurrentMaterial()

void MaterialEditorDialog::cloneCurrentMaterial ( )

private

Definition at line 182 of file MaterialEditorDialog.cpp.

{
    if (currentIndex().isValid())
        setCurrentMaterial(m_model->cloneMaterial(currentIndex()));
}

References MaterialEditorModel::cloneMaterial(), currentIndex(), m_model, and setCurrentMaterial().

Referenced by MaterialEditorDialog().

Here is the call graph for this function:

currentIndex()

QModelIndex MaterialEditorDialog::currentIndex ( ) const

private

Definition at line 273 of file MaterialEditorDialog.cpp.

{
    return m_ui->treeView->currentIndex();
}

References m_ui.

Referenced by cloneCurrentMaterial(), currentMaterial(), onSelectColor(), removeCurrentMaterial(), and updateActionEnabling().

currentMaterial()

MaterialItem * MaterialEditorDialog::currentMaterial ( )

private

Definition at line 217 of file MaterialEditorDialog.cpp.

{
    return currentIndex().isValid() ? m_model->materialFromIndex(currentIndex()) : nullptr;
}

References currentIndex(), m_model, and MaterialEditorModel::materialFromIndex().

Referenced by chooseMaterial(), fill(), onSelectColor(), and removeCurrentMaterial().

Here is the call graph for this function:

editMaterials()

void MaterialEditorDialog::editMaterials ( QWidget *  parent, MultiLayerItem *  sample  )

static

Use this to edit the list of existing materials.

Definition at line 166 of file MaterialEditorDialog.cpp.

{
    MaterialEditorDialog dialog(sample, parent);
    dialog.exec();
}

fill()

void MaterialEditorDialog::fill ( )

private

Definition at line 222 of file MaterialEditorDialog.cpp.

{
    auto* materialItem = currentMaterial();
 
    m_ui->propertiesWidget->setEnabled(materialItem != nullptr);
    if (materialItem == nullptr) {
        m_ui->refractiveGroupBox->show();
        m_ui->sldGroupBox->hide();
        for (auto* lineEdit : m_ui->propertiesWidget->findChildren<QLineEdit*>())
            lineEdit->clear();
        for (auto* spinBox : m_ui->propertiesWidget->findChildren<QDoubleSpinBox*>())
            spinBox->clear();
        return;
    }
 
    m_ui->refractiveGroupBox->setVisible(materialItem->hasRefractiveIndex());
    m_ui->sldGroupBox->setVisible(!materialItem->hasRefractiveIndex());
 
    m_ui->nameEdit->setText(materialItem->matItemName());
    m_ui->colorInfo->setText(QString("[%1, %2, %3] (%4)")
                                 .arg(materialItem->color().red())
                                 .arg(materialItem->color().green())
                                 .arg(materialItem->color().blue())
                                 .arg(materialItem->color().alpha()));
    QPixmap pixmap(m_ui->selectColorButton->iconSize());
    pixmap.fill(materialItem->color());
    m_ui->selectColorButton->setIcon(pixmap);
 
    if (materialItem->hasRefractiveIndex()) {
        m_ui->deltaEdit->setText(QString::number(materialItem->delta().get(), 'g'));
        m_ui->betaEdit->setText(QString::number(materialItem->beta().get(), 'g'));
    } else {
        m_ui->realEdit->setText(QString::number(materialItem->sldRe().get(), 'g'));
        m_ui->imaginaryEdit->setText(QString::number(materialItem->sldIm().get(), 'g'));
    }
 
    m_ui->xSpinBox->setValue(materialItem->magnetization().x());
    m_ui->ySpinBox->setValue(materialItem->magnetization().y());
    m_ui->zSpinBox->setValue(materialItem->magnetization().z());
}

References currentMaterial(), and m_ui.

Referenced by MaterialEditorDialog(), and onSelectColor().

Here is the call graph for this function:

identifiersOfUsedMaterials()

QStringList MaterialEditorDialog::identifiersOfUsedMaterials ( ) const

private

Returns the list of material identifiers of the materials currently used in the sample. E.g. the material selected in a particle.

Definition at line 278 of file MaterialEditorDialog.cpp.

{
    QStringList result;
    for (auto* p : m_sample->itemsWithMaterial())
        result << p->materialIdentifier();
    return result;
}

References MultiLayerItem::itemsWithMaterial(), and m_sample.

Referenced by removeCurrentMaterial().

Here is the call graph for this function:

onSelectColor()

void MaterialEditorDialog::onSelectColor ( )

private

Definition at line 203 of file MaterialEditorDialog.cpp.

{
    if (auto newColor = QColorDialog::getColor(currentMaterial()->color()); newColor.isValid())
        m_model->setColor(currentIndex(), newColor);
 
    fill();
}

References currentIndex(), currentMaterial(), fill(), m_model, and MaterialEditorModel::setColor().

Referenced by MaterialEditorDialog().

Here is the call graph for this function:

removeCurrentMaterial()

void MaterialEditorDialog::removeCurrentMaterial ( )

private

Definition at line 188 of file MaterialEditorDialog.cpp.

{
    MaterialItem* material = currentMaterial();
    if (material == nullptr)
        return;
 
    if (identifiersOfUsedMaterials().contains(material->identifier())) {
        QMessageBox::warning(this, "Remove material",
                             "This material can't be removed - it is used in the current sample.");
        return;
    }
 
    m_model->removeMaterial(currentIndex());
}

References currentIndex(), currentMaterial(), MaterialItem::identifier(), identifiersOfUsedMaterials(), m_model, MaterialEditorModel::removeMaterial(), and GUI::View::Helpers::warning().

Referenced by MaterialEditorDialog().

Here is the call graph for this function:

setCurrentMaterial() [1/2]

void MaterialEditorDialog::setCurrentMaterial ( const MaterialItem *  m )

private

Definition at line 263 of file MaterialEditorDialog.cpp.

{
    m_ui->treeView->setCurrentIndex(m_model->indexFromMaterial(m));
}

References MaterialEditorModel::indexFromMaterial(), m_model, and m_ui.

Referenced by addRefractiveMaterial(), addSldMaterial(), chooseMaterial(), and cloneCurrentMaterial().

Here is the call graph for this function:

setCurrentMaterial() [2/2]

void MaterialEditorDialog::setCurrentMaterial ( const QString &  identifier )

private

Definition at line 268 of file MaterialEditorDialog.cpp.

{
    m_ui->treeView->setCurrentIndex(m_model->indexFromMaterial(identifier));
}

References MaterialEditorModel::indexFromMaterial(), m_model, and m_ui.

Here is the call graph for this function:

updateActionEnabling()

void MaterialEditorDialog::updateActionEnabling ( )

private

Definition at line 211 of file MaterialEditorDialog.cpp.

{
    m_removeMaterialAction->setEnabled(currentIndex().isValid());
    m_cloneMaterialAction->setEnabled(currentIndex().isValid());
}

References currentIndex(), m_cloneMaterialAction, and m_removeMaterialAction.

Referenced by MaterialEditorDialog().

Here is the call graph for this function:

Member Data Documentation

m_cloneMaterialAction

QAction* MaterialEditorDialog::m_cloneMaterialAction

private

Materials for working within this dialog.

Definition at line 76 of file MaterialEditorDialog.h.

Referenced by MaterialEditorDialog(), and updateActionEnabling().

m_model

MaterialEditorModel* MaterialEditorDialog::m_model

private

Definition at line 81 of file MaterialEditorDialog.h.

Referenced by MaterialEditorDialog(), addRefractiveMaterial(), addSldMaterial(), cloneCurrentMaterial(), currentMaterial(), onSelectColor(), removeCurrentMaterial(), and setCurrentMaterial().

m_removeMaterialAction

QAction* MaterialEditorDialog::m_removeMaterialAction

private

Definition at line 77 of file MaterialEditorDialog.h.

Referenced by MaterialEditorDialog(), and updateActionEnabling().

m_sample

MultiLayerItem* MaterialEditorDialog::m_sample

private

Model for the left list. Works on m_tmpMaterialItems.

Definition at line 82 of file MaterialEditorDialog.h.

Referenced by MaterialEditorDialog(), accept(), and identifiersOfUsedMaterials().

m_tmpMaterialItems

MaterialItems MaterialEditorDialog::m_tmpMaterialItems

private

Definition at line 74 of file MaterialEditorDialog.h.

Referenced by MaterialEditorDialog(), and accept().

m_ui

Ui::MaterialEditorDialog* MaterialEditorDialog::m_ui

private

Definition at line 79 of file MaterialEditorDialog.h.

Referenced by MaterialEditorDialog(), currentIndex(), fill(), and setCurrentMaterial().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/MaterialEditor/MaterialEditorDialog.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/MaterialEditor/MaterialEditorDialog.cpp