ItemWithParticlesCatalog Class Reference

Description

Definition at line 24 of file ItemWithParticlesCatalog.h.

Classes
struct	UiInfo

Public Types
using	CatalogedType = ItemWithParticles
enum class	Type : uint8_t { Particle = 1 , Composition = 2 , CoreShell = 3 , MesoCrystal = 4 }

Static Public Member Functions
static QVector< Type >	assemblyTypes ()
	Available types of assembly items, sorted as expected in the UI (e.g. in combo box) More...
static ItemWithParticles *	create (Type type, const MaterialItems *materials)
	Creates the item of the given type. More...
static Type	type (const ItemWithParticles *item)
	Returns the enum type of the given item. More...
static QVector< Type >	types ()
	Available types of items, sorted as expected in the UI (e.g. in combo box) More...
static UiInfo	uiInfo (Type t)
	UiInfo on the given type. More...

Member Typedef Documentation

CatalogedType

using ItemWithParticlesCatalog::CatalogedType = ItemWithParticles

Definition at line 26 of file ItemWithParticlesCatalog.h.

Member Enumeration Documentation

Type

enum ItemWithParticlesCatalog::Type : uint8_t

strong

Enumerator
Particle
Composition
CoreShell
MesoCrystal

Definition at line 29 of file ItemWithParticlesCatalog.h.

: uint8_t { Particle = 1, Composition = 2, CoreShell = 3, MesoCrystal = 4 };

Member Function Documentation

assemblyTypes()

QVector< ItemWithParticlesCatalog::Type > ItemWithParticlesCatalog::assemblyTypes ( )

static

Available types of assembly items, sorted as expected in the UI (e.g. in combo box)

Definition at line 42 of file ItemWithParticlesCatalog.cpp.

{
    return {Type::Composition, Type::CoreShell, Type::MesoCrystal};
}

References Composition, CoreShell, and MesoCrystal.

Referenced by MesoCrystalForm::createBasisCombo().

create()

ItemWithParticles * ItemWithParticlesCatalog::create ( Type  type, const MaterialItems *  materials  )

static

Creates the item of the given type.

If type is "None", a nullptr is returned.

Definition at line 21 of file ItemWithParticlesCatalog.cpp.

{
    switch (type) {
    case Type::Particle:
        return new ParticleItem(materials);
    case Type::Composition:
        return new ParticleCompositionItem(materials);
    case Type::CoreShell:
        return new ParticleCoreShellItem(materials);
    case Type::MesoCrystal:
        return new MesoCrystalItem(materials);
    default:
        ASSERT(false);
    }
}

References Composition, CoreShell, MesoCrystal, Particle, and type().

Referenced by SampleEditorController::createAndInitParticle().

Here is the call graph for this function:

type()

ItemWithParticlesCatalog::Type ItemWithParticlesCatalog::type ( const ItemWithParticles *  item )

static

Returns the enum type of the given item.

Definition at line 66 of file ItemWithParticlesCatalog.cpp.

{
    ASSERT(item);
 
    if (dynamic_cast<const ParticleItem*>(item))
        return Type::Particle;
    if (dynamic_cast<const ParticleCompositionItem*>(item))
        return Type::Composition;
    if (dynamic_cast<const MesoCrystalItem*>(item))
        return Type::MesoCrystal;
    if (dynamic_cast<const ParticleCoreShellItem*>(item))
        return Type::CoreShell;
 
    ASSERT(false);
}

References Composition, CoreShell, MesoCrystal, and Particle.

Referenced by create(), MesoCrystalForm::createBasisCombo(), and uiInfo().

types()

QVector< ItemWithParticlesCatalog::Type > ItemWithParticlesCatalog::types ( )

static

Available types of items, sorted as expected in the UI (e.g. in combo box)

Definition at line 37 of file ItemWithParticlesCatalog.cpp.

{
    return {Type::Particle, Type::Composition, Type::CoreShell, Type::MesoCrystal};
}

References Composition, CoreShell, MesoCrystal, and Particle.

uiInfo()

ItemWithParticlesCatalog::UiInfo ItemWithParticlesCatalog::uiInfo ( Type  t )

static

UiInfo on the given type.

Definition at line 47 of file ItemWithParticlesCatalog.cpp.

{
    switch (type) {
    case Type::Particle:
        return {"Particle", "", ""}; // particle is not on UI, only its form factor
    case Type::Composition:
        return {"Particle Composition", "Composition of particles with fixed positions",
                ":/SampleDesignerToolbox/images/ParticleComposition_64x64.png"};
    case Type::CoreShell:
        return {"Core shell particle", "A particle with a core/shell geometry",
                ":/SampleDesignerToolbox/images/ParticleCoreShell_64x64.png"};
    case Type::MesoCrystal:
        return {"Meso Crystal", "A 3D crystal structure of nanoparticles",
                ":/SampleDesignerToolbox/images/Mesocrystal_64x64.png"};
    default:
        ASSERT(false);
    }
}

References Composition, CoreShell, MesoCrystal, Particle, and type().

Referenced by LayerEditorUtils::createAddParticleButton(), and MesoCrystalForm::createBasisCombo().

Here is the call graph for this function:

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/CatSample/ItemWithParticlesCatalog.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/CatSample/ItemWithParticlesCatalog.cpp