src/particles/qquickspritegoal.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQuick module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qquickspritegoal_p.h"
  43 #include <private/qquickspriteengine_p.h>
  44 #include <private/qquicksprite_p.h>
  45 #include "qquickimageparticle_p.h"
  46 #include <QDebug>
  47
  48 QT_BEGIN_NAMESPACE
  49
  50 /*!
  51     \qmltype SpriteGoal
  52     \instantiates QQuickSpriteGoalAffector
  53     \inqmlmodule QtQuick.Particles 2
  54     \ingroup qtquick-images-sprites
  55     \inherits Affector
  56     \brief For changing the the state of a sprite particle
  57
  58 */
  59 /*!
  60     \qmlproperty string QtQuick.Particles2::SpriteGoal::goalState
  61
  62     The name of the Sprite which the affected particles should move to.
  63
  64     Sprite states have defined durations and transitions between them, setting goalState
  65     will cause it to disregard any path weightings (including 0) and head down the path
  66     which will reach the goalState quickest. It will pass through intermediate states
  67     on that path.
  68 */
  69 /*!
  70     \qmlproperty bool QtQuick.Particles2::SpriteGoal::jump
  71
  72     If true, affected sprites will jump directly to the goal state instead of taking the
  73     the shortest valid path to get there. They will also not finish their current state,
  74     but immediately move to the beginning of the goal state.
  75
  76     Default is false.
  77 */
  78 /*!
  79     \qmlproperty bool QtQuick.Particles2::SpriteGoal::systemStates
  80
  81     deprecated, use GroupGoal instead
  82 */
  83
  84 QQuickSpriteGoalAffector::QQuickSpriteGoalAffector(QQuickItem *parent) :
  85     QQuickParticleAffector(parent),
  86     m_goalIdx(-1),
  87     m_lastEngine(0),
  88     m_jump(false),
  89     m_systemStates(false),
  90     m_notUsingEngine(false)
  91 {
  92     m_ignoresTime = true;
  93 }
  94
  95 void QQuickSpriteGoalAffector::updateStateIndex(QQuickStochasticEngine* e)
  96 {
  97     if (m_systemStates){
  98         m_goalIdx = m_system->groupIds[m_goalState];
  99     }else{
 100         m_lastEngine = e;
 101         for (int i=0; i<e->stateCount(); i++){
 102             if (e->state(i)->name() == m_goalState){
 103                 m_goalIdx = i;
 104                 return;
 105             }
 106         }
 107         m_goalIdx = -1;//Can't find it
 108     }
 109 }
 110
 111 void QQuickSpriteGoalAffector::setGoalState(QString arg)
 112 {
 113     if (m_goalState != arg) {
 114         m_goalState = arg;
 115         emit goalStateChanged(arg);
 116         if (m_goalState.isEmpty())
 117             m_goalIdx = -1;
 118         else
 119             m_goalIdx = -2;
 120     }
 121 }
 122
 123 bool QQuickSpriteGoalAffector::affectParticle(QQuickParticleData *d, qreal dt)
 124 {
 125     Q_UNUSED(dt);
 126     QQuickStochasticEngine *engine = 0;
 127     if (!m_systemStates){
 128         //TODO: Affect all engines
 129         foreach (QQuickParticlePainter *p, m_system->groupData[d->group]->painters)
 130             if (qobject_cast<QQuickImageParticle*>(p))
 131                 engine = qobject_cast<QQuickImageParticle*>(p)->spriteEngine();
 132     }else{
 133         engine = m_system->stateEngine;
 134         if (!engine)
 135             m_notUsingEngine = true;
 136     }
 137     if (!engine && !m_notUsingEngine)
 138         return false;
 139
 140     if (m_goalIdx == -2 || engine != m_lastEngine)
 141         updateStateIndex(engine);
 142     int index = d->index;
 143     if (m_systemStates)
 144         index = d->systemIndex;
 145     if (m_notUsingEngine){//systemStates && no stochastic states defined. So cut out the engine
 146         //TODO: It's possible to move to a group that is intermediate and not used by painters or emitters - but right now that will redirect to the default group
 147         m_system->moveGroups(d, m_goalIdx);
 148     }else if (engine->curState(index) != m_goalIdx){
 149         engine->setGoal(m_goalIdx, index, m_jump);
 150         return true; //Doesn't affect particle data, but necessary for onceOff
 151     }
 152     return false;
 153 }
 154
 155 QT_END_NAMESPACE