ItemWithMaterial.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Sample/ItemWithMaterial.h
//! @brief     Defines abstract item with a material property
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_GUI_MODEL_SAMPLE_ITEMWITHMATERIAL_H
#define BORNAGAIN_GUI_MODEL_SAMPLE_ITEMWITHMATERIAL_H
 
#include <QString>
#include <functional>
 
class Material;
class MaterialItem;
class MaterialItems;
class QColor;
 
class ItemWithMaterial {
public:
    //! Overhand the material list where the current material has to be searched for.
    explicit ItemWithMaterial(const MaterialItems* materials);
 
    //! Set the material this item shall use.
    //! Stores the identifier, not the pointer!
    void setMaterial(const MaterialItem* materialItem);
 
    //! Set the material this item shall use.
    //! Stores the given identifier, not a pointer to the material!
    void setMaterial(const QString& materialIdentifier);
 
    //! Set "no material defined"
    void setMaterialUndefined();
 
    QColor materialColor() const;
    QString materialName() const;
    QString materialIdentifier() const;
 
    //! Returns the material item this item links to.
    MaterialItem* materialItem() const;
 
protected:
    const MaterialItems* m_materialItems;
    QString m_materialIdentifier;
};
 
#endif // BORNAGAIN_GUI_MODEL_SAMPLE_ITEMWITHMATERIAL_H