ParticleItem Class Reference

Description

Definition at line 26 of file ParticleItem.h.

Inheritance diagram for ParticleItem:

Collaboration diagram for ParticleItem:

Public Member Functions
	ParticleItem (const MaterialItems *materials)
DoubleDescriptor	abundance () const
QVector< ItemWithParticles * >	containedItemsWithParticles () const override
	Return full hierarchical contained items with particles. More...
std::unique_ptr< Particle >	createParticle () const
std::unique_ptr< IRotation >	createRotation () const
	nullptr only if "no rotation". Can contain identity! More...
FormFactorItem *	formfactor_at_bottom () const
QColor	materialColor () const
QString	materialIdentifier () const
MaterialItem *	materialItem () const
	Returns the material item this item links to. More...
QString	materialName () const
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	setFormFactor (FormFactorItem *p)
template<typename T >
T *	setFormFactorType ()
void	setMaterial (const MaterialItem *materialItem)
	Set the material this item shall use. Stores the identifier, not the pointer! More...
void	setMaterial (const QString &materialIdentifier)
	Set the material this item shall use. Stores the given identifier, not a pointer to the material! More...
void	setMaterialUndefined ()
	Set "no material defined". More...
void	setPosition (const R3 &position)
void	setRotation (RotationItem *p)
	nullptr is allowed and sets to "no rotation" More...

Protected Attributes
DoubleProperty	m_abundance
QString	m_materialIdentifier
const MaterialItems *	m_materialItems
VectorProperty	m_position
SelectionProperty< RotationItem * >	m_rotation

Private Attributes
SelectionProperty< FormFactorItem * >	m_formFactor

Constructor & Destructor Documentation

ParticleItem()

ParticleItem::ParticleItem

(

const MaterialItems *

materials

)

Definition at line 35 of file ParticleItem.cpp.

    : ItemWithMaterial(materials)
    , ItemWithParticles(abundance_tooltip, position_tooltip)
{
    m_formFactor.init<FormFactorItemCatalog>("Form Factor", "", "formFactor");
    m_formFactor.set(new CylinderItem());
}

References SelectionProperty< T >::init(), m_formFactor, and SelectionProperty< T >::set().

Here is the call graph for this function:

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

containedItemsWithParticles()

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

overridevirtual

Return full hierarchical contained items with particles.

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

Implements ItemWithParticles.

Definition at line 76 of file ParticleItem.cpp.

{
    return {};
}

Referenced by ParticleCoreShellItem::containedItemsWithParticles().

createParticle()

std::unique_ptr< Particle > ParticleItem::createParticle

(

)

const

Definition at line 53 of file ParticleItem.cpp.

{
    auto domainMaterial = materialItem()->createMaterial();
 
    auto particle = std::make_unique<Particle>(*domainMaterial, *m_formFactor->createFormFactor());
    particle->setAbundance(abundance());
    particle->setParticlePosition(position());
    if (auto r = createRotation(); r && !r->isIdentity())
        particle->setRotation(*r);
 
    return particle;
}

References ItemWithParticles::abundance(), FormFactorItem::createFormFactor(), MaterialItem::createMaterial(), ItemWithParticles::createRotation(), m_formFactor, ItemWithMaterial::materialItem(), 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(), createParticle(), ParticleCompositionItem::createParticleComposition(), and ParticleCoreShellItem::createParticleCoreShell().

Here is the call graph for this function:

formfactor_at_bottom()

FormFactorItem * ParticleItem::formfactor_at_bottom

(

)

const

Definition at line 71 of file ParticleItem.cpp.

{
    return m_formFactor.get();
}

References SelectionProperty< T >::get(), and m_formFactor.

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

Here is the call graph for this function:

materialColor()

QColor ItemWithMaterial::materialColor ( ) const

inherited

Definition at line 42 of file ItemWithMaterial.cpp.

{
    ASSERT(materialItem());
    return materialItem()->color();
}

References MaterialItem::color(), and ItemWithMaterial::materialItem().

Referenced by GUI::View::TransformTo3D::createLayer().

Here is the call graph for this function:

materialIdentifier()

QString ItemWithMaterial::materialIdentifier ( ) const

inherited

Definition at line 54 of file ItemWithMaterial.cpp.

{
    return m_materialIdentifier;
}

References ItemWithMaterial::m_materialIdentifier.

Referenced by ItemWithMaterial::materialItem(), MaterialInplaceForm::selectMaterial(), ItemWithMaterial::setMaterial(), and SampleEditorController::setMaterialValue().

materialItem()

MaterialItem * ItemWithMaterial::materialItem ( ) const

inherited

Returns the material item this item links to.

Definition at line 59 of file ItemWithMaterial.cpp.

{
    if (materialIdentifier().isEmpty())
        return nullptr;
 
    return m_materialItems->materialFromIdentifier(materialIdentifier());
}

References ItemWithMaterial::m_materialItems, MaterialItems::materialFromIdentifier(), and ItemWithMaterial::materialIdentifier().

Referenced by createParticle(), MaterialInplaceForm::createWidgets(), ItemWithMaterial::materialColor(), ItemWithMaterial::materialName(), MaterialInplaceForm::selectMaterial(), and ItemWithMaterial::setMaterial().

Here is the call graph for this function:

materialName()

QString ItemWithMaterial::materialName ( ) const

inherited

Definition at line 48 of file ItemWithMaterial.cpp.

{
    ASSERT(materialItem());
    return materialItem()->matItemName();
}

References ItemWithMaterial::materialItem(), and MaterialItem::matItemName().

Referenced by LayerForm::updateTitle().

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(), createParticle(), ParticleCompositionItem::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().

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

overridevirtual

Implements ItemWithParticles.

Definition at line 43 of file ParticleItem.cpp.

{
    s.assertVersion(0);
    Serialize::rwValue(s, "MaterialIdentifier", m_materialIdentifier);
    Serialize::rwProperty(s, m_abundance);
    Serialize::rwProperty(s, m_position);
    Serialize::rwSelected<RotationItemCatalog>(s, m_rotation);
    Serialize::rwSelected<FormFactorItemCatalog>(s, m_formFactor);
}

References Streamer::assertVersion(), ItemWithParticles::m_abundance, m_formFactor, ItemWithMaterial::m_materialIdentifier, ItemWithParticles::m_position, ItemWithParticles::m_rotation, Serialize::rwProperty(), and Serialize::rwValue().

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:

setFormFactor()

void ParticleItem::setFormFactor

(

FormFactorItem *

p

)

Definition at line 66 of file ParticleItem.cpp.

{
    m_formFactor.set(p);
}

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

Referenced by SampleEditorController::setCoreFormFactor(), setFormFactorType(), and SampleEditorController::setShellFormFactor().

Here is the call graph for this function:

setFormFactorType()

template<typename T >

T * ParticleItem::setFormFactorType

Definition at line 44 of file ParticleItem.h.

{
    T* p = new T();
    setFormFactor(p);
    return p;
}

References setFormFactor().

Here is the call graph for this function:

setMaterial() [1/2]

void ItemWithMaterial::setMaterial ( const MaterialItem *  materialItem )

inherited

Set the material this item shall use. Stores the identifier, not the pointer!

Definition at line 20 of file ItemWithMaterial.cpp.

{
    m_materialIdentifier = materialItem->identifier();
}

References MaterialItem::identifier(), ItemWithMaterial::m_materialIdentifier, and ItemWithMaterial::materialItem().

Referenced by SampleEditorController::addLayerFromUndo(), GUI::Transform::FromCore::itemizeSample(), and SampleEditorController::selectMaterial().

Here is the call graph for this function:

setMaterial() [2/2]

void ItemWithMaterial::setMaterial ( const QString &  materialIdentifier )

inherited

Set the material this item shall use. Stores the given identifier, not a pointer to the material!

Definition at line 25 of file ItemWithMaterial.cpp.

{
    m_materialIdentifier = materialIdentifier;
}

References ItemWithMaterial::m_materialIdentifier, and ItemWithMaterial::materialIdentifier().

Here is the call graph for this function:

setMaterialUndefined()

void ItemWithMaterial::setMaterialUndefined ( )

inherited

Set "no material defined".

Definition at line 37 of file ItemWithMaterial.cpp.

{
    m_materialIdentifier.clear();
}

References ItemWithMaterial::m_materialIdentifier.

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

m_formFactor

SelectionProperty<FormFactorItem*> ParticleItem::m_formFactor

private

Definition at line 40 of file ParticleItem.h.

Referenced by ParticleItem(), createParticle(), formfactor_at_bottom(), serialize(), and setFormFactor().

m_materialIdentifier

QString ItemWithMaterial::m_materialIdentifier

protectedinherited

Definition at line 51 of file ItemWithMaterial.h.

Referenced by ItemWithMaterial::materialIdentifier(), LayerItem::serialize(), serialize(), ItemWithMaterial::setMaterial(), and ItemWithMaterial::setMaterialUndefined().

m_materialItems

const MaterialItems* ItemWithMaterial::m_materialItems

protectedinherited

Definition at line 50 of file ItemWithMaterial.h.

Referenced by ItemWithMaterial::ItemWithMaterial(), LayerItem::addLayout(), ItemWithMaterial::materialItem(), and LayerItem::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(), ParticleCoreShellItem::serialize(), 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(), 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/ParticleItem.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/ParticleItem.cpp