Model to hold MaterialItems. More...

Inheritance diagram for gui2::MaterialModel:

Collaboration diagram for gui2::MaterialModel:

Public Member Functions
	MaterialModel (std::shared_ptr< ModelView::ItemPool > pool={})

SLDMaterialItem *	addDefaultMaterial (const ModelView::TagRow &tagrow={})
	Adds default material. More...

void	clear (std::function< void(SessionItem *)> callback={})
	Removes all items from the model. More...

MaterialBaseItem *	cloneMaterial (const MaterialBaseItem *item)
	Clones material and adds it at the bottom of MaterialContainerItem. More...

SessionItem *	copyItem (const SessionItem item, SessionItem parent, const TagRow &tagrow={})
	Copy item and insert it in parent's tag and row. Item could belong to any model/parent. More...

Variant	data (SessionItem *item, int role) const
	Returns the data for given item and role. More...

const ItemFactoryInterface *	factory () const
	Returns item factory which can generate all items supported by this model. More...

SessionItem *	findItem (const identifier_type &id)
	Returns SessionItem for given identifier. More...

template<typename T >
T *	insertItem (SessionItem *parent=nullptr, const TagRow &tagrow={})
	Inserts item into given parent under given tagrow. More...

SessionItem *	insertNewItem (const model_type &modelType, SessionItem *parent=nullptr, const TagRow &tagrow={})
	Insert new item using item's modelType. More...

ModelMapper *	mapper ()
	Returns model mapper. Can be used to subscribe to various model's signal. More...

std::vector< ModelView::ExternalProperty >	material_data (std::string container_id=std::string()) const
	Returns vector of properties representing possible choice of materials for the given container. More...

ModelView::ExternalProperty	material_property (const std::string &id)
	Returns property from given material id. More...

std::string	modelType () const
	Returns model type. More...

void	moveItem (SessionItem item, SessionItem new_parent, const TagRow &tagrow)
	Move item from it's current parent to a new parent under given tag and row. More...

template<typename T >
void	registerItem (const std::string &label={})
	Register used defined item to use with the model. More...

void	removeItem (SessionItem *parent, const TagRow &tagrow)
	Removes given row from parent. More...

SessionItem *	rootItem () const
	Returns root item of the model. More...

bool	setData (SessionItem *item, const Variant &value, int role)
	Sets the data for given item. More...

void	setItemCatalogue (std::unique_ptr< ItemCatalogue > catalogue)
	Sets brand new catalog of user-defined items. More...

void	setUndoRedoEnabled (bool value)
	Sets undo/redo either enabled or disabled. By default undo/redo is disabled. More...

template<typename T = SessionItem>
T *	topItem () const
	Returns top item of the given type. More...

template<typename T = SessionItem>
std::vector< T * >	topItems () const
	Returns top items of the given type. More...

UndoStackInterface *	undoStack () const
	Returns command stack to perform undo/redo. More...

Private Member Functions
void	init_model ()
	Populates the model with some default content. More...

SessionItem *	intern_insert (const item_factory_func_t &func, SessionItem *parent, const TagRow &tagrow)
	Insert new item into given parent using factory function provided. More...

void	intern_register (const model_type &modelType, const item_factory_func_t &func, const std::string &label)

MaterialContainerItem *	materialContainer ()

void	registerInPool (SessionItem *item)
	Registers item in pool. This will allow to find item pointer using its unique identifier. More...

void	unregisterFromPool (SessionItem *item)
	Unregister item from pool. More...

Private Attributes
std::unique_ptr< SessionModelImpl >	p_impl

Detailed Description

Model to hold MaterialItems.

Definition at line 35 of file materialmodel.h.

Constructor & Destructor Documentation

◆ MaterialModel()

MaterialModel::MaterialModel ( std::shared_ptr< ModelView::ItemPool > pool = {} )

Definition at line 66 of file materialmodel.cpp.

     : SessionModel("MaterialModel", pool)
 {
     init_model();
 }

References init_model().

Here is the call graph for this function:

Member Function Documentation

◆ addDefaultMaterial()

SLDMaterialItem * MaterialModel::addDefaultMaterial ( const ModelView::TagRow & tagrow = {} )

Adds default material.

Definition at line 117 of file materialmodel.cpp.

 {
     auto material = insertItem<SLDMaterialItem>(materialContainer(), tagrow);
     material->set_properties("Default", QColor(Qt::green), rho_default, mu_default);
     return material;
 }

References materialContainer().

Here is the call graph for this function:

◆ clear()

void SessionModel::clear ( std::function< void(SessionItem *)> callback = {} )

inherited

Removes all items from the model.

If callback is provided, use it to rebuild content of root item (used while restoring the model from serialized content).

Definition at line 194 of file sessionmodel.cpp.

 {
     if (undoStack())
         undoStack()->clear();
     mapper()->callOnModelAboutToBeReset();
     p_impl->createRootItem();
     if (callback)
         callback(rootItem());
     mapper()->callOnModelReset();
 }

References ModelView::ModelMapper::callOnModelAboutToBeReset(), ModelView::ModelMapper::callOnModelReset(), ModelView::UndoStackInterface::clear(), ModelView::SessionModel::mapper(), ModelView::SessionModel::p_impl, ModelView::SessionModel::rootItem(), and ModelView::SessionModel::undoStack().

Referenced by gui2::SLDElementController::clearScene(), ModelView::JsonModelConverter::from_json(), and TEST_F().

Here is the call graph for this function:

◆ cloneMaterial()

MaterialBaseItem * MaterialModel::cloneMaterial ( const MaterialBaseItem * item )

Clones material and adds it at the bottom of MaterialContainerItem.

Definition at line 109 of file materialmodel.cpp.

 {
     auto tagrow = item->tagRow().next();
     return static_cast<MaterialBaseItem*>(SessionModel::copyItem(item, item->parent(), tagrow));
 }

References ModelView::SessionModel::copyItem(), ModelView::TagRow::next(), ModelView::SessionItem::parent(), and ModelView::SessionItem::tagRow().

Here is the call graph for this function:

◆ copyItem()

SessionItem * SessionModel::copyItem	(	const SessionItem *	item,
		SessionItem *	parent,
		const TagRow &	tagrow = `{}`
	)

inherited

Copy item and insert it in parent's tag and row. Item could belong to any model/parent.

Definition at line 111 of file sessionmodel.cpp.

 {
     return p_impl->m_commands->copyItem(item, parent, tagrow);
 }

References ModelView::SessionModel::p_impl.

Referenced by cloneMaterial(), and TEST_F().

◆ data()

Variant SessionModel::data	(	SessionItem *	item,
		int	role
	)		const

inherited

Returns the data for given item and role.

Definition at line 119 of file sessionmodel.cpp.

 {
     return item->data<Variant>(role);
 }

References ModelView::SessionItem::data().

Referenced by gui2::ExperimentalDataModel::addGraph(), and TEST_F().

Here is the call graph for this function:

◆ factory()

const ItemFactoryInterface * SessionModel::factory ( ) const

inherited

Returns item factory which can generate all items supported by this model.

Definition at line 161 of file sessionmodel.cpp.

 {
     return p_impl->m_itemManager->factory();
 }

References ModelView::SessionModel::p_impl.

Referenced by InsertNewItemCommandTest::create_command(), ModelView::CreateItemBackupStrategy(), ModelView::CreateItemCopyStrategy(), ModelView::JsonModelConverter::from_json(), ModelView::SessionModel::insertNewItem(), TEST_F(), and ModelView::JsonModelConverter::to_json().

◆ findItem()

SessionItem * SessionModel::findItem ( const identifier_type & id )

inherited

Returns SessionItem for given identifier.

Definition at line 168 of file sessionmodel.cpp.

 {
     return p_impl->m_itemManager->findItem(id);
 }

References ModelView::SessionModel::p_impl.

Referenced by gui2::DataViewModel::dropMimeData(), ModelView::LinkedItem::get(), gui2::ExperimentalScanItem::graphItem(), TEST_F(), gui2::SLDElementController::updateRoughnessFromView(), gui2::SLDElementController::updateSLDFromView(), gui2::SLDElementController::updateThicknessFromView(), and gui2::SLDElementController::updateToView().

◆ init_model()

void MaterialModel::init_model ( )

private

Populates the model with some default content.

Definition at line 126 of file materialmodel.cpp.

 {
     setItemCatalogue(CreateItemCatalogue());
  
     auto container = insertItem<MaterialContainerItem>();
     auto material = insertItem<SLDMaterialItem>(container);
     material->set_properties(air_material_name, suggestMaterialColor(air_material_name), 0.0, 0.0);
     material = insertItem<SLDMaterialItem>(container);
     material->set_properties(default_material_name, suggestMaterialColor(default_material_name),
                              rho_default, mu_default);
     material = insertItem<SLDMaterialItem>(container);
     material->set_properties(substrate_material_name, suggestMaterialColor(substrate_material_name),
                              rho_si, mu_si);
 }

References ModelView::SessionModel::setItemCatalogue(), and MaterialItemUtils::suggestMaterialColor().

Referenced by MaterialModel().

Here is the call graph for this function:

◆ insertItem()

template<typename T >

T * SessionModel::insertItem	(	SessionItem *	parent = `nullptr`,
		const TagRow &	tagrow = `{}`
	)

inherited

Inserts item into given parent under given tagrow.

Definition at line 104 of file sessionmodel.h.

 {
     return static_cast<T*>(intern_insert(ItemFactoryFunction<T>(), parent, tagrow));
 }

References ModelView::SessionModel::intern_insert().

Referenced by ModelView::Data1DItem::setAxis(), TEST(), and TEST_F().

Here is the call graph for this function:

◆ insertNewItem()

SessionItem * SessionModel::insertNewItem	(	const model_type &	modelType,
		SessionItem *	parent = `nullptr`,
		const TagRow &	tagrow = `{}`
	)

inherited

Insert new item using item's modelType.

Definition at line 86 of file sessionmodel.cpp.

 {
     // intentionally passing by value inside lambda
     auto create_func = [this, modelType]() { return factory()->createItem(modelType); };
     return intern_insert(create_func, parent, tagrow);
 }

References ModelView::ItemFactoryInterface::createItem(), ModelView::SessionModel::factory(), ModelView::SessionModel::intern_insert(), and ModelView::SessionModel::modelType().

Referenced by TEST_F().

Here is the call graph for this function:

◆ intern_insert()

SessionItem * SessionModel::intern_insert	(	const item_factory_func_t &	func,
		SessionItem *	parent,
		const TagRow &	tagrow
	)

privateinherited

Insert new item into given parent using factory function provided.

Definition at line 222 of file sessionmodel.cpp.

 {
     return p_impl->m_commands->insertNewItem(func, parent, tagrow);
 }

References ModelView::SessionModel::p_impl.

Referenced by ModelView::SessionModel::insertItem(), and ModelView::SessionModel::insertNewItem().

◆ intern_register()

void SessionModel::intern_register	(	const model_type &	modelType,
		const item_factory_func_t &	func,
		const std::string &	label
	)

privateinherited

Definition at line 228 of file sessionmodel.cpp.

 {
     p_impl->m_itemManager->factory()->registerItem(modelType, func, label);
 }

References ModelView::SessionModel::modelType(), and ModelView::SessionModel::p_impl.

Referenced by ModelView::SessionModel::registerItem().

Here is the call graph for this function:

◆ mapper()

ModelMapper * SessionModel::mapper ( )

inherited

Returns model mapper. Can be used to subscribe to various model's signal.

Definition at line 147 of file sessionmodel.cpp.

 {
     return p_impl->m_mapper.get();
 }

References ModelView::SessionModel::p_impl.

Referenced by MockWidgetForModel::~MockWidgetForModel(), ModelView::SessionModel::clear(), gui2::SLDElementController::connectLayerModel(), gui2::SLDElementController::connectMaterialModel(), gui2::SLDElementController::connectSLDElementModel(), gui2::SLDElementController::disconnectLayerModel(), gui2::SLDElementController::disconnectMaterialModel(), gui2::SLDElementController::disconnectSLDElementModel(), MockWidgetForModel::setModel(), ModelView::ModelListenerBase::setOnAboutToRemoveItem(), ModelView::ModelListenerBase::setOnDataChange(), ModelView::ModelListenerBase::setOnItemInserted(), ModelView::ModelListenerBase::setOnItemRemoved(), ModelView::ModelListenerBase::setOnModelAboutToBeReset(), ModelView::ModelListenerBase::setOnModelDestroyed(), ModelView::ModelListenerBase::setOnModelReset(), and ModelView::ModelListenerBase::unsubscribe().

◆ material_data()

std::vector< ExternalProperty > MaterialModel::material_data ( std::string container_id = std::string() ) const

Returns vector of properties representing possible choice of materials for the given container.

Here we assume that all materials seats in top level material containers. If no container_id was given, the very first container is examined.

Definition at line 78 of file materialmodel.cpp.

 {
     std::vector<ExternalProperty> result;
     const auto containers = rootItem()->children();
     if (!containers.empty() && container_id.empty())
         container_id = topItem<MaterialContainerItem>()->identifier();
  
     for (auto container : containers) {
         if (container->identifier() != container_id)
             continue;
         for (auto item : container->children()) {
             if (auto material = dynamic_cast<MaterialBaseItem*>(item))
                 result.push_back(material->external_property());
         }
     }
     return result;
 }

References ModelView::SessionItem::children(), and ModelView::SessionModel::rootItem().

Referenced by material_property().

Here is the call graph for this function:

◆ material_property()

ExternalProperty MaterialModel::material_property ( const std::string & id )

Returns property from given material id.

Definition at line 98 of file materialmodel.cpp.

 {
     for (const auto& prop : material_data())
         if (prop.identifier() == id)
             return prop;
  
     return ExternalProperty::undefined();
 }

References material_data(), and ModelView::ExternalProperty::undefined().

Here is the call graph for this function:

◆ materialContainer()

MaterialContainerItem * MaterialModel::materialContainer ( )

private

Definition at line 141 of file materialmodel.cpp.

 {
     return topItem<MaterialContainerItem>();
 }

Referenced by addDefaultMaterial().

◆ modelType()

std::string SessionModel::modelType ( ) const

inherited

Returns model type.

Definition at line 133 of file sessionmodel.cpp.

 {
     return p_impl->m_modelType;
 }

References ModelView::SessionModel::p_impl.

Referenced by ModelView::JsonModelConverter::from_json(), ModelView::SessionModel::insertNewItem(), ModelView::SessionModel::intern_register(), ModelView::SessionModel::registerItem(), ModelView::ProjectUtils::SuggestFileName(), and ModelView::JsonModelConverter::to_json().

◆ moveItem()

void SessionModel::moveItem	(	SessionItem *	item,
		SessionItem *	new_parent,
		const TagRow &	tagrow
	)

inherited

Move item from it's current parent to a new parent under given tag and row.

Old and new parents should belong to this model.

Definition at line 104 of file sessionmodel.cpp.

 {
     p_impl->m_commands->moveItem(item, new_parent, tagrow);
 }

References ModelView::SessionModel::p_impl.

Referenced by gui2::DataViewModel::dropMimeData(), gui2::ExperimentalDataModel::mergeCanvases(), ModelView::Utils::MoveDown(), ModelView::Utils::MoveUp(), and TEST_F().

◆ registerInPool()

void SessionModel::registerInPool ( SessionItem * item )

privateinherited

Registers item in pool. This will allow to find item pointer using its unique identifier.

Definition at line 207 of file sessionmodel.cpp.

 {
     p_impl->m_itemManager->registerInPool(item);
     item->activate(); // activates buisiness logic
 }

References ModelView::SessionItem::activate(), and ModelView::SessionModel::p_impl.

Here is the call graph for this function:

◆ registerItem()

template<typename T >

void SessionModel::registerItem ( const std::string & label = {} )

inherited

Register used defined item to use with the model.

It will become possible to undo/redo operations with this item, as well as serialize it to/from JSON.

Definition at line 135 of file sessionmodel.h.

 {
     intern_register(T().modelType(), ItemFactoryFunction<T>(), label);
 }

References ModelView::SessionModel::intern_register(), and ModelView::SessionModel::modelType().

Referenced by TEST_F().

Here is the call graph for this function:

◆ removeItem()

void SessionModel::removeItem	(	SessionItem *	parent,
		const TagRow &	tagrow
	)

inherited

Removes given row from parent.

Definition at line 96 of file sessionmodel.cpp.

 {
     p_impl->m_commands->removeItem(parent, tagrow);
 }

References ModelView::SessionModel::p_impl.

Referenced by ModelView::Utils::DeleteItemFromModel(), gui2::ExperimentalDataModel::mergeCanvases(), gui2::ExperimentalDataModel::removeCanvas(), gui2::ExperimentalDataModel::removeGraph(), TEST(), and TEST_F().

◆ rootItem()

SessionItem * SessionModel::rootItem ( ) const

inherited

Returns root item of the model.

Definition at line 140 of file sessionmodel.cpp.

 {
     return p_impl->m_root_item.get();
 }

References ModelView::SessionModel::p_impl.

Referenced by gui2::SLDElementController::buildSLD(), ModelView::SessionModel::clear(), ViewModelControllerTest::create_controller(), ModelView::Utils::FindItems(), ModelView::JsonModelConverter::from_json(), gui2::ExperimentalDataModel::init_model(), ModelView::CommandService::insertNewItem(), ModelView::Utils::ItemFromPath(), material_data(), ModelView::ItemMapper::ItemMapperImpl::nestlingDepth(), TEST(), TEST_F(), ModelView::JsonModelConverter::to_json(), ModelView::SessionModel::topItems(), and ModelView::Utils::TopItems().

◆ setData()

bool SessionModel::setData	(	SessionItem *	item,
		const Variant &	value,
		int	role
	)

inherited

Sets the data for given item.

Definition at line 126 of file sessionmodel.cpp.

 {
     return p_impl->m_commands->setData(item, value, role);
 }

References ModelView::SessionModel::p_impl.

Referenced by ModelView::SessionItem::set_data_internal(), TEST(), and TEST_F().

◆ setItemCatalogue()

void SessionModel::setItemCatalogue ( std::unique_ptr< ItemCatalogue > catalogue )

inherited

Sets brand new catalog of user-defined items.

They become available for undo/redo and serialization. Internally user catalog will be merged with the catalog of standard items.

Definition at line 176 of file sessionmodel.cpp.

 {
     // adding standard items to the user catalogue
     std::unique_ptr<ItemCatalogue> full_catalogue = std::move(catalogue);
     full_catalogue->merge(*CreateStandardItemCatalogue());
     p_impl->m_itemManager->setItemFactory(std::make_unique<ItemFactory>(std::move(full_catalogue)));
 }

References ModelView::CreateStandardItemCatalogue(), and ModelView::SessionModel::p_impl.

Referenced by ToyItems::SampleModel::SampleModel(), gui2::SampleModel::SampleModel(), gui2::SLDElementModel::SLDElementModel(), gui2::ExperimentalDataModel::init_model(), and init_model().

Here is the call graph for this function:

◆ setUndoRedoEnabled()

void SessionModel::setUndoRedoEnabled ( bool value )

inherited

Sets undo/redo either enabled or disabled. By default undo/redo is disabled.

Definition at line 186 of file sessionmodel.cpp.

 {
     p_impl->m_commands->setUndoRedoEnabled(value);
 }

References ModelView::SessionModel::p_impl.

Referenced by gui2::ExperimentalDataModel::init_model(), and TEST_F().

◆ topItem()

template<typename T >

T * SessionModel::topItem

inherited

Returns top item of the given type.

If more than one item exists, return the first one. The top item is an item that is a child of an invisible root item.

Definition at line 126 of file sessionmodel.h.

 {
     auto items = topItems<T>();
     return items.empty() ? nullptr : items.front();
 }

Referenced by gui2::SimPlotController::onInstrumentChange(), gui2::QuickSimController::process_multilayer(), gui2::LayerEditorWidget::setModels(), gui2::InstrumentPropertyEditor::setModels(), gui2::QuickSimController::submit_specular_simulation(), and TEST_F().

◆ topItems()

template<typename T >

std::vector< T * > SessionModel::topItems

inherited

Returns top items of the given type.

The top item is an item that is a child of an invisible root item.

Definition at line 112 of file sessionmodel.h.

 {
     std::vector<T*> result;
     for (auto child : rootItem()->children()) {
         if (auto item = dynamic_cast<T*>(child))
             result.push_back(item);
     }
  
     return result;
 }

References ModelView::SessionModel::rootItem().

Referenced by TEST_F().

Here is the call graph for this function:

◆ undoStack()

UndoStackInterface * SessionModel::undoStack ( ) const

inherited

Returns command stack to perform undo/redo.

Definition at line 154 of file sessionmodel.cpp.

 {
     return p_impl->m_commands->undoStack();
 }

References ModelView::SessionModel::p_impl.

Referenced by ModelView::Utils::BeginMacros(), ModelView::SessionModel::clear(), ModelView::Utils::EndMacros(), gui2::ImportDataEditorActions::isUndoEnabled(), gui2::ImportDataEditorActions::onRedo(), gui2::ImportDataEditorActions::onUndo(), ModelView::Utils::Redo(), ModelView::SessionItem::set_data_internal(), TEST_F(), ModelView::Utils::Undo(), and gui2::ImportDataEditorActions::undoStack().

◆ unregisterFromPool()

void SessionModel::unregisterFromPool ( SessionItem * item )

privateinherited

Unregister item from pool.

Definition at line 215 of file sessionmodel.cpp.

 {
     p_impl->m_itemManager->unregisterFromPool(item);
 }

References ModelView::SessionModel::p_impl.

Member Data Documentation

◆ p_impl

std::unique_ptr<SessionModelImpl> ModelView::SessionModel::p_impl

privateinherited

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

/home/www/ba/gui2/model/materialmodel.h
/home/www/ba/gui2/model/materialmodel.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MaterialModel()

Member Function Documentation

◆ addDefaultMaterial()

◆ clear()

◆ cloneMaterial()

◆ copyItem()

◆ data()

◆ factory()

◆ findItem()

◆ init_model()

◆ insertItem()

◆ insertNewItem()

◆ intern_insert()

◆ intern_register()

◆ mapper()

◆ material_data()

◆ material_property()

◆ materialContainer()

◆ modelType()

◆ moveItem()

◆ registerInPool()

◆ registerItem()

◆ removeItem()

◆ rootItem()

◆ setData()

◆ setItemCatalogue()

◆ setUndoRedoEnabled()

◆ topItem()

◆ topItems()

◆ undoStack()

◆ unregisterFromPool()

Member Data Documentation

◆ p_impl