src/particles/qquickgroupgoal.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 "qquickgroupgoal_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 GroupGoal
  52     \instantiates QQuickGroupGoalAffector
  53     \inqmlmodule QtQuick.Particles 2
  54     \ingroup qtquick-particles
  55     \inherits Affector
  56     \brief For changing the state of a group of a particle
  57
  58 */
  59 /*!
  60     \qmlproperty string QtQuick.Particles2::GroupGoal::goalState
  61
  62     The name of the group which the affected particles should move to.
  63
  64     Groups can 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 groups
  67     on that path for their respective durations.
  68 */
  69 /*!
  70     \qmlproperty bool QtQuick.Particles2::GroupGoal::jump
  71
  72     If true, affected particles will jump directly to the target group 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 QQuickGroupGoalAffector::QQuickGroupGoalAffector(QQuickItem *parent) :
  80     QQuickParticleAffector(parent), m_jump(false)
  81 {
  82     m_ignoresTime = true;
  83 }
  84
  85 void QQuickGroupGoalAffector::setGoalState(QString arg)
  86 {
  87     if (m_goalState != arg) {
  88         m_goalState = arg;
  89         emit goalStateChanged(arg);
  90     }
  91 }
  92
  93 bool QQuickGroupGoalAffector::affectParticle(QQuickParticleData *d, qreal dt)
  94 {
  95     Q_UNUSED(dt);
  96     QQuickStochasticEngine *engine = m_system->stateEngine;
  97     bool notUsingEngine = false;
  98     if (!engine)
  99         notUsingEngine = true;
 100
 101     int index = d->systemIndex;
 102     int goalIdx = m_system->groupIds[m_goalState];
 103     if (notUsingEngine){//no stochastic states defined. So cut out the engine
 104         //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
 105         m_system->moveGroups(d, goalIdx);
 106         return true;
 107     }else if (engine->curState(index) != goalIdx){
 108         engine->setGoal(goalIdx, index, m_jump);
 109         return true;
 110     }
 111     return false;
 112 }
 113
 114 QT_END_NAMESPACE