LayerItem Class Reference

Description

Definition at line 36 of file LayerItem.h.

Inheritance diagram for LayerItem:

Collaboration diagram for LayerItem:

Public Member Functions
	LayerItem (const MaterialItems *materials)
ParticleLayoutItem *	addLayout ()
void	clearRoughness ()
QColor	color () const
bool	isBottomLayer () const
bool	isTopLayer () const
QVector< ItemWithMaterial * >	itemsWithMaterial ()
QVector< ItemWithParticles * >	itemsWithParticles () const
QString	layerName () const
QVector< ParticleLayoutItem * >	layouts () const
QColor	materialColor () const
QString	materialIdentifier () const
MaterialItem *	materialItem () const
	Returns the material item this item links to. More...
QString	materialName () const
UIntDescriptor	numSlices () const
void	removeLayout (ParticleLayoutItem *layout)
SelectionDescriptor< LayerBasicRoughnessItem * >	roughness ()
void	serialize (Streamer &s)
void	setBasicRoughness ()
void	setColor (const QColor &color)
void	setIsBottomLayer (bool b)
void	setIsTopLayer (bool b)
void	setLayerName (const QString &name)
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...
DoubleDescriptor	thickness () const

Protected Attributes
QString	m_materialIdentifier
const MaterialItems *	m_materialItems

Private Attributes
QColor	m_color
bool	m_isBottomLayer = false
bool	m_isTopLayer = false
QVector< ParticleLayoutItem * >	m_layouts
QString	m_name
UIntProperty	m_numSlices
DoubleProperty	m_thickness
std::unique_ptr< LayerBasicRoughnessItem >	m_topRoughness

Constructor & Destructor Documentation

LayerItem()

LayerItem::LayerItem ( const MaterialItems *  materials )

explicit

Definition at line 55 of file LayerItem.cpp.

    : ItemWithMaterial(materials)
{
    m_thickness.init("Thickness", "Thickness of the layer", 0.0, Unit::nanometer, 3,
                     RealLimits::lowerLimited(0.0), "thickness");
 
    m_numSlices.init("Number of slices",
                     "Number of horizontal slices.\n"
                     "Used for Average Layer Material calculations \n"
                     "when corresponding simulation option is set.",
                     1, Unit::unitless, RealLimits::lowerLimited(0.0), "slices");
 
    m_name = "Layer";
}

References DoubleProperty::init(), UIntProperty::init(), m_name, m_numSlices, m_thickness, nanometer, and unitless.

Here is the call graph for this function:

Member Function Documentation

addLayout()

ParticleLayoutItem * LayerItem::addLayout

(

)

Definition at line 141 of file LayerItem.cpp.

{
    m_layouts << new ParticleLayoutItem(m_materialItems);
    return m_layouts.back();
}

References m_layouts, and ItemWithMaterial::m_materialItems.

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

clearRoughness()

void LayerItem::clearRoughness

(

)

Definition at line 126 of file LayerItem.cpp.

{
    m_topRoughness.reset();
}

References m_topRoughness.

Referenced by roughness().

color()

QColor LayerItem::color

(

)

const

Definition at line 153 of file LayerItem.cpp.

{
    return m_color;
}

References m_color.

Referenced by LayerForm::LayerForm(), setColor(), and LayerForm::updateColor().

isBottomLayer()

bool LayerItem::isBottomLayer

(

)

const

Definition at line 178 of file LayerItem.cpp.

{
    return m_isBottomLayer;
}

References m_isBottomLayer.

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

isTopLayer()

bool LayerItem::isTopLayer

(

)

const

Definition at line 168 of file LayerItem.cpp.

{
    return m_isTopLayer;
}

References m_isTopLayer.

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

itemsWithMaterial()

QVector< ItemWithMaterial * > LayerItem::itemsWithMaterial

(

)

Definition at line 80 of file LayerItem.cpp.

{
    QVector<ItemWithMaterial*> result;
    result.push_back(this);
    for (auto* layout : layouts())
        result.append(layoutItemsWithMaterial(layout));
    return result;
}

References layouts().

Here is the call graph for this function:

itemsWithParticles()

QVector< ItemWithParticles * > LayerItem::itemsWithParticles

(

)

const

Definition at line 89 of file LayerItem.cpp.

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

References ParticleLayoutItem::containedItemsWithParticles(), and layouts().

Here is the call graph for this function:

layerName()

QString LayerItem::layerName

(

)

const

Definition at line 75 of file LayerItem.cpp.

{
    return m_name;
}

References m_name.

Referenced by LayerForm::LayerForm(), and SampleValidator::validateInterferences().

layouts()

QVector< ParticleLayoutItem * > LayerItem::layouts

(

)

const

Definition at line 136 of file LayerItem.cpp.

{
    return m_layouts;
}

References m_layouts.

Referenced by LayerForm::LayerForm(), itemsWithMaterial(), itemsWithParticles(), LayerForm::onAboutToRemoveLayout(), LayerForm::onLayoutAdded(), RealSpaceBuilder::populateLayer(), ParticleLayoutForm::updateTitle(), and SampleValidator::validateInterferences().

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 ParticleItem::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:

numSlices()

UIntDescriptor LayerItem::numSlices

(

)

const

Definition at line 131 of file LayerItem.cpp.

{
    return m_numSlices;
}

References m_numSlices.

Referenced by LayerForm::LayerForm().

removeLayout()

void LayerItem::removeLayout

(

ParticleLayoutItem *

layout

)

Definition at line 147 of file LayerItem.cpp.

{
    m_layouts.removeAll(layout);
    delete layout;
}

References m_layouts.

Referenced by SampleEditorController::removeLayout().

roughness()

SelectionDescriptor< LayerBasicRoughnessItem * > LayerItem::roughness

(

)

Definition at line 102 of file LayerItem.cpp.

{
    SelectionDescriptor<LayerBasicRoughnessItem*> d;
    d.label = "Top roughness";
    d.tooltip = "Roughness of top interface";
    d.options = QStringList{"No", "Basic"};
 
    d.currentIndexSetter = [=](int idx) {
        if (idx == 0)
            clearRoughness();
        else
            setBasicRoughness();
    };
 
    d.currentIndexGetter = [=]() { return m_topRoughness ? 1 : 0; };
    d.currentItem = [=] { return m_topRoughness.get(); };
    return d;
}

References clearRoughness(), SelectionDescriptor< T >::currentIndexGetter, SelectionDescriptor< T >::currentIndexSetter, SelectionDescriptor< T >::currentItem, SelectionDescriptor< T >::label, m_topRoughness, SelectionDescriptor< T >::options, setBasicRoughness(), and SelectionDescriptor< T >::tooltip.

Referenced by LayerForm::LayerForm().

Here is the call graph for this function:

serialize()

void LayerItem::serialize

(

Streamer &

s

)

Definition at line 183 of file LayerItem.cpp.

{
    s.assertVersion(0);
    Serialize::rwValue(s, "Name", m_name);
    Serialize::rwValue(s, "Color", m_color);
    Serialize::rwValue(s, "MaterialIdentifier", m_materialIdentifier);
    Serialize::rwProperty(s, m_numSlices);
    Serialize::rwProperty(s, m_thickness);
    Serialize::rwOptional(s, "Roughness", m_topRoughness);
    Serialize::rwVector(s, "Layouts", m_layouts, m_materialItems);
}

References Streamer::assertVersion(), m_color, m_layouts, ItemWithMaterial::m_materialIdentifier, ItemWithMaterial::m_materialItems, m_name, m_numSlices, m_thickness, m_topRoughness, Serialize::rwOptional(), Serialize::rwProperty(), Serialize::rwValue(), and Serialize::rwVector().

Here is the call graph for this function:

setBasicRoughness()

void LayerItem::setBasicRoughness

(

)

Definition at line 121 of file LayerItem.cpp.

{
    m_topRoughness.reset(new LayerBasicRoughnessItem);
}

References m_topRoughness.

Referenced by roughness().

setColor()

void LayerItem::setColor

(

const QColor &

color

)

Definition at line 158 of file LayerItem.cpp.

{
    m_color = color;
}

References color(), and m_color.

Referenced by LayerForm::LayerForm(), and SampleEditorController::addLayerFromUndo().

Here is the call graph for this function:

setIsBottomLayer()

void LayerItem::setIsBottomLayer

(

bool

b

)

Definition at line 173 of file LayerItem.cpp.

{
    m_isBottomLayer = b;
}

References m_isBottomLayer.

Referenced by GUI::Transform::FromCore::itemizeSample().

setIsTopLayer()

void LayerItem::setIsTopLayer

(

bool

b

)

Definition at line 163 of file LayerItem.cpp.

{
    m_isTopLayer = b;
}

References m_isTopLayer.

Referenced by GUI::Transform::FromCore::itemizeSample().

setLayerName()

void LayerItem::setLayerName

(

const QString &

name

)

Definition at line 70 of file LayerItem.cpp.

{
    m_name = name;
}

References m_name, and GUI::RealSpace::Particles::name().

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.

thickness()

DoubleDescriptor LayerItem::thickness

(

)

const

Definition at line 97 of file LayerItem.cpp.

{
    return m_thickness;
}

References m_thickness.

Referenced by LayerForm::LayerForm(), LayerForm::updateLayerPositionDependentElements(), and GUI::View::TransformTo3D::visualLayerThickness().

Member Data Documentation

m_color

QColor LayerItem::m_color

private

Definition at line 73 of file LayerItem.h.

Referenced by color(), serialize(), and setColor().

m_isBottomLayer

bool LayerItem::m_isBottomLayer = false

private

Definition at line 75 of file LayerItem.h.

Referenced by isBottomLayer(), and setIsBottomLayer().

m_isTopLayer

bool LayerItem::m_isTopLayer = false

private

Definition at line 74 of file LayerItem.h.

Referenced by isTopLayer(), and setIsTopLayer().

m_layouts

QVector<ParticleLayoutItem*> LayerItem::m_layouts

private

Definition at line 76 of file LayerItem.h.

Referenced by addLayout(), layouts(), removeLayout(), and serialize().

m_materialIdentifier

QString ItemWithMaterial::m_materialIdentifier

protectedinherited

Definition at line 51 of file ItemWithMaterial.h.

Referenced by ItemWithMaterial::materialIdentifier(), serialize(), ParticleItem::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(), addLayout(), ItemWithMaterial::materialItem(), and serialize().

m_name

QString LayerItem::m_name

private

Definition at line 70 of file LayerItem.h.

Referenced by LayerItem(), layerName(), serialize(), and setLayerName().

m_numSlices

UIntProperty LayerItem::m_numSlices

private

Definition at line 71 of file LayerItem.h.

Referenced by LayerItem(), numSlices(), and serialize().

m_thickness

DoubleProperty LayerItem::m_thickness

private

Definition at line 72 of file LayerItem.h.

Referenced by LayerItem(), serialize(), and thickness().

m_topRoughness

std::unique_ptr<LayerBasicRoughnessItem> LayerItem::m_topRoughness

private

Definition at line 77 of file LayerItem.h.

Referenced by clearRoughness(), roughness(), serialize(), and setBasicRoughness().

---

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

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