151 lines
4.0 KiB
C++
151 lines
4.0 KiB
C++
/*
|
|
* Copyright 2009 Mehmet Ali Akmanalp <makmanalp@wpi.edu>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU Library General Public License as
|
|
* published by the Free Software Foundation; either version 2, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this program; if not, write to the
|
|
* Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
/**
|
|
* @file This file contains the abstract base class for all singular
|
|
* animations.
|
|
*/
|
|
|
|
#ifndef PLASMA_ANIMATION_H
|
|
#define PLASMA_ANIMATION_H
|
|
|
|
#include <QtGui/QGraphicsWidget>
|
|
#include <QtCore/QObject>
|
|
#include <QtCore/QPropertyAnimation>
|
|
#include <QtCore/QAbstractAnimation>
|
|
#include <QtCore/QEasingCurve>
|
|
|
|
#include <plasma/plasma_export.h>
|
|
#include <plasma/plasma.h>
|
|
|
|
namespace Plasma
|
|
{
|
|
|
|
class AnimationPrivate;
|
|
|
|
/**
|
|
* @brief Abstract representation of a single animation.
|
|
* @since 4.4
|
|
*/
|
|
class PLASMA_EXPORT Animation : public QAbstractAnimation
|
|
{
|
|
|
|
Q_OBJECT
|
|
Q_PROPERTY(int duration READ duration WRITE setDuration)
|
|
Q_PROPERTY(QEasingCurve::Type easingCurveType READ easingCurveType WRITE setEasingCurveType)
|
|
Q_PROPERTY(QGraphicsWidget *widgetToAnimate READ widgetToAnimate WRITE setWidgetToAnimate)
|
|
|
|
public:
|
|
/**
|
|
* Get the animation duration. It can be set using the property duration.
|
|
* @return duration in ms.
|
|
*/
|
|
int duration() const;
|
|
|
|
/**
|
|
* Animation movement reference (used by \ref RotationAnimation).
|
|
*/
|
|
enum Reference{
|
|
Center,
|
|
Up,
|
|
Down,
|
|
Left,
|
|
Right
|
|
};
|
|
|
|
/**
|
|
* Default constructor.
|
|
*
|
|
* @param parent Object parent (might be set when using
|
|
* \ref Animator::create factory).
|
|
*
|
|
*/
|
|
explicit Animation(QObject* parent = 0);
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~Animation() = 0;
|
|
|
|
/**
|
|
* Set the widget on which the animation is to be performed.
|
|
*
|
|
* If the animation class has any special initialization to be done
|
|
* in the target widget, you should reimplement this method in
|
|
* the derived class.
|
|
* @arg receiver The QGraphicsWidget to be animated.
|
|
*/
|
|
virtual void setWidgetToAnimate(QGraphicsWidget* widget);
|
|
|
|
/**
|
|
* The widget that the animation will be performed upon
|
|
*/
|
|
QGraphicsWidget *widgetToAnimate();
|
|
|
|
/**
|
|
* Set the animation easing curve type
|
|
*/
|
|
void setEasingCurveType(QEasingCurve::Type type);
|
|
|
|
/**
|
|
* Get the animation easing curve type
|
|
*/
|
|
QEasingCurve::Type easingCurveType() const;
|
|
|
|
protected:
|
|
|
|
/**
|
|
* Change the animation duration. Default is 250ms.
|
|
* @arg duration The new duration of the animation.
|
|
*/
|
|
virtual void setDuration(int duration = 250);
|
|
|
|
/**
|
|
* QAbstractAnimation will call this method while the animation
|
|
* is running. Each specialized animation class should implement
|
|
* the correct behavior for it.
|
|
* @param currentTime Slapsed time using the \ref duration as reference
|
|
* (it will be from duration up to zero if the animation is running
|
|
* backwards).
|
|
*/
|
|
virtual void updateCurrentTime(int currentTime);
|
|
|
|
/**
|
|
* Internal use only, access the easing curve object (see
|
|
* \ref AnimationPrivate). Commonly used if a non-linear
|
|
* animation is desired while setting the delta in \ref updateCurrentTime.
|
|
*
|
|
* @return An internal easing curve (default is Type::Linear).
|
|
*/
|
|
QEasingCurve &easingCurve();
|
|
|
|
private:
|
|
|
|
/**
|
|
* Internal pimple (actually is used as a data structure, see
|
|
* \ref AnimationPrivate).
|
|
*/
|
|
AnimationPrivate *const d;
|
|
|
|
};
|
|
|
|
} //namespace Plasma
|
|
|
|
#endif
|