ParticleCompositionItem Class Reference

Description

Definition at line 24 of file ParticleCompositionItem.h.

Inheritance diagram for ParticleCompositionItem:

Collaboration diagram for ParticleCompositionItem:

Public Member Functions
	ParticleCompositionItem (const MaterialItems *materials)
DoubleDescriptor	abundance () const
void	addParticle (ItemWithParticles *particle)
QVector< ItemWithParticles * >	containedItemsWithParticles () const override
	Return full hierarchical contained items with particles. More...
std::unique_ptr< ParticleComposition >	createParticleComposition () const
std::unique_ptr< IRotation >	createRotation () const
	nullptr only if "no rotation". Can contain identity! More...
QVector< ItemWithParticles * >	particles () const
R3	position () const
VectorDescriptor	positionVector () const
void	removeParticle (ItemWithParticles *particle)
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...

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

Private Attributes
const MaterialItems *	m_materials
QVector< ItemWithParticles * >	m_particles

Constructor & Destructor Documentation

ParticleCompositionItem()

ParticleCompositionItem::ParticleCompositionItem

(

const MaterialItems *

materials

)

Definition at line 38 of file ParticleCompositionItem.cpp.

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

References m_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(), createParticleComposition(), ParticleCoreShellItem::createParticleCoreShell(), and ItemWithParticles::setAbundance().

addParticle()

void ParticleCompositionItem::addParticle

(

ItemWithParticles *

particle

)

Definition at line 86 of file ParticleCompositionItem.cpp.

{
    m_particles << particle;
}

References m_particles.

Referenced by SampleEditorController::addParticle().

containedItemsWithParticles()

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

overridevirtual

Return full hierarchical contained items with particles.

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

Implements ItemWithParticles.

Definition at line 97 of file ParticleCompositionItem.cpp.

{
    QVector<ItemWithParticles*> result;
    for (auto* particle : m_particles)
        result << particle << particle->containedItemsWithParticles();
    return result;
}

References m_particles.

createParticleComposition()

std::unique_ptr< ParticleComposition > ParticleCompositionItem::createParticleComposition

(

)

const

Definition at line 54 of file ParticleCompositionItem.cpp.

{
    auto P_composition = std::make_unique<ParticleComposition>();
    P_composition->setAbundance(abundance());
    for (auto* p : m_particles) {
        if (auto* particleItem = dynamic_cast<ParticleItem*>(p)) {
            if (auto P_particle = particleItem->createParticle())
                P_composition->addParticle(*P_particle);
        } else if (auto* coreShellItem = dynamic_cast<ParticleCoreShellItem*>(p)) {
            if (auto P_particle_coreshell = coreShellItem->createParticleCoreShell())
                P_composition->addParticle(*P_particle_coreshell);
        } else if (auto* compositionItem = dynamic_cast<ParticleCompositionItem*>(p)) {
            if (auto P_child_composition = compositionItem->createParticleComposition())
                P_composition->addParticle(*P_child_composition);
        } else if (auto* mesoCrystalItem = dynamic_cast<MesoCrystalItem*>(p)) {
            if (auto P_meso = mesoCrystalItem->createMesoCrystal())
                P_composition->addParticle(*P_meso);
        }
    }
 
    P_composition->setParticlePosition(position());
    if (const auto r = createRotation(); r && !r->isIdentity())
        P_composition->setRotation(*r);
 
    return P_composition;
}

References ItemWithParticles::abundance(), ItemWithParticles::createRotation(), m_particles, 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(), createParticleComposition(), and ParticleCoreShellItem::createParticleCoreShell().

Here is the call graph for this function:

particles()

QVector< ItemWithParticles * > ParticleCompositionItem::particles

(

)

const

Definition at line 81 of file ParticleCompositionItem.cpp.

{
    return m_particles;
}

References m_particles.

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

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(), createParticleComposition(), ParticleCoreShellItem::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().

removeParticle()

void ParticleCompositionItem::removeParticle

(

ItemWithParticles *

particle

)

Definition at line 91 of file ParticleCompositionItem.cpp.

{
    m_particles.removeAll(particle);
    delete particle;
}

References m_particles.

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 ParticleCompositionItem::serialize ( Streamer &  s )

overridevirtual

Implements ItemWithParticles.

Definition at line 45 of file ParticleCompositionItem.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_abundance);
    Serialize::rwProperty(s, m_position);
    Serialize::rwSelected<RotationItemCatalog>(s, m_rotation);
    Serialize::rwCatalogized<ItemWithParticlesCatalog>(s, "Particles", m_particles, m_materials);
}

References Streamer::assertVersion(), ItemWithParticles::m_abundance, m_materials, m_particles, ItemWithParticles::m_position, ItemWithParticles::m_rotation, 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:

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(), serialize(), ParticleCoreShellItem::serialize(), ParticleItem::serialize(), and ItemWithParticles::setAbundance().

m_materials

const MaterialItems* ParticleCompositionItem::m_materials

private

Definition at line 39 of file ParticleCompositionItem.h.

Referenced by ParticleCompositionItem(), and serialize().

m_particles

QVector<ItemWithParticles*> ParticleCompositionItem::m_particles

private

Definition at line 38 of file ParticleCompositionItem.h.

Referenced by addParticle(), containedItemsWithParticles(), createParticleComposition(), particles(), removeParticle(), and 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(), serialize(), ParticleCoreShellItem::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(), serialize(), ParticleItem::serialize(), and ItemWithParticles::setRotation().

---

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

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