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