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     \qmlclass SpriteGoal QQuickSpriteGoalAffector
  52     \inqmlmodule QtQuick.Particles 2
  53     \ingroup qtquick-images-sprites
  54     \inherits Affector
  55     \brief For changing the the state of a sprite particle
  56
  57 */
  58 /*!
  59     \qmlproperty string QtQuick.Particles2::SpriteGoal::goalState
  60
  61     The name of the Sprite which the affected particles should move to.
  62
  63     Sprite states have defined durations and transitions between them, setting goalState
  64     will cause it to disregard any path weightings (including 0) and head down the path
  65     which will reach the goalState quickest. It will pass through intermediate states
  66     on that path.
  67 */
  68 /*!
  69     \qmlproperty bool QtQuick.Particles2::SpriteGoal::jump
  70
  71     If true, affected sprites will jump directly to the goal state instead of taking the
  72     the shortest valid path to get there. They will also not finish their current state,
  73     but immediately move to the beginning of the goal state.
  74
  75     Default is false.
  76 */
  77 /*!
  78     \qmlproperty bool QtQuick.Particles2::SpriteGoal::systemStates
  79
  80     deprecated, use GroupGoal instead
  81 */
  82
  83 QQuickSpriteGoalAffector::QQuickSpriteGoalAffector(QQuickItem *parent) :
  84     QQuickParticleAffector(parent),
  85     m_goalIdx(-1),
  86     m_lastEngine(0),
  87     m_jump(false),
  88     m_systemStates(false),
  89     m_notUsingEngine(false)
  90 {
  91     m_ignoresTime = true;
  92 }
  93
  94 void QQuickSpriteGoalAffector::updateStateIndex(QQuickStochasticEngine* e)
  95 {
  96     if (m_systemStates){
  97         m_goalIdx = m_system->groupIds[m_goalState];
  98     }else{
  99         m_lastEngine = e;
 100         for (int i=0; i<e->stateCount(); i++){
 101             if (e->state(i)->name() == m_goalState){
 102                 m_goalIdx = i;
 103                 return;
 104             }
 105         }
 106         m_goalIdx = -1;//Can't find it
 107     }
 108 }
 109
 110 void QQuickSpriteGoalAffector::setGoalState(QString arg)
 111 {
 112     if (m_goalState != arg) {
 113         m_goalState = arg;
 114         emit goalStateChanged(arg);
 115         if (m_goalState.isEmpty())
 116             m_goalIdx = -1;
 117         else
 118             m_goalIdx = -2;
 119     }
 120 }
 121
 122 bool QQuickSpriteGoalAffector::affectParticle(QQuickParticleData *d, qreal dt)
 123 {
 124     Q_UNUSED(dt);
 125     QQuickStochasticEngine *engine = 0;
 126     if (!m_systemStates){
 127         //TODO: Affect all engines
 128         foreach (QQuickParticlePainter *p, m_system->groupData[d->group]->painters)
 129             if (qobject_cast<QQuickImageParticle*>(p))
 130                 engine = qobject_cast<QQuickImageParticle*>(p)->spriteEngine();
 131     }else{
 132         engine = m_system->stateEngine;
 133         if (!engine)
 134             m_notUsingEngine = true;
 135     }
 136     if (!engine && !m_notUsingEngine)
 137         return false;
 138
 139     if (m_goalIdx == -2 || engine != m_lastEngine)
 140         updateStateIndex(engine);
 141     int index = d->index;
 142     if (m_systemStates)
 143         index = d->systemIndex;
 144     if (m_notUsingEngine){//systemStates && no stochastic states defined. So cut out the engine
 145         //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
 146         m_system->moveGroups(d, m_goalIdx);
 147     }else if (engine->curState(index) != m_goalIdx){
 148         engine->setGoal(m_goalIdx, index, m_jump);
 149         return true; //Doesn't affect particle data, but necessary for onceOff
 150     }
 151     return false;
 152 }
 153
 154 QT_END_NAMESPACE