Fix affected signal and docs

Signal wasn't being called in its primary usecase, which was to interact
without altering the particles. Docs have been updated to clarify the
usecase as well.

This also updates the position properties of custom affector to more
accurately specify if they caused changes.

Change-Id: Ia411d9e81002443a56ed8bab9232f1aad49a4c5e
Reviewed-by: Yunqiao Yin <charles.yin@nokia.com>

2 files changed, 104 insertions, 0 deletions

diff --git a/tests/auto/particles/qquickcustomaffector/data/affectedSignal.qml b/tests/auto/particles/qquickcustomaffector/data/affectedSignal.qml
new file mode 100644
index 0000000000..71f343a358
--- /dev/null
+++ b/tests/auto/particles/qquickcustomaffector/data/affectedSignal.qml
@@ -0,0 +1,90 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import QtQuick.Particles 2.0
+
+Rectangle {
+    color: "black"
+    width: 320
+    height: 320
+
+    ParticleSystem {
+        id: sys
+        objectName: "system"
+        anchors.fill: parent
+        property real resultX1: 1234
+        property real resultY1: 1234
+        property real resultX2: 1234
+        property real resultY2: 1234
+
+        ImageParticle {
+            source: "../../shared/star.png"
+            rotation: 90
+        }
+
+        Emitter{
+            //0,100 position
+            y: 100
+            size: 32
+            emitRate: 1000
+            lifeSpan: 500
+        }
+
+        Affector {
+            once: true
+            onAffected: {//Does nothing else, so should be called for all particles
+                sys.resultX1 = x;
+                sys.resultY1 = y;
+            }
+        }
+
+        Affector {
+            once: true
+            relative: false
+            position: PointDirection { x: 0; y: 100; }
+            onAffected: {//Does something, so should only be called when it causes a change (it won't)
+                sys.resultX2 = x;
+                sys.resultY2 = y;
+            }
+        }
+    }
+}
diff --git a/tests/auto/particles/qquickcustomaffector/tst_qquickcustomaffector.cpp b/tests/auto/particles/qquickcustomaffector/tst_qquickcustomaffector.cpp
index b63cde14f3..8b10b720c5 100644
--- a/tests/auto/particles/qquickcustomaffector/tst_qquickcustomaffector.cpp
+++ b/tests/auto/particles/qquickcustomaffector/tst_qquickcustomaffector.cpp
@@ -56,6 +56,7 @@ private slots:
     void initTestCase();
     void test_basic();
     void test_move();
+    void test_affectedSignal();
 };
 
 void tst_qquickcustomaffector::initTestCase()
@@ -124,6 +125,19 @@ void tst_qquickcustomaffector::test_move()
     delete view;
 }
 
+void tst_qquickcustomaffector::test_affectedSignal()
+{
+    QQuickView* view = createView(testFileUrl("affectedSignal.qml"), 600);
+    QQuickParticleSystem* system = view->rootObject()->findChild<QQuickParticleSystem*>("system");
+    ensureAnimTime(600, system->m_animation);
+
+    QCOMPARE(system->property("resultX1").toInt(), 0);
+    QCOMPARE(system->property("resultY1").toInt(), 100);
+    QCOMPARE(system->property("resultX2").toInt(), 1234);
+    QCOMPARE(system->property("resultY2").toInt(), 1234);
+    delete view;
+}
+
 QTEST_MAIN(tst_qquickcustomaffector);
 
 #include "tst_qquickcustomaffector.moc"