qquicksprite.cpp

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#include "qquicksprite_p.h"
#include "qquickimagebase_p.h"
#include <qqml.h>
#include <QQmlContext>
#include <QDebug>
#include <QRandomGenerator>
 
QT_BEGIN_NAMESPACE
 
static const int unsetDuration = -2;//-1 means perframe for duration
QQuickSprite::QQuickSprite(QObject *parent)
    : QQuickStochasticState(parent)
    , m_generatedCount(0)
    , m_framesPerRow(0)
    , m_rowY(0)
    , m_rowStartX(0)
    , m_reverse(false)
    , m_frameHeight(0)
    , m_frameWidth(0)
    , m_frames(1)
    , m_frameX(0)
    , m_frameY(0)
    , m_frameRate(unsetDuration)
    , m_frameRateVariation(0)
    , m_frameDuration(unsetDuration)
    , m_frameDurationVariation(0)
    , m_frameSync(false)
    , m_devicePixelRatio(1.0)
{
}
 
QQuickSprite::~QQuickSprite()
{
}
 
int QQuickSprite::variedDuration() const //Deals with precedence when multiple durations are set
{
    if (m_frameSync)
        return 0;
 
    if (m_frameRate != unsetDuration) {
        qreal fpms = (m_frameRate
                + (m_frameRateVariation * QRandomGenerator::global()->generateDouble() * 2)
                - m_frameRateVariation) / 1000.0;
        return qMax(qreal(0.0) , m_frames / fpms);
    } else if (m_frameDuration != unsetDuration) {
        int mspf = m_frameDuration
                + (m_frameDurationVariation * QRandomGenerator::global()->generateDouble() * 2)
                - m_frameDurationVariation;
        return qMax(0, m_frames * mspf);
    } else if (duration() >= 0) {
        qWarning() << "Sprite::duration is changing meaning to the full animation duration.";
        qWarning() << "Use Sprite::frameDuration for the old meaning, of per frame duration.";
        qWarning() << "As an interim measure, duration/durationVariation means the same as frameDuration/frameDurationVariation, and you'll get this warning spewed out everywhere to motivate you.";
    //Note that the spammyness is due to this being the best location to detect, but also called once each animation loop
        return QQuickStochasticState::variedDuration() * m_frames;
    }
    return 1000; //When nothing set
}
 
void QQuickSprite::startImageLoading()
{
    m_pix.clear(this);
    if (!m_source.isEmpty()) {
        const QQmlContext *context = qmlContext(this);
        QQmlEngine *e = context ? context->engine() : nullptr;
        if (!e) { //If not created in QML, you must set the QObject parent to the QML element so this can work
            context = qmlContext(parent());
            e = context ? context->engine() : nullptr;
            if (!e)
                qWarning() << "QQuickSprite: Cannot find QQmlEngine - this class is only for use in QML and may not work";
        }
        const QUrl resolvedUrl = context ? context->resolvedUrl(m_source) : m_source;
        QUrl loadUrl = resolvedUrl;
        QQuickImageBase::resolve2xLocalFile(resolvedUrl, m_devicePixelRatio, &loadUrl,
                                            &m_devicePixelRatio);
 
        m_pix.load(e, loadUrl);
    }
}
 
QT_END_NAMESPACE
 
#include "moc_qquicksprite_p.cpp"