src/declarative/particles/qsgpointattractor_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   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 #ifndef ATTRACTORAFFECTOR_H
  43 #define ATTRACTORAFFECTOR_H
  44 #include "qsgparticleaffector_p.h"
  45
  46 QT_BEGIN_HEADER
  47
  48 QT_BEGIN_NAMESPACE
  49
  50 QT_MODULE(Declarative)
  51
  52 class QSGAttractorAffector : public QSGParticleAffector
  53 {
  54     Q_OBJECT
  55     Q_PROPERTY(qreal strength READ strength WRITE setStrength NOTIFY strengthChanged)
  56     Q_PROPERTY(qreal pointX READ pointX WRITE setPointX NOTIFY pointXChanged)
  57     Q_PROPERTY(qreal pointY READ pointY WRITE setPointY NOTIFY pointYChanged)
  58     Q_PROPERTY(AffectableParameters affectedParameter READ affectedParameter WRITE setAffectedParameter NOTIFY affectedParameterChanged)
  59     Q_PROPERTY(Proportion proportionalToDistance READ proportionalToDistance WRITE setProportionalToDistance NOTIFY proportionalToDistanceChanged)
  60     Q_ENUMS(AffectableParameters)
  61     Q_ENUMS(Proportion)
  62
  63 public:
  64     enum Proportion{
  65         Constant,
  66         Linear,
  67         Quadratic,
  68         InverseLinear,
  69         InverseQuadratic
  70     };
  71
  72     enum AffectableParameters {
  73         Position,
  74         Velocity,
  75         Acceleration
  76     };
  77
  78     explicit QSGAttractorAffector(QQuickItem *parent = 0);
  79
  80     qreal strength() const
  81     {
  82         return m_strength;
  83     }
  84
  85     qreal pointX() const
  86     {
  87         return m_x;
  88     }
  89
  90     qreal pointY() const
  91     {
  92         return m_y;
  93     }
  94
  95     AffectableParameters affectedParameter() const
  96     {
  97         return m_physics;
  98     }
  99
 100     Proportion proportionalToDistance() const
 101     {
 102         return m_proportionalToDistance;
 103     }
 104
 105 signals:
 106
 107     void strengthChanged(qreal arg);
 108
 109     void pointXChanged(qreal arg);
 110
 111     void pointYChanged(qreal arg);
 112
 113     void affectedParameterChanged(AffectableParameters arg);
 114
 115     void proportionalToDistanceChanged(Proportion arg);
 116
 117 public slots:
 118 void setStrength(qreal arg)
 119 {
 120     if (m_strength != arg) {
 121         m_strength = arg;
 122         emit strengthChanged(arg);
 123     }
 124 }
 125
 126 void setPointX(qreal arg)
 127 {
 128     if (m_x != arg) {
 129         m_x = arg;
 130         emit pointXChanged(arg);
 131     }
 132 }
 133
 134 void setPointY(qreal arg)
 135 {
 136     if (m_y != arg) {
 137         m_y = arg;
 138         emit pointYChanged(arg);
 139     }
 140 }
 141 void setAffectedParameter(AffectableParameters arg)
 142 {
 143     if (m_physics != arg) {
 144         m_physics = arg;
 145         emit affectedParameterChanged(arg);
 146     }
 147 }
 148
 149 void setProportionalToDistance(Proportion arg)
 150 {
 151     if (m_proportionalToDistance != arg) {
 152         m_proportionalToDistance = arg;
 153         emit proportionalToDistanceChanged(arg);
 154     }
 155 }
 156
 157 protected:
 158     virtual bool affectParticle(QSGParticleData *d, qreal dt);
 159 private:
 160 qreal m_strength;
 161 qreal m_x;
 162 qreal m_y;
 163 AffectableParameters m_physics;
 164 Proportion m_proportionalToDistance;
 165 };
 166
 167 QT_END_NAMESPACE
 168 QT_END_HEADER
 169 #endif // ATTRACTORAFFECTOR_H