| /**************************************************************************** |
| ** |
| ** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB). |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the Qt3D module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #include "qrenderpassfilter.h" |
| #include "qrenderpassfilter_p.h" |
| |
| #include <Qt3DRender/qfilterkey.h> |
| #include <Qt3DRender/qparameter.h> |
| #include <Qt3DRender/qframegraphnodecreatedchange.h> |
| |
| QT_BEGIN_NAMESPACE |
| |
| using namespace Qt3DCore; |
| |
| namespace Qt3DRender { |
| |
| /*! |
| \class Qt3DRender::QRenderPassFilter |
| \inmodule Qt3DRender |
| \since 5.7 |
| \brief Provides storage for vectors of Filter Keys and Parameters. |
| |
| A Qt3DRender::QRenderPassFilter FrameGraph node is used to select which |
| Qt3DRender::QRenderPass objects are selected for drawing. QRenderPassFilter |
| specifies a list of Qt3DRender::QFilterKey objects and Qt3DRender::QParameter objects. |
| When QRenderPassFilter is present in the FrameGraph, only the QRenderPass objects, |
| whose Qt3DRender::QFilterKey objects match the keys in QRenderPassFilter are |
| selected for rendering. If no QRenderPassFilter is present, then all QRenderPass |
| objects are selected for rendering. The parameters in the list can be used |
| to set values for shader parameters. The parameters in QRenderPassFilter are |
| overridden by parameters in QTechniqueFilter, QTechnique and QRenderPass. |
| */ |
| |
| /*! |
| \qmltype RenderPassFilter |
| \inqmlmodule Qt3D.Render |
| \since 5.7 |
| \instantiates Qt3DRender::QRenderPassFilter |
| \inherits FrameGraphNode |
| \brief Provides storage for vectors of Filter Keys and Parameters. |
| |
| A RenderPassFilter FrameGraph node is used to select which RenderPass |
| objects are selected for drawing. When RenderPassFilter is present in the FrameGraph, |
| only the RenderPass objects, whose FilterKey objects match the keys |
| in RenderPassFilter are selected for rendering. If no RenderPassFilter is present, |
| then all RenderPass objects are selected for rendering. |
| */ |
| |
| /*! |
| \qmlproperty list<FilterKey> RenderPassFilter::matchAny |
| Holds the list of filterkeys used by the RenderPassFilter |
| */ |
| /*! |
| \qmlproperty list<Parameter> RenderPassFilter::parameters |
| Holds the list of parameters used by the RenderPassFilter |
| */ |
| |
| |
| /*! |
| The constructor creates an instance with the specified \a parent. |
| */ |
| QRenderPassFilter::QRenderPassFilter(QNode *parent) |
| : QFrameGraphNode(*new QRenderPassFilterPrivate, parent) |
| {} |
| |
| /*! \internal */ |
| QRenderPassFilter::~QRenderPassFilter() |
| { |
| } |
| |
| /*! \internal */ |
| QRenderPassFilter::QRenderPassFilter(QRenderPassFilterPrivate &dd, QNode *parent) |
| : QFrameGraphNode(dd, parent) |
| { |
| } |
| |
| /*! |
| Returns a vector of the current keys for the filter. |
| */ |
| QVector<QFilterKey *> QRenderPassFilter::matchAny() const |
| { |
| Q_D(const QRenderPassFilter); |
| return d->m_matchList; |
| } |
| |
| /*! |
| Add the \a filterKey to the match vector. |
| */ |
| void QRenderPassFilter::addMatch(QFilterKey *filterKey) |
| { |
| Q_ASSERT(filterKey); |
| Q_D(QRenderPassFilter); |
| if (!d->m_matchList.contains(filterKey)) { |
| d->m_matchList.append(filterKey); |
| |
| // Ensures proper bookkeeping |
| d->registerDestructionHelper(filterKey, &QRenderPassFilter::removeMatch, d->m_matchList); |
| |
| // We need to add it as a child of the current node if it has been declared inline |
| // Or not previously added as a child of the current node so that |
| // 1) The backend gets notified about it's creation |
| // 2) When the current node is destroyed, it gets destroyed as well |
| if (!filterKey->parent()) |
| filterKey->setParent(this); |
| |
| d->updateNode(filterKey, "match", Qt3DCore::PropertyValueAdded); |
| } |
| } |
| |
| /*! |
| Remove the \a filterKey from the match vector. |
| */ |
| void QRenderPassFilter::removeMatch(QFilterKey *filterKey) |
| { |
| Q_ASSERT(filterKey); |
| Q_D(QRenderPassFilter); |
| |
| if (!d->m_matchList.removeOne(filterKey)) |
| return; |
| d->updateNode(filterKey, "match", Qt3DCore::PropertyValueRemoved); |
| // Remove bookkeeping connection |
| d->unregisterDestructionHelper(filterKey); |
| } |
| |
| /*! |
| Add the given \a parameter to the parameter vector. |
| */ |
| void QRenderPassFilter::addParameter(QParameter *parameter) |
| { |
| Q_ASSERT(parameter); |
| Q_D(QRenderPassFilter); |
| if (!d->m_parameters.contains(parameter)) { |
| d->m_parameters.append(parameter); |
| |
| // Ensures proper bookkeeping |
| d->registerDestructionHelper(parameter, &QRenderPassFilter::removeParameter, d->m_parameters); |
| |
| // We need to add it as a child of the current node if it has been declared inline |
| // Or not previously added as a child of the current node so that |
| // 1) The backend gets notified about it's creation |
| // 2) When the current node is destroyed, the child parameters get destroyed as well |
| if (!parameter->parent()) |
| parameter->setParent(this); |
| |
| d->updateNode(parameter, "parameter", Qt3DCore::PropertyValueAdded); |
| } |
| } |
| |
| /*! |
| Remove the given \a parameter from the parameter vector. |
| */ |
| void QRenderPassFilter::removeParameter(QParameter *parameter) |
| { |
| Q_ASSERT(parameter); |
| Q_D(QRenderPassFilter); |
| |
| if (!d->m_parameters.removeOne(parameter)) |
| return; |
| d->updateNode(parameter, "parameter", Qt3DCore::PropertyValueRemoved); |
| // Remove bookkeeping connection |
| d->unregisterDestructionHelper(parameter); |
| } |
| |
| /*! |
| Returns the current vector of parameters. |
| */ |
| QVector<QParameter *> QRenderPassFilter::parameters() const |
| { |
| Q_D(const QRenderPassFilter); |
| return d->m_parameters; |
| } |
| |
| Qt3DCore::QNodeCreatedChangeBasePtr QRenderPassFilter::createNodeCreationChange() const |
| { |
| auto creationChange = QFrameGraphNodeCreatedChangePtr<QRenderPassFilterData>::create(this); |
| auto &data = creationChange->data; |
| Q_D(const QRenderPassFilter); |
| data.matchIds = qIdsForNodes(d->m_matchList); |
| data.parameterIds = qIdsForNodes(d->m_parameters); |
| return creationChange; |
| } |
| |
| } // namespace Qt3DRender |
| |
| QT_END_NAMESPACE |