RealSpaceCanvas Class Reference

Description

Provides 3D object generation for RealSpace presentation.

Definition at line 42 of file RealSpaceCanvas.h.

Inheritance diagram for RealSpaceCanvas:

Collaboration diagram for RealSpaceCanvas:

Public Types
using	ItemForRealSpace = std::variant< MultiLayerItem *, LayerItem *, ParticleLayoutItem *, ItemWithParticles * >
	Defines the item types which can be the "current item". More...

Public Member Functions
	RealSpaceCanvas (QWidget *parent=nullptr)
void	changeLayerSize (double layerSizeChangeScale)
template<typename T >
T	currentItemAs () const
void	defaultView ()
void	resetScene ()
void	savePicture ()
void	setCurrentItem (MultiLayerItem *containingMultiLayerItem, ItemForRealSpace item)
void	sideView ()
void	topView ()
void	updateScene ()

Protected Member Functions
void	showEvent (QShowEvent *) override

Private Member Functions
void	savePicture (const QPixmap &pixmap)

Private Attributes
CautionSign *	m_cautionSign
MultiLayerItem *	m_containingMultiLayerItem
std::optional< ItemForRealSpace >	m_currentItem
bool	m_firstView
std::unique_ptr< GUI::RealSpace::Model >	m_realSpaceModel
SceneGeometry	m_sceneGeometry
GUI::RealSpace::Canvas *	m_view

Member Typedef Documentation

ItemForRealSpace

using RealSpaceCanvas::ItemForRealSpace = std::variant<MultiLayerItem*, LayerItem*, ParticleLayoutItem*, ItemWithParticles*>

Defines the item types which can be the "current item".

Definition at line 47 of file RealSpaceCanvas.h.

Constructor & Destructor Documentation

RealSpaceCanvas()

RealSpaceCanvas::RealSpaceCanvas

(

QWidget *

parent = nullptr

)

Definition at line 31 of file RealSpaceCanvas.cpp.

    : QWidget(parent)
    , m_view(new GUI::RealSpace::Canvas)
    , m_cautionSign(new CautionSign(this))
    , m_containingMultiLayerItem(nullptr)
    , m_firstView(true)
{
    auto* layout = new QVBoxLayout;
    layout->setMargin(0);
    layout->setSpacing(0);
    layout->addWidget(m_view);
    setLayout(layout);
}

References m_view.

Member Function Documentation

changeLayerSize()

void RealSpaceCanvas::changeLayerSize

(

double

layerSizeChangeScale

)

Definition at line 60 of file RealSpaceCanvas.cpp.

{
    // when no object is selected --> take no action
    if (!m_currentItem)
        return;
 
    m_sceneGeometry.layerSize = m_sceneGeometry.layerSize * layerSizeChangeScale;
    updateScene();
}

References SceneGeometry::layerSize, m_currentItem, m_sceneGeometry, and updateScene().

Referenced by RealSpacePanel::RealSpacePanel().

Here is the call graph for this function:

currentItemAs()

template<typename T >

T RealSpaceCanvas::currentItemAs

Definition at line 79 of file RealSpaceCanvas.h.

{
    if (!m_currentItem)
        return nullptr;
 
    auto currentVariant = m_currentItem.value();
    T* ppCurrent = std::get_if<T>(&currentVariant);
    return ppCurrent ? *ppCurrent : nullptr;
}

References m_currentItem.

Referenced by SampleView::onAboutToRemoveItem().

defaultView()

void RealSpaceCanvas::defaultView

(

)

Definition at line 152 of file RealSpaceCanvas.cpp.

{
    m_view->defaultView();
}

References GUI::RealSpace::Canvas::defaultView(), and m_view.

Referenced by RealSpacePanel::RealSpacePanel(), and setCurrentItem().

Here is the call graph for this function:

resetScene()

void RealSpaceCanvas::resetScene

(

)

Definition at line 144 of file RealSpaceCanvas.cpp.

{
    m_realSpaceModel.reset();
    m_view->setModel(nullptr);
    m_currentItem.reset();
    m_containingMultiLayerItem = nullptr;
}

References m_containingMultiLayerItem, m_currentItem, m_realSpaceModel, m_view, and GUI::RealSpace::Canvas::setModel().

Referenced by setCurrentItem().

Here is the call graph for this function:

savePicture() [1/2]

void RealSpaceCanvas::savePicture

(

)

Definition at line 70 of file RealSpaceCanvas.cpp.

{
    QPixmap pixmap(this->size());
    render(&pixmap, QPoint(), childrenRegion());
    savePicture(pixmap);
}

Referenced by RealSpacePanel::RealSpacePanel().

savePicture() [2/2]

void RealSpaceCanvas::savePicture ( const QPixmap &  pixmap )

private

Definition at line 85 of file RealSpaceCanvas.cpp.

{
    QString dirname = gSessionData->projectDocument.value()->userExportDir();
    QString defaultExtension = ".png";
    QString selectedFilter("*" + defaultExtension);
    QString defaultName = dirname + "/untitled";
    QString fileName = QFileDialog::getSaveFileName(
        nullptr, "Save 3D real space view", defaultName, selectedFilter, nullptr,
        appSettings->useNativeFileDialog() ? QFileDialog::Options()
                                           : QFileDialog::DontUseNativeDialog);
    QString nameToSave =
        fileName.endsWith(defaultExtension) ? fileName : fileName + defaultExtension;
 
    if (!nameToSave.isEmpty()) {
        try {
            pixmap.save(nameToSave);
        } catch (const std::exception& ex) {
            QString message = "Attempt to save file with the name '";
            message.append(nameToSave);
            message.append("' has failed with following error message\n\n");
            message.append(QString::fromStdString(ex.what()));
            QMessageBox::warning(nullptr, "Houston, we have a problem.", message);
        }
    }
}

References appSettings, gSessionData, SessionData::projectDocument, ApplicationSettings::useNativeFileDialog(), and GUI::View::Helpers::warning().

Here is the call graph for this function:

setCurrentItem()

void RealSpaceCanvas::setCurrentItem	(	MultiLayerItem *	containingMultiLayerItem,
		ItemForRealSpace	item
	)

Definition at line 45 of file RealSpaceCanvas.cpp.

{
    bool isValid = false;
    std::visit([&](auto&& arg) { isValid = arg != nullptr; }, item);
 
    if (isValid) {
        m_containingMultiLayerItem = containingMultiLayerItem;
        m_currentItem = item;
        updateScene();
        defaultView(); // Enforces default view and also sets the zoomLevel to default i.e. 0
    } else
        resetScene();
}

References defaultView(), m_containingMultiLayerItem, m_currentItem, resetScene(), and updateScene().

Referenced by SampleView::onRequestViewInRealSpace().

Here is the call graph for this function:

showEvent()

void RealSpaceCanvas::showEvent ( QShowEvent *  )

overrideprotected

Definition at line 77 of file RealSpaceCanvas.cpp.

{
    updateScene();
    if (m_firstView)
        m_view->defaultView();
    m_firstView = false;
}

References GUI::RealSpace::Canvas::defaultView(), m_firstView, m_view, and updateScene().

Here is the call graph for this function:

sideView()

void RealSpaceCanvas::sideView

(

)

Definition at line 157 of file RealSpaceCanvas.cpp.

{
    m_view->sideView();
}

References m_view, and GUI::RealSpace::Canvas::sideView().

Referenced by RealSpacePanel::RealSpacePanel().

Here is the call graph for this function:

topView()

void RealSpaceCanvas::topView

(

)

Definition at line 162 of file RealSpaceCanvas.cpp.

{
    m_view->topView();
}

References m_view, and GUI::RealSpace::Canvas::topView().

Referenced by RealSpacePanel::RealSpacePanel().

Here is the call graph for this function:

updateScene()

void RealSpaceCanvas::updateScene

(

)

Definition at line 111 of file RealSpaceCanvas.cpp.

{
    if (!isVisible()) // to improve performance
        return;
 
    if (!m_view->isValid()) // GL not initialized (widget not shown so far) -> no updating possible
        return;
 
    QApplication::setOverrideCursor(Qt::WaitCursor);
 
    m_realSpaceModel = std::make_unique<GUI::RealSpace::Model>();
 
    const auto colorForMaterialName = [&](const QString& materialName) {
        return m_containingMultiLayerItem->materialItems().materialFromName(materialName)->color();
    };
 
    RealSpaceBuilder builder3D(colorForMaterialName);
 
    try {
        m_cautionSign->clear();
        if (m_currentItem)
            builder3D.populate(m_realSpaceModel.get(), *m_currentItem, m_sceneGeometry,
                               m_view->cam()->getPos());
    } catch (const std::exception& ex) {
        m_cautionSign->setCautionMessage(ex.what());
    } catch (...) {
        // ignore other exceptions thrown
    }
    m_view->setModel(m_realSpaceModel.get());
 
    QApplication::restoreOverrideCursor();
}

References GUI::RealSpace::Canvas::cam(), CautionSign::clear(), MaterialItem::color(), GUI::RealSpace::Camera::getPos(), m_cautionSign, m_containingMultiLayerItem, m_currentItem, m_realSpaceModel, m_sceneGeometry, m_view, MaterialItems::materialFromName(), MultiLayerItem::materialItems(), RealSpaceBuilder::populate(), CautionSign::setCautionMessage(), and GUI::RealSpace::Canvas::setModel().

Referenced by SampleView::SampleView(), changeLayerSize(), setCurrentItem(), and showEvent().

Here is the call graph for this function:

Member Data Documentation

m_cautionSign

CautionSign* RealSpaceCanvas::m_cautionSign

private

Definition at line 72 of file RealSpaceCanvas.h.

Referenced by updateScene().

m_containingMultiLayerItem

MultiLayerItem* RealSpaceCanvas::m_containingMultiLayerItem

private

Definition at line 74 of file RealSpaceCanvas.h.

Referenced by resetScene(), setCurrentItem(), and updateScene().

m_currentItem

std::optional<ItemForRealSpace> RealSpaceCanvas::m_currentItem

private

Definition at line 73 of file RealSpaceCanvas.h.

Referenced by changeLayerSize(), currentItemAs(), resetScene(), setCurrentItem(), and updateScene().

m_firstView

bool RealSpaceCanvas::m_firstView

private

Definition at line 75 of file RealSpaceCanvas.h.

Referenced by showEvent().

m_realSpaceModel

std::unique_ptr<GUI::RealSpace::Model> RealSpaceCanvas::m_realSpaceModel

private

Definition at line 70 of file RealSpaceCanvas.h.

Referenced by resetScene(), and updateScene().

m_sceneGeometry

SceneGeometry RealSpaceCanvas::m_sceneGeometry

private

Definition at line 71 of file RealSpaceCanvas.h.

Referenced by changeLayerSize(), and updateScene().

m_view

GUI::RealSpace::Canvas* RealSpaceCanvas::m_view

private

Definition at line 69 of file RealSpaceCanvas.h.

Referenced by RealSpaceCanvas(), defaultView(), resetScene(), showEvent(), sideView(), topView(), and updateScene().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Realspace/RealSpaceCanvas.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Realspace/RealSpaceCanvas.cpp