src/quick/particles/qquickfriction.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 "qquickfriction_p.h"
  43 QT_BEGIN_NAMESPACE
  44 /*!
  45     \qmlclass Friction QQuickFrictionAffector
  46     \inqmlmodule QtQuick.Particles 2
  47     \inherits Affector
  48     \brief The Friction affector slows down movement proportional to the particle's current speed.
  49
  50 */
  51
  52 /*!
  53     \qmlproperty real QtQuick.Particles2::Friction::factor
  54
  55     A drag will be applied to moving objects which is this factor of their current velocity.
  56 */
  57 /*!
  58     \qmlproperty real QtQuick.Particles2::Friction::threshold
  59
  60     The drag will only be applied to objects with a velocity above the threshold velocity. The
  61     drag applied will bring objects down to the threshold velocity, but no further.
  62
  63     The default threshold is 0
  64 */
  65 static qreal sign(qreal a)
  66 {
  67     return a >= 0 ? 1 : -1;
  68 }
  69
  70 static const qreal epsilon = 0.00001;
  71
  72 QQuickFrictionAffector::QQuickFrictionAffector(QQuickItem *parent) :
  73     QQuickParticleAffector(parent), m_factor(0.0), m_threshold(0.0)
  74 {
  75 }
  76
  77 bool QQuickFrictionAffector::affectParticle(QQuickParticleData *d, qreal dt)
  78 {
  79     if (!m_factor)
  80         return false;
  81     qreal curVX = d->curVX();
  82     qreal curVY = d->curVY();
  83     if (!curVX && !curVY)
  84         return false;
  85     qreal newVX = curVX + (curVX * m_factor * -1 * dt);
  86     qreal newVY = curVY + (curVY * m_factor * -1 * dt);
  87
  88     if (!m_threshold) {
  89         if (sign(curVX) != sign(newVX))
  90             newVX = 0;
  91         if (sign(curVY) != sign(newVY))
  92             newVY = 0;
  93     } else {
  94         qreal curMag = sqrt(curVX*curVX + curVY*curVY);
  95         if (curMag <= m_threshold + epsilon)
  96             return false;
  97         qreal newMag = sqrt(newVX*newVX + newVY*newVY);
  98         if (newMag <= m_threshold + epsilon || //went past the threshold, stop there instead
  99             sign(curVX) != sign(newVX) || //went so far past maybe it came out the other side!
 100             sign(curVY) != sign(newVY)) {
 101             qreal theta = atan2(curVY, curVX);
 102             newVX = m_threshold * cos(theta);
 103             newVY = m_threshold * sin(theta);
 104         }
 105     }
 106
 107     d->setInstantaneousVX(newVX);
 108     d->setInstantaneousVY(newVY);
 109     return true;
 110 }
 111 QT_END_NAMESPACE