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

Go to the documentation of this file.

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

#ifndef __SP_SKELETAL_ANIMATION_H__
#define __SP_SKELETAL_ANIMATION_H__


#include "Base/spStandard.hpp"
#include "SceneGraph/spSceneMesh.hpp"
#include "SceneGraph/Animation/spMeshAnimation.hpp"
#include "SceneGraph/Animation/spAnimationSkeleton.hpp"
#include "SceneGraph/Animation/spAnimationJoint.hpp"
#include "SceneGraph/Animation/spAnimationJointGroup.hpp"
#include "SceneGraph/Animation/spAnimationBaseStructures.hpp"
#include "SceneGraph/Animation/spKeyframeSequence.hpp"

#include <vector>


namespace sp
{
namespace scene
{


class SP_EXPORT SkeletalAnimation : public MeshAnimation
{
    
    public:
        
        SkeletalAnimation();
        virtual ~SkeletalAnimation();
        
        /* === Functions === */
        
        AnimationSkeleton* createSkeleton(bool isNewActiveSkeleton = true);
        
        void deleteSkeleton(AnimationSkeleton* Skeleton);
        
        void clearSkeletons();
        
        void addKeyframe(AnimationJoint* Joint, u32 Frame, const Transformation &Transform);
        
        void removeKeyframe(AnimationJoint* Joint, u32 Frame);
        
        void clearKeyframes();
        
        AnimationJointGroup* addJointGroup(const io::stringc &Name = "");
        void removeJointGroup(AnimationJointGroup* JointGroup);
        
        void clearJointGroups();
        
        void groupJoint(AnimationJointGroup* Group, AnimationJoint* Joint);
        void ungroupJoint(AnimationJointGroup* Group, AnimationJoint* Joint);
        
        AnimationJointGroup* findJointGroup(const io::stringc &Name) const;
        
        bool playGroup(const io::stringc &Name, const EAnimPlaybackModes Mode, u32 FirstFrame, u32 LastFrame);
        bool playGroup(const io::stringc &Name, u32 SeqId);
        void pauseGroup(const io::stringc &Name, bool isPaused = true);
        void stopGroup(const io::stringc &Name);
        
        void poseGroup(const io::stringc &Name, u32 Frame, f32 Interpolation = 0.0f);
        
        virtual void updateAnimation(SceneNode* Node);
        
        virtual u32 getKeyframeCount() const;
        
        virtual void interpolate(u32 IndexFrom, u32 IndexTo, f32 Interpolation);
        
        virtual void interpolateBlended(
            const AnimationPlayback &PlaybackFrom, const AnimationPlayback &PlaybackTo, f32 BlendingFactor
        );
        
        virtual void copy(const Animation* Other);
        
        /* === Inline functions === */
        
        inline void setActiveSkeleton(AnimationSkeleton* Skeleton)
        {
            Skeleton_ = Skeleton;
        }
        
        AnimationSkeleton* getActiveSkeleton() const
        {
            return Skeleton_;
        }
        
    private:
        
        /* === Functions === */
        
        void updateJointGroup(AnimationJointGroup* Group, f32 AnimSpeed);
        
        /* === Members === */
        
        AnimationSkeleton* Skeleton_;                   
        std::list<AnimationSkeleton*> SkeletonList_;    
        
        std::list<SJointKeyframe> JointKeyframes_;      
        
        std::vector<AnimationJointGroup*> JointGroups_;
        std::map<std::string, AnimationJointGroup*> JointGroupsMap_;
        
};


} // /namespace scene

} // /namespace sp


#endif



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