ParticleCoreShellItem.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/coregui/Models/ParticleCoreShellItem.cpp
//! @brief     Implements class ParticleCoreShellItem
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#include "GUI/coregui/Models/ParticleCoreShellItem.h"
#include "GUI/coregui/Models/ModelPath.h"
#include "GUI/coregui/Models/ParticleItem.h"
#include "GUI/coregui/Models/SessionItemUtils.h"
#include "GUI/coregui/Models/TransformToDomain.h"
#include "GUI/coregui/utils/GUIHelpers.h"
#include "Sample/Particle/Particle.h"
#include "GUI/coregui/Models/VectorItem.h"
#include "Sample/Particle/ParticleCoreShell.h"
 
namespace {
const QString abundance_tooltip = "Proportion of this type of particles normalized to the \n"
                                  "total number of particles in the layout";
 
const QString position_tooltip = "Relative position of the particle's reference point \n"
                                 "in the coordinate system of the parent (nm)";
 
} // namespace
 
const QString ParticleCoreShellItem::T_CORE = "Core tag";
const QString ParticleCoreShellItem::T_SHELL = "Shell tag";
 
// TODO make ParticleCoreShellItem and ParticleItem to derive from common base.
 
ParticleCoreShellItem::ParticleCoreShellItem() : SessionGraphicsItem("ParticleCoreShell")
{
    setToolTip("A particle with a core/shell geometry");
 
    addProperty(ParticleItem::P_ABUNDANCE, 1.0)
        ->setLimits(RealLimits::limited(0.0, 1.0))
        .setDecimals(3)
        .setToolTip(abundance_tooltip);
 
    addProperty<VectorItem>(ParticleItem::P_POSITION)->setToolTip(position_tooltip);
 
    registerTag(T_CORE, 0, 1, QStringList() << "Particle");
    registerTag(T_SHELL, 0, 1, QStringList() << "Particle");
    registerTag(ParticleItem::T_TRANSFORMATION, 0, 1, QStringList() << "Rotation");
 
    addTranslator(VectorParameterTranslator(ParticleItem::P_POSITION, "Position"));
    addTranslator(RotationTranslator());
 
    mapper()->setOnParentChange([this](SessionItem* parent) {
        if (SessionItemUtils::HasOwnAbundance(parent)) {
            setItemValue(ParticleItem::P_ABUNDANCE, 1.0);
            getItem(ParticleItem::P_ABUNDANCE)->setEnabled(false);
        } else {
            getItem(ParticleItem::P_ABUNDANCE)->setEnabled(true);
        }
    });
}
 
VectorItem* ParticleCoreShellItem::positionItem() const
{
    return item<VectorItem>(ParticleItem::P_POSITION);
}
 
std::unique_ptr<ParticleCoreShell> ParticleCoreShellItem::createParticleCoreShell() const
{
    double abundance = getItemValue(ParticleItem::P_ABUNDANCE).toDouble();
    std::unique_ptr<Particle> P_core{};
    std::unique_ptr<Particle> P_shell{};
    auto core_item = dynamic_cast<ParticleItem*>(getItem(T_CORE));
    if (core_item)
        P_core = core_item->createParticle();
    auto shell_item = dynamic_cast<ParticleItem*>(getItem(T_SHELL));
    if (shell_item)
        P_shell = shell_item->createParticle();
    if (!P_core || !P_shell)
        throw GUIHelpers::Error("ParticleCoreShellItem::createParticleCoreShell -> Error. Either "
                                "core or shell particle is undefined.");
    auto P_coreshell = std::make_unique<ParticleCoreShell>(*P_shell, *P_core);
    P_coreshell->setAbundance(abundance);
    TransformToDomain::setTransformationInfo(P_coreshell.get(), *this);
    return P_coreshell;
}
 
QVector<SessionItem*> ParticleCoreShellItem::materialPropertyItems()
{
    QVector<SessionItem*> result;
    if (auto core = static_cast<ParticleItem*>(getItem(T_CORE)))
        result.append(core->materialPropertyItems());
 
    if (auto shell = static_cast<ParticleItem*>(getItem(T_SHELL)))
        result.append(shell->materialPropertyItems());
 
    return result;
}