AnimationSequence.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2014 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_ANIMATIONSEQUENCE_H
#define RAMSES_ANIMATIONSEQUENCE_H
 
#include "ramses-client-api/AnimationObject.h"
#include "ramses-client-api/AnimationTypes.h"
 
namespace ramses
{
    class Animation;
 
    class RAMSES_API AnimationSequence : public AnimationObject
    {
    public:
        status_t addAnimation(const Animation& animation, sequenceTimeStamp_t startTimeInSequence = 0u, sequenceTimeStamp_t stopTimeInSequence = 0u);
 
        status_t removeAnimation(const Animation& animation);
 
        status_t start(timeMilliseconds_t offset = 0);
 
        status_t startAt(globalTimeStamp_t timeStamp);
 
        status_t startReverse(timeMilliseconds_t offset = 0);
 
        status_t startReverseAt(globalTimeStamp_t timeStamp);
 
        status_t stop(timeMilliseconds_t delay = 0);
 
        status_t stopAt(globalTimeStamp_t timeStamp);
 
        status_t setPlaybackSpeed(float playbackSpeed);
 
        float getPlaybackSpeed() const;
 
        status_t setAnimationRelative(const Animation& animation);
 
        status_t setAnimationAbsolute(const Animation& animation);
 
        status_t setAnimationLooping(const Animation& animation, timeMilliseconds_t loopDuration = 0);
 
        bool isAnimationRelative(const Animation& animation) const;
 
        bool isAnimationLooping(const Animation& animation) const;
 
        timeMilliseconds_t getAnimationLoopDuration(const Animation& animation) const;
 
        uint32_t getNumberOfAnimations() const;
 
        bool containsAnimation(const Animation& animation) const;
 
        sequenceTimeStamp_t getAnimationStartTimeInSequence(const Animation& animation) const;
 
        sequenceTimeStamp_t getAnimationStopTimeInSequence(const Animation& animation) const;
 
        sequenceTimeStamp_t getAnimationSequenceStopTime() const;
 
        class AnimationSequenceImpl& impl;
 
    protected:
        friend class AnimationSystemData;
 
        explicit AnimationSequence(AnimationSequenceImpl& pimpl);
 
        AnimationSequence(const AnimationSequence& other);
 
        AnimationSequence& operator=(const AnimationSequence& other);
 
        virtual ~AnimationSequence();
 
    };
}
 
#endif