5c0d0e8e8e
The @param doxygen tag is formatted way nicer and should be used throughout our apidox. REVIEW: 101596
124 lines
3.5 KiB
C++
124 lines
3.5 KiB
C++
/*
|
|
Copyright (C) 2009 Igor Trindade Oliveira <igor.oliveira@indt.org.br>
|
|
Copyright (C) 2009 Adenilson Cavalcanti <adenilson.silva@idnt.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/>.
|
|
*/
|
|
|
|
/**
|
|
* @file This file contains the definition for the 2D Rotation effect.
|
|
*/
|
|
|
|
#ifndef PLASMA_ROTATION_P_H
|
|
#define PLASMA_ROTATION_P_H
|
|
|
|
#include <plasma/animations/easinganimation_p.h>
|
|
|
|
class QGraphicsRotation;
|
|
|
|
namespace Plasma {
|
|
/**
|
|
* @class RotationAnimation plasma/animations/rotation_p.h
|
|
* @short 2D rotation animation.
|
|
*
|
|
* This animation rotates a QGraphicsWidget in a axis (reference and
|
|
* axis can be defined using properties). See also
|
|
* \ref StackedRotationAnimation.
|
|
*/
|
|
class RotationAnimation : public EasingAnimation
|
|
{
|
|
|
|
Q_OBJECT
|
|
Q_PROPERTY(Qt::Axis axis READ axis WRITE setAxis)
|
|
Q_PROPERTY(qint8 reference READ reference WRITE setReference)
|
|
Q_PROPERTY(qreal angle READ angle WRITE setAngle)
|
|
|
|
public:
|
|
/**
|
|
* Default constructor
|
|
*
|
|
* @param parent Animation object parent.
|
|
* @param reference See \ref Animation::Reference.
|
|
* @param axis Which axis to rotate (XAxis, YAxis, ZAxis).
|
|
* @param angle Rotation angle (0 to 360)
|
|
*
|
|
*/
|
|
explicit RotationAnimation(QObject *parent = 0,
|
|
qint8 reference = Center,
|
|
Qt::Axis axis = Qt::ZAxis,
|
|
qreal angle = 180);
|
|
|
|
/** Destructor */
|
|
~RotationAnimation();
|
|
|
|
/**
|
|
* get animation rotation axis (e.g. YAxis, ZAxis, XAxis)
|
|
*/
|
|
Qt::Axis axis() const;
|
|
|
|
/**
|
|
* Rotation reference (e.g. Center, Up, Down, Left, Right) can
|
|
* be combined (i.e. Center|Up)
|
|
*/
|
|
qint8 reference() const;
|
|
|
|
/**
|
|
* Animation rotation angle (e.g. 45, 180, etc)
|
|
*/
|
|
qreal angle() const;
|
|
|
|
/**
|
|
* Reimplemented from Plasma::Animation
|
|
* @param curve Easing curve
|
|
*/
|
|
void setEasingCurve(const QEasingCurve &curve);
|
|
|
|
public slots:
|
|
/**
|
|
* set animation rotation axis
|
|
* @param axis Rotation (e.g. YAxis, ZAxis, XAxis)
|
|
*/
|
|
void setAxis(const Qt::Axis &axis);
|
|
|
|
/**
|
|
* Set rotation reference (e.g. Center, Up, Down, Left, Right) can
|
|
* be combined (i.e. Center|Up)
|
|
* @param reference The reference
|
|
*/
|
|
void setReference(const qint8 &reference);
|
|
|
|
/**
|
|
* Set animation rotation angle (e.g. 45, 180, etc)
|
|
* @param angle The angle
|
|
*/
|
|
void setAngle(const qreal &angle);
|
|
|
|
protected:
|
|
void updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState);
|
|
void updateEffectiveTime(int currentTime);
|
|
|
|
private:
|
|
/** Rotation transform object */
|
|
QGraphicsRotation *m_rotation;
|
|
/** Rotation angle */
|
|
qreal m_angle;
|
|
/** Axis where to perform the rotation */
|
|
Qt::Axis m_axis;
|
|
/** Reference, the default is Up (see \ref Animation::Reference) */
|
|
qint8 m_reference;
|
|
};
|
|
} // Plasma
|
|
|
|
#endif
|