ItemWithParticles Class Reference

Description

Definition at line 27 of file ItemWithParticles.h.

Inheritance diagram for ItemWithParticles:

Collaboration diagram for ItemWithParticles:

Public Member Functions
virtual	~ItemWithParticles ()=default
DoubleDescriptor	abundance () const
virtual QVector< ItemWithParticles * >	containedItemsWithParticles () const =0
	Return full hierarchical contained items with particles. More...
std::unique_ptr< IRotation >	createRotation () const
	nullptr only if "no rotation". Can contain identity! More...
R3	position () const
VectorDescriptor	positionVector () const
SelectionDescriptor< RotationItem * >	rotation ()
	Returns selection descriptor for rotation methods. More...
virtual void	serialize (Streamer &s)=0
void	setAbundance (double abundance)
void	setPosition (const R3 &position)
void	setRotation (RotationItem *p)
	nullptr is allowed and sets to "no rotation" More...

Protected Member Functions
	ItemWithParticles (const QString &abundanceTooltip, const QString &positionTooltip)

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

Constructor & Destructor Documentation

~ItemWithParticles()

virtual ItemWithParticles::~ItemWithParticles ( )

virtualdefault

ItemWithParticles()

ItemWithParticles::ItemWithParticles ( const QString &  abundanceTooltip, const QString &  positionTooltip  )

protected

Definition at line 23 of file ItemWithParticles.cpp.

{
    m_abundance.init("Abundance", abundanceTooltip, 1.0, Unit::unitless, 3,
                     RealLimits::limited(0.0, 1.0), "abundance");
    m_position.init("Position Offset", positionTooltip, Unit::nanometer, "pos");
    m_rotation.init<RotationItemCatalog>("Rotation", "", "rotation");
}

References SelectionProperty< T >::init(), VectorProperty::init(), DoubleProperty::init(), m_abundance, m_position, m_rotation, nanometer, and unitless.

Here is the call graph for this function:

Member Function Documentation

abundance()

DoubleDescriptor ItemWithParticles::abundance

(

)

const

Definition at line 32 of file ItemWithParticles.cpp.

{
    return m_abundance;
}

References m_abundance.

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

containedItemsWithParticles()

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

pure virtual

Return full hierarchical contained items with particles.

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

Implemented in ParticleItem, ParticleCoreShellItem, ParticleCompositionItem, and MesoCrystalItem.

Referenced by MesoCrystalItem::containedItemsWithParticles().

createRotation()

std::unique_ptr< IRotation > ItemWithParticles::createRotation

(

)

const

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(), m_rotation, and RotationItem::rotation().

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

Here is the call graph for this function:

position()

R3 ItemWithParticles::position

(

)

const

Definition at line 42 of file ItemWithParticles.cpp.

{
    return m_position;
}

References m_position.

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

positionVector()

VectorDescriptor ItemWithParticles::positionVector

(

)

const

Definition at line 52 of file ItemWithParticles.cpp.

{
    return m_position;
}

References m_position.

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

rotation()

SelectionDescriptor< RotationItem * > ItemWithParticles::rotation

(

)

Returns selection descriptor for rotation methods.

Definition at line 57 of file ItemWithParticles.cpp.

{
    return m_rotation;
}

References m_rotation.

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

serialize()

virtual void ItemWithParticles::serialize ( Streamer &  s )

pure virtual

Implemented in ParticleItem, ParticleCoreShellItem, ParticleCompositionItem, and MesoCrystalItem.

setAbundance()

void ItemWithParticles::setAbundance

(

double

abundance

)

Definition at line 37 of file ItemWithParticles.cpp.

{
    m_abundance.set(abundance);
}

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

Here is the call graph for this function:

setPosition()

void ItemWithParticles::setPosition

(

const R3 &

position

)

Definition at line 47 of file ItemWithParticles.cpp.

{
    m_position.set(position);
}

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

Here is the call graph for this function:

setRotation()

void ItemWithParticles::setRotation

(

RotationItem *

p

)

nullptr is allowed and sets to "no rotation"

Definition at line 62 of file ItemWithParticles.cpp.

{
    m_rotation.set(p);
}

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

Here is the call graph for this function:

Member Data Documentation

m_abundance

DoubleProperty ItemWithParticles::m_abundance

protected

Definition at line 56 of file ItemWithParticles.h.

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

m_position

VectorProperty ItemWithParticles::m_position

protected

Definition at line 57 of file ItemWithParticles.h.

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

m_rotation

SelectionProperty<RotationItem*> ItemWithParticles::m_rotation

protected

Definition at line 58 of file ItemWithParticles.h.

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

---

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

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