src/quick/particles/qquickgroupgoal.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the Declarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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     \qmlclass GroupGoal QQuickGroupGoalAffector
  52     \inqmlmodule QtQuick.Particles 2
  53     \inherits Affector
  54     \brief The GroupGoal Affector allows you to change the state of a group of a particle.
  55
  56 */
  57 /*!
  58     \qmlproperty string QtQuick.Particles2::GroupGoal::goalState
  59
  60     The name of the group which the affected particles should move to.
  61
  62     Groups can 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 groups
  65     on that path for their respective durations.
  66 */
  67 /*!
  68     \qmlproperty bool QtQuick.Particles2::GroupGoal::jump
  69
  70     If true, affected particles will jump directly to the target group 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 QQuickGroupGoalAffector::QQuickGroupGoalAffector(QQuickItem *parent) :
  78     QQuickParticleAffector(parent), m_jump(false)
  79 {
  80     m_ignoresTime = true;
  81 }
  82
  83 void QQuickGroupGoalAffector::setGoalState(QString arg)
  84 {
  85     if (m_goalState != arg) {
  86         m_goalState = arg;
  87         emit goalStateChanged(arg);
  88     }
  89 }
  90
  91 bool QQuickGroupGoalAffector::affectParticle(QQuickParticleData *d, qreal dt)
  92 {
  93     Q_UNUSED(dt);
  94     QQuickStochasticEngine *engine = m_system->stateEngine;
  95     bool notUsingEngine = false;
  96     if (!engine)
  97         notUsingEngine = true;
  98
  99     int index = d->systemIndex;
 100     int goalIdx = m_system->groupIds[m_goalState];
 101     if (notUsingEngine){//no stochastic states defined. So cut out the engine
 102         //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
 103         m_system->moveGroups(d, goalIdx);
 104         return true;
 105     }else if (engine->curState(index) != goalIdx){
 106         engine->setGoal(goalIdx, index, m_jump);
 107         return true;
 108     }
 109     return false;
 110 }
 111
 112 QT_END_NAMESPACE