summaryrefslogtreecommitdiffstats
path: root/src/core/jobs/qaspectjob.cpp
blob: 29eb32b6a14ef85a415295a1223d1dd46eefb629 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
// Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#include "qaspectjob.h"
#include "qaspectjob_p.h"

#include <Qt3DCore/qaspectengine.h>
#include <Qt3DCore/private/qaspectengine_p.h>

#include <QtCore/QByteArray>

QT_BEGIN_NAMESPACE

namespace Qt3DCore {

namespace {

bool isDependencyNull(const QWeakPointer<QAspectJob> &dep)
{
    return dep.isNull();
}

} // anonymous

QAspectJobPrivate::QAspectJobPrivate()
    : m_jobName(QLatin1String("UnknowJob"))
{
}

QAspectJobPrivate::~QAspectJobPrivate() = default;

QAspectJobPrivate *QAspectJobPrivate::get(QAspectJob *job)
{
    return job->d_func();
}

bool QAspectJobPrivate::isRequired() const
{
    return true;
}

void QAspectJobPrivate::postFrame(QAspectManager *aspectManager)
{
    Q_UNUSED(aspectManager);
}

QAspectJob::QAspectJob()
    : d_ptr(new QAspectJobPrivate)
{
}

/*!
 * \class Qt3DCore::QAspectJob
 * \inheaderfile Qt3DCore/QAspectJob
 * \inmodule Qt3DCore
 * \brief The base class for jobs executed in an aspect.
 */

/*!
 * \fn void Qt3DCore::QAspectJob::run()
 * Executes the job. This is called on a separate thread by the scheduler.
 */

/*!
 * \internal
 */
QAspectJob::QAspectJob(QAspectJobPrivate &dd)
    : d_ptr(&dd)
{
}

QAspectJob::~QAspectJob()
{
    delete d_ptr;
}

/*!
 * Adds \a dependency to the aspect job.
 */
void QAspectJob::addDependency(QWeakPointer<QAspectJob> dependency)
{
    Q_D(QAspectJob);
    d->m_dependencies.push_back(dependency);
#ifdef QT3DCORE_ASPECT_JOB_DEBUG
    static int threshold = qMax(1, qgetenv("QT3DCORE_ASPECT_JOB_DEPENDENCY_THRESHOLD").toInt());
    if (d->m_dependencies.count() > threshold)
        qWarning() << "Suspicious number of job dependencies found";
#endif
}

/*!
 * Removes the given \a dependency from aspect job.
 */
void QAspectJob::removeDependency(QWeakPointer<QAspectJob> dependency)
{
    Q_D(QAspectJob);
    if (!dependency.isNull()) {
        d->m_dependencies.erase(std::remove(d->m_dependencies.begin(),
                                            d->m_dependencies.end(),
                                            dependency),
                                d->m_dependencies.end());
    } else {
        d->m_dependencies.erase(std::remove_if(d->m_dependencies.begin(),
                                               d->m_dependencies.end(),
                                               isDependencyNull),
                                d->m_dependencies.end());
    }
}

/*!
 * \return the dependencies of the aspect job.
 */
const std::vector<QWeakPointer<QAspectJob> > &QAspectJob::dependencies() const
{
    Q_D(const QAspectJob);
    return d->m_dependencies;
}

/*!
 * Called in the main thread when all the jobs have completed.
 * This is a good point to push changes back to the frontend.
 * \a aspectEngine is the engine responsible for the run loop.
 */
void QAspectJob::postFrame(QAspectEngine *aspectEngine)
{
    Q_D(QAspectJob);
    if (aspectEngine) {
        auto manager = QAspectEnginePrivate::get(aspectEngine)->m_aspectManager;
        d->postFrame(manager);
    }
}

/*!
 * Should return true (default) if the job has actually something to do.
 * If returning false, the job will not be scheduled (but it's dependencies
 * will be).
 */
bool QAspectJob::isRequired()
{
    Q_D(QAspectJob);
    return d->isRequired();
}

} // namespace Qt3DCore

QT_END_NAMESPACE