File: water_p.h

package info (click to toggle)
kde4libs 4%3A4.14.2-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 82,316 kB
  • sloc: cpp: 761,810; xml: 12,344; ansic: 6,295; java: 4,060; perl: 2,938; yacc: 2,507; python: 1,207; sh: 1,179; ruby: 337; lex: 278; makefile: 29
file content (68 lines) | stat: -rw-r--r-- 1,931 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
 * Copyright (C) 2010 Bruno Abinader <bruno.abinader@indt.org.br>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PLASMA_ANIMATIONS_WATER_P_H
#define PLASMA_ANIMATIONS_WATER_P_H

#include <plasma/animations/easinganimation_p.h>

namespace Plasma
{

/*
 * @class Water plasma/animations/water_p.h
 * @short Water animation using ripple effect
 *
 * Simulates a water animation using ripple effect
 */
class WaterAnimation : public EasingAnimation
{
    Q_OBJECT
    Q_PROPERTY(qint8 offset READ offset WRITE setOffset)

public:
    /**
     * Default constructor
     * @param parent Animation object parent
     */
    explicit WaterAnimation(QObject *parent = 0);

    /**
     * Returns the ripple offset. The ripple offset is the distance between neighbour pixels used to
     * calculate the wave propagation.
     * @return ripple offset
     */
    qint8 offset() const;

public slots:
    /**
     * Sets the ripple offset
     * @param offset ripple offset
     */
    void setOffset(qint8 offset);

protected:
    void updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState);
    void updateEffectiveTime(int currentTime);

private:
    qint8 m_offset; /** Ripple offset (default is 1) */
};

} // namespace Plasma

#endif // PLASMA_ANIMATIONS_WATER_P_H