ParticleCoreShellItem Class Reference

Description

Definition at line 25 of file ParticleCoreShellItem.h.

Inheritance diagram for ParticleCoreShellItem:

Collaboration diagram for ParticleCoreShellItem:

Public Member Functions
	ParticleCoreShellItem (const MaterialItems *materials)
DoubleDescriptor	abundance () const
void	clearCore ()
void	clearShell ()
QVector< ItemWithParticles * >	containedItemsWithParticles () const override
	Return full hierarchical contained items with particles. More...
ParticleItem *	core () const
ParticleItem *	createCore (const MaterialItems *materials)
std::unique_ptr< ParticleCoreShell >	createParticleCoreShell () const
std::unique_ptr< IRotation >	createRotation () const
	nullptr only if "no rotation". Can contain identity! More...
ParticleItem *	createShell (const MaterialItems *materials)
R3	position () const
VectorDescriptor	positionVector () const
SelectionDescriptor< RotationItem * >	rotation ()
	Returns selection descriptor for rotation methods. More...
void	serialize (Streamer &s) override
void	setAbundance (double abundance)
void	setPosition (const R3 &position)
void	setRotation (RotationItem *p)
	nullptr is allowed and sets to "no rotation" More...
ParticleItem *	shell () const

Protected Attributes
DoubleProperty	m_abundance
VectorProperty	m_position
SelectionProperty< RotationItem * >	m_rotation

Private Attributes
std::unique_ptr< ParticleItem >	m_core
const MaterialItems *	m_materials
std::unique_ptr< ParticleItem >	m_shell

Constructor & Destructor Documentation

ParticleCoreShellItem()

ParticleCoreShellItem::ParticleCoreShellItem

(

const MaterialItems *

materials

)

Definition at line 35 of file ParticleCoreShellItem.cpp.

    : ItemWithParticles(abundance_tooltip, position_tooltip)
    , m_materials(materials)
{
}

Member Function Documentation

abundance()

DoubleDescriptor ItemWithParticles::abundance ( ) const

inherited

Definition at line 32 of file ItemWithParticles.cpp.

{
    return m_abundance;
}

References ItemWithParticles::m_abundance.

Referenced by MesoCrystalForm::MesoCrystalForm(), ParticleCompositionForm::ParticleCompositionForm(), ParticleCoreShellForm::ParticleCoreShellForm(), ParticleForm::ParticleForm(), ParameterTreeBuilder::addParticle(), ParticleItem::createParticle(), ParticleCompositionItem::createParticleComposition(), createParticleCoreShell(), and ItemWithParticles::setAbundance().

clearCore()

void ParticleCoreShellItem::clearCore

(

)

Definition at line 75 of file ParticleCoreShellItem.cpp.

{
    m_core.reset();
}

References m_core.

clearShell()

void ParticleCoreShellItem::clearShell

(

)

Definition at line 92 of file ParticleCoreShellItem.cpp.

{
    m_shell.reset();
}

References m_shell.

containedItemsWithParticles()

QVector< ItemWithParticles * > ParticleCoreShellItem::containedItemsWithParticles ( ) const

overridevirtual

Return full hierarchical contained items with particles.

For example ParticleCompositionItem contains other items, ParticleItem doesn't.

Implements ItemWithParticles.

Definition at line 107 of file ParticleCoreShellItem.cpp.

{
    QVector<ItemWithParticles*> result;
    if (core())
        result << core() << core()->containedItemsWithParticles();
    if (shell())
        result << shell() << shell()->containedItemsWithParticles();
    return result;
}

References ParticleItem::containedItemsWithParticles(), core(), and shell().

Here is the call graph for this function:

core()

ParticleItem * ParticleCoreShellItem::core

(

)

const

Definition at line 70 of file ParticleCoreShellItem.cpp.

{
    return m_core.get();
}

References m_core.

Referenced by ParticleCoreShellForm::ParticleCoreShellForm(), containedItemsWithParticles(), ParticleCoreShellForm::createCoreWidgets(), and ParticleCoreShellForm::showCoreInRealSpace().

createCore()

ParticleItem * ParticleCoreShellItem::createCore

(

const MaterialItems *

materials

)

Definition at line 80 of file ParticleCoreShellItem.cpp.

{
    m_core.reset(new ParticleItem(materials));
    m_core->setMaterial(materials->defaultMaterial());
    return m_core.get();
}

References MaterialItems::defaultMaterial(), and m_core.

Referenced by SampleEditorController::setCoreFormFactor().

Here is the call graph for this function:

createParticleCoreShell()

std::unique_ptr< ParticleCoreShell > ParticleCoreShellItem::createParticleCoreShell

(

)

const

Definition at line 50 of file ParticleCoreShellItem.cpp.

{
    std::unique_ptr<Particle> P_core{};
    std::unique_ptr<Particle> P_shell{};
    if (m_core)
        P_core = m_core->createParticle();
    if (m_shell)
        P_shell = m_shell->createParticle();
    if (!P_core || !P_shell)
        throw 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());
    P_coreshell->setParticlePosition(position());
    if (auto r = createRotation(); r && !r->isIdentity())
        P_coreshell->setRotation(*r);
 
    return P_coreshell;
}

References ItemWithParticles::abundance(), ItemWithParticles::createRotation(), Error, m_core, m_shell, and ItemWithParticles::position().

Here is the call graph for this function:

createRotation()

std::unique_ptr< IRotation > ItemWithParticles::createRotation ( ) const

inherited

nullptr only if "no rotation". Can contain identity!

Definition at line 67 of file ItemWithParticles.cpp.

{
    if (!m_rotation.get())
        return {};
    const auto matrix = m_rotation->rotation();
    return std::unique_ptr<IRotation>(IRotation::createRotation(matrix));
}

References SelectionProperty< T >::get(), ItemWithParticles::m_rotation, and RotationItem::rotation().

Referenced by MesoCrystalItem::createMesoCrystal(), ParticleItem::createParticle(), ParticleCompositionItem::createParticleComposition(), and createParticleCoreShell().

Here is the call graph for this function:

createShell()

ParticleItem * ParticleCoreShellItem::createShell

(

const MaterialItems *

materials

)

Definition at line 97 of file ParticleCoreShellItem.cpp.

{
    m_shell.reset(new ParticleItem(materials));
    m_shell->setMaterial(materials->defaultMaterial());
 
    // position is not used for shell item
    m_shell->setPosition({});
    return m_shell.get();
}

References MaterialItems::defaultMaterial(), and m_shell.

Referenced by SampleEditorController::setShellFormFactor().

Here is the call graph for this function:

position()

R3 ItemWithParticles::position ( ) const

inherited

Definition at line 42 of file ItemWithParticles.cpp.

{
    return m_position;
}

References ItemWithParticles::m_position.

Referenced by MesoCrystalItem::createMesoCrystal(), ParticleItem::createParticle(), ParticleCompositionItem::createParticleComposition(), createParticleCoreShell(), and ItemWithParticles::setPosition().

positionVector()

VectorDescriptor ItemWithParticles::positionVector ( ) const

inherited

Definition at line 52 of file ItemWithParticles.cpp.

{
    return m_position;
}

References ItemWithParticles::m_position.

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

rotation()

SelectionDescriptor< RotationItem * > ItemWithParticles::rotation ( )

inherited

Returns selection descriptor for rotation methods.

Definition at line 57 of file ItemWithParticles.cpp.

{
    return m_rotation;
}

References ItemWithParticles::m_rotation.

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

serialize()

void ParticleCoreShellItem::serialize ( Streamer &  s )

overridevirtual

Implements ItemWithParticles.

Definition at line 41 of file ParticleCoreShellItem.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_abundance);
    Serialize::rwProperty(s, m_position);
    Serialize::rwOptional(s, "core", m_core, m_materials);
    Serialize::rwOptional(s, "shell", m_shell, m_materials);
}

References Streamer::assertVersion(), ItemWithParticles::m_abundance, m_core, m_materials, ItemWithParticles::m_position, m_shell, Serialize::rwOptional(), and Serialize::rwProperty().

Here is the call graph for this function:

setAbundance()

void ItemWithParticles::setAbundance ( double  abundance )

inherited

Definition at line 37 of file ItemWithParticles.cpp.

{
    m_abundance.set(abundance);
}

References ItemWithParticles::abundance(), ItemWithParticles::m_abundance, and DoubleProperty::set().

Here is the call graph for this function:

setPosition()

void ItemWithParticles::setPosition ( const R3 &  position )

inherited

Definition at line 47 of file ItemWithParticles.cpp.

{
    m_position.set(position);
}

References ItemWithParticles::m_position, ItemWithParticles::position(), and VectorProperty::set().

Here is the call graph for this function:

setRotation()

void ItemWithParticles::setRotation ( RotationItem *  p )

inherited

nullptr is allowed and sets to "no rotation"

Definition at line 62 of file ItemWithParticles.cpp.

{
    m_rotation.set(p);
}

References ItemWithParticles::m_rotation, and SelectionProperty< T >::set().

Here is the call graph for this function:

shell()

ParticleItem * ParticleCoreShellItem::shell

(

)

const

Definition at line 87 of file ParticleCoreShellItem.cpp.

{
    return m_shell.get();
}

References m_shell.

Referenced by ParticleCoreShellForm::ParticleCoreShellForm(), containedItemsWithParticles(), ParticleCoreShellForm::createShellWidgets(), and ParticleCoreShellForm::showShellInRealSpace().

Member Data Documentation

m_abundance

DoubleProperty ItemWithParticles::m_abundance

protectedinherited

Definition at line 56 of file ItemWithParticles.h.

Referenced by ItemWithParticles::ItemWithParticles(), ItemWithParticles::abundance(), MesoCrystalItem::serialize(), ParticleCompositionItem::serialize(), serialize(), ParticleItem::serialize(), and ItemWithParticles::setAbundance().

m_core

std::unique_ptr<ParticleItem> ParticleCoreShellItem::m_core

private

Definition at line 43 of file ParticleCoreShellItem.h.

Referenced by clearCore(), core(), createCore(), createParticleCoreShell(), and serialize().

m_materials

const MaterialItems* ParticleCoreShellItem::m_materials

private

Definition at line 45 of file ParticleCoreShellItem.h.

Referenced by serialize().

m_position

VectorProperty ItemWithParticles::m_position

protectedinherited

Definition at line 57 of file ItemWithParticles.h.

Referenced by ItemWithParticles::ItemWithParticles(), ItemWithParticles::position(), ItemWithParticles::positionVector(), MesoCrystalItem::serialize(), ParticleCompositionItem::serialize(), serialize(), ParticleItem::serialize(), and ItemWithParticles::setPosition().

m_rotation

SelectionProperty<RotationItem*> ItemWithParticles::m_rotation

protectedinherited

Definition at line 58 of file ItemWithParticles.h.

Referenced by ItemWithParticles::ItemWithParticles(), ItemWithParticles::createRotation(), ItemWithParticles::rotation(), MesoCrystalItem::serialize(), ParticleCompositionItem::serialize(), ParticleItem::serialize(), and ItemWithParticles::setRotation().

m_shell

std::unique_ptr<ParticleItem> ParticleCoreShellItem::m_shell

private

Definition at line 44 of file ParticleCoreShellItem.h.

Referenced by clearShell(), createParticleCoreShell(), createShell(), serialize(), and shell().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/ParticleCoreShellItem.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/ParticleCoreShellItem.cpp