ItemWithParticles.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Sample/ItemWithParticles.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 2021
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_GUI_MODEL_SAMPLE_ITEMWITHPARTICLES_H
#define BORNAGAIN_GUI_MODEL_SAMPLE_ITEMWITHPARTICLES_H
 
#include "GUI/Model/Descriptor/DoubleProperty.h"
#include "GUI/Model/Descriptor/SelectionProperty.h"
#include "GUI/Model/Descriptor/VectorProperty.h"
#include "GUI/Model/Sample/RotationItems.h"
#include <memory>
 
class IRotation;
class Streamer;
 
class ItemWithParticles {
public:
    virtual ~ItemWithParticles() = default;
    DoubleDescriptor abundance() const;
    void setAbundance(double abundance);
 
    R3 position() const;
    void setPosition(const R3& position);
    VectorDescriptor positionVector() const;
 
    //! Returns selection descriptor for rotation methods.
    SelectionDescriptor<RotationItem*> rotation();
 
    //! nullptr is allowed and sets to "no rotation"
    void setRotation(RotationItem* p);
 
    //! nullptr only if "no rotation". Can contain identity!
    std::unique_ptr<IRotation> createRotation() const;
 
    //! Return full hierarchical contained items with particles.
    //!
    //! For example ParticleCompositionItem contains other items, ParticleItem doesn't.
    virtual QVector<ItemWithParticles*> containedItemsWithParticles() const = 0;
 
    virtual void serialize(Streamer& s) = 0;
 
protected:
    ItemWithParticles(const QString& abundanceTooltip, const QString& positionTooltip);
 
    DoubleProperty m_abundance;
    VectorProperty m_position;
    SelectionProperty<RotationItem*> m_rotation;
};
 
#endif // BORNAGAIN_GUI_MODEL_SAMPLE_ITEMWITHPARTICLES_H