GUI::ExamplesFactory Namespace Reference

Description

Class that generates GUI model from.

Functions
std::tuple< QString, QString >	exampleInfo (const QString &name)
	Returns human readable name and description. More...
QStringList	exampleNames ()
	The internal example name, e.g. for creation with itemizeSample. More...
bool	isValidExampleName (const QString &name)
MultiLayerItem *	itemizeSample (const QString &name)
	Create a sample item of the built-in example with the given internal name. More...

Function Documentation

exampleInfo()

std::tuple< QString, QString > GUI::ExamplesFactory::exampleInfo

(

const QString &

name

)

Returns human readable name and description.

Definition at line 83 of file GUIExamplesFactory.cpp.

{
    ASSERT(isValidExampleName(name));
    auto [title, description, builder] = builders[name];
    return {title, description};
}

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

Referenced by SampleListView::SampleListView().

Here is the call graph for this function:

exampleNames()

QStringList GUI::ExamplesFactory::exampleNames

(

)

The internal example name, e.g. for creation with itemizeSample.

Definition at line 78 of file GUIExamplesFactory.cpp.

{
    return builders.keys();
}

Referenced by SampleListView::SampleListView().

isValidExampleName()

bool GUI::ExamplesFactory::isValidExampleName

(

const QString &

name

)

Definition at line 65 of file GUIExamplesFactory.cpp.

{
    return builders.find(name) != builders.end();
}

References GUI::RealSpace::Particles::name().

Referenced by exampleInfo(), and itemizeSample().

Here is the call graph for this function:

itemizeSample()

MultiLayerItem * GUI::ExamplesFactory::itemizeSample

(

const QString &

name

)

Create a sample item of the built-in example with the given internal name.

Definition at line 70 of file GUIExamplesFactory.cpp.

{
    ASSERT(isValidExampleName(name));
    MultiLayer* sample = std::get<2>(builders[name])();
 
    return GUI::Transform::FromCore::itemizeSample(*sample, name);
}

References isValidExampleName(), GUI::Transform::FromCore::itemizeSample(), and GUI::RealSpace::Particles::name().

Referenced by SampleListModel::createSampleFromExamples().

Here is the call graph for this function: