D:/SoftwareEntwicklung/C++/HLC/Tools/SoftPixelEngine/repository/sources/SceneGraph/Animation/spAnimation.hpp

Go to the documentation of this file.

/*
 * Animation interface header
 * 
 * This file is part of the "SoftPixel Engine" (Copyright (c) 2008 by Lukas Hermanns)
 * See "SoftPixelEngine.hpp" for license information.
 */

#ifndef __SP_ANIMATION_H__
#define __SP_ANIMATION_H__


#include "Base/spStandard.hpp"
#include "SceneGraph/spSceneNode.hpp"
#include "SceneGraph/Animation/spAnimationPlayback.hpp"

#include <list>


namespace sp
{
namespace scene
{


enum EAnimationTypes
{
    ANIMATION_NODE,         
    ANIMATION_MORPHTARGET,  
    ANIMATION_SKELETAL,     
};

enum EAnimationFlags
{
    ANIMFLAG_NO_GROUPING        = 0x01, 
    ANIMFLAG_NO_TRANSFORMATION  = 0x02, 
};


class SP_EXPORT Animation
{
    
    public:
        
        virtual ~Animation();
        
        /* === Functions === */
        
        virtual bool play(const EAnimPlaybackModes Mode, u32 FirstFrame = 0, u32 LastFrame = ANIM_LAST_FRAME);
        
        virtual void pause(bool IsPaused = true);
        
        virtual void stop(bool IsReset = false);
        
        virtual void clearKeyframes() = 0;
        
        virtual void setFrame(u32 Index);
        
        virtual void updateAnimation(SceneNode* Node) = 0;
        
        virtual u32 getKeyframeCount() const = 0;
        
        virtual void interpolate(u32 IndexFrom, u32 IndexTo, f32 Interpolation) = 0;
        
        virtual bool interpolateRange(u32 FirstFrame, u32 LastFrame, f32 Interpolation);
        
        virtual void interpolateBlended(
            const AnimationPlayback &PlaybackFrom, const AnimationPlayback &PlaybackTo, f32 BlendingFactor
        );
        
        virtual void addSceneNode(SceneNode* Object);
        
        virtual void removeSceneNode(SceneNode* Object);
        
        virtual void clearSceneNodes();
        
        virtual void copy(const Animation* Other) = 0;
        
        /* === Inline functions === */
        
        inline EAnimationTypes getType() const
        {
            return Type_;
        }
        
        inline void setName(const io::stringc &Name)
        {
            Name_ = Name;
        }
        inline io::stringc getName() const
        {
            return Name_;
        }
        
        inline void setFlags(s32 Flags)
        {
            Flags_ = Flags;
        }
        inline s32 getFlags() const
        {
            return Flags_;
        }
        
        inline bool playing() const
        {
            return Playback_.playing();
        }
        
        inline u32 getFrame() const
        {
            return Playback_.getFrame();
        }
        
        inline u32 getMinFrame() const
        {
            return MinFrame_;
        }
        inline u32 getMaxFrame() const
        {
            return MaxFrame_;
        }
        
        inline void setInterpolation(f32 Interpolation)
        {
            Playback_.setInterpolation(Interpolation);
        }
        inline f32 getInterpolation() const
        {
            return Playback_.getInterpolation();
        }
        
        inline EAnimPlaybackModes getPlaybackMode() const
        {
            return Playback_.getMode();
        }
        
        inline void setSpeed(f32 Speed)
        {
            Playback_.setSpeed(Speed);
        }
        inline f32 getSpeed() const
        {
            return Playback_.getSpeed();
        }
        
        inline const AnimationPlayback& getPlayback() const
        {
            return Playback_;
        }
        inline AnimationPlayback& getPlayback()
        {
            return Playback_;
        }
        
        inline const std::list<SceneNode*>& getSceneNodeList() const
        {
            return SceneNodes_;
        }
        
    protected:
        
        /* === Functions === */
        
        Animation(const EAnimationTypes Type);
        
        virtual void updatePlayback(f32 Speed);
        
        u32 getValidFrame(u32 Index) const;
        
        void copyBase(const Animation* Other);
        
        /* === Members === */
        
        u32 MinFrame_, MaxFrame_;
        
        AnimationPlayback Playback_;
        
        s32 Flags_;
        
    private:
        
        /* === Members === */
        
        EAnimationTypes Type_;
        io::stringc Name_;
        
        std::list<SceneNode*> SceneNodes_;
        
};


} // /namespace scene

} // /namespace sp


#endif



// ================================================================================