plasma-framework/animations/animationgroup.cpp

/*
 *   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.
 */

#include "animationgroup.h"
#include <QMapIterator>
#include <QParallelAnimationGroup>
#include <QSequentialAnimationGroup>
#include <QDebug>

namespace Plasma
{

class AnimationGroupPrivate
{
public:
    AnimationGroupPrivate(): forwards(QAbstractAnimation::Forward),
                             parallel(false),
                             dirtyFlag(false), duration(0),
                             anim(0)
    { }

    QAbstractAnimation::Direction forwards;
    bool parallel;
    bool dirtyFlag;
    int duration;
    QAnimationGroup *anim;

};

AnimationGroup::AnimationGroup(QObject* parent)
    : QAbstractAnimation(parent),
      d(new AnimationGroupPrivate)
{
    d->anim = new QSequentialAnimationGroup(this);
    connect(d->anim, SIGNAL(finished()), this, SIGNAL(finished()));
}

AnimationGroup::~AnimationGroup()
{
    delete d;
}

QAbstractAnimation::Direction AnimationGroup::direction() const
{
    return d->forwards;
}

void AnimationGroup::setParallel(bool parallel)
{
    if (isParallel() == parallel) {
        return;
    }

    d->parallel = parallel;

    QAnimationGroup *newGroup;
    if (parallel)
        newGroup = new QParallelAnimationGroup(this);
    else
        newGroup = new QSequentialAnimationGroup(this);

    while (d->anim->animationCount()) {
        newGroup->addAnimation(d->anim->takeAnimation(0));
    }

    disconnect(d->anim, SIGNAL(finished()), this, SIGNAL(finished()));
    delete d->anim;
    d->anim = newGroup;
    connect(d->anim, SIGNAL(finished()), this, SIGNAL(finished()));
}

bool AnimationGroup::isParallel() const
{
    return d->parallel;
}

int AnimationGroup::add(QAbstractAnimation* elem)
{
    d->anim->addAnimation(elem);
    calculateGroupDuration();
    return d->anim->animationCount();
}

void AnimationGroup::remove(QAbstractAnimation* elem)
{
    d->anim->removeAnimation(elem);
    calculateGroupDuration();
}

QAbstractAnimation* AnimationGroup::at(int id) const
{
    return d->anim->animationAt(id);
}

void AnimationGroup::remove(int id)
{
    //This used to save some code...
    //d->anim->takeAnimationAt(id);
    d->anim->removeAnimation(d->anim->animationAt(id));
    calculateGroupDuration();
}

void AnimationGroup::start(QAbstractAnimation::DeletionPolicy policy)
{
    if (d->anim) {
        d->anim->setDirection(d->forwards);
        d->anim->start(policy);
    }
}

void AnimationGroup::updateCurrentTime(int currentTime)
{

    /**
     * XXX: not sure if is a bug in my code or Qt, but 'start()' is not being
     * called when the animation is inside of an animatin group.
     * The solution for while is to explicitly call it in 'updateCurrentTime'
     * and use this flag for control.
     */
    if (!d->dirtyFlag) {
        d->dirtyFlag = true;
        start();
    }

    if (d->forwards == QAbstractAnimation::Forward) {
        if (currentTime == duration()) {
            d->dirtyFlag = false;
            emit finished();
        }
    } else if (d->forwards == QAbstractAnimation::Backward) {
        if (currentTime == 0) {
            d->dirtyFlag = false;
            emit finished();
        }
    }
}

void AnimationGroup::calculateGroupDuration()
{
    QAbstractAnimation *tmp;
    d->duration = 0;
    if (d->parallel) {
        for (int i = 0; i < d->anim->animationCount(); ++i) {
            tmp = d->anim->animationAt(i);
            if (d->duration < tmp->duration())
                d->duration = tmp->duration();
        }

    } else {
        for (int i = 0; i < d->anim->animationCount(); ++i) {
            tmp = d->anim->animationAt(i);
            d->duration += tmp->duration();
        }

    }
}

int AnimationGroup::duration() const
{
    return d->duration;
}

void AnimationGroup::updateDirection(QAbstractAnimation::Direction direction)
{
    d->forwards = direction;
    QAbstractAnimation *tmp;
    for (int i = 0; i < d->anim->animationCount(); ++i) {
        tmp = d->anim->animationAt(i);
        tmp->setDirection(d->forwards);
    }

}

void AnimationGroup::updateState(QAbstractAnimation::State oldState, QAbstractAnimation::State newState)
{
    /* TODO: watch animation state and eventually emit 'finished' signal */
}

} //namespace Plasma

#include <../animationgroup.moc>