OgreAnimationTrack.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program 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 of the License, 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/

#ifndef __AnimationTrack_H__
#define __AnimationTrack_H__

#include "OgrePrerequisites.h"
#include "OgreSimpleSpline.h"
#include "OgreRotationalSpline.h"
#include "OgreKeyFrame.h"
#include "OgreAnimable.h"
#include "OgrePose.h"

namespace Ogre 
{
    class _OgreExport AnimationTrack
    {
    public:
        AnimationTrack(Animation* parent, unsigned short handle);

        virtual ~AnimationTrack();

        unsigned short getHandle(void) const { return mHandle; }

        virtual unsigned short getNumKeyFrames(void) const;

        virtual KeyFrame* getKeyFrame(unsigned short index) const;

        virtual Real getKeyFramesAtTime(Real timePos, KeyFrame** keyFrame1, KeyFrame** keyFrame2,
            unsigned short* firstKeyIndex = 0) const;

        virtual KeyFrame* createKeyFrame(Real timePos);

        virtual void removeKeyFrame(unsigned short index);

        virtual void removeAllKeyFrames(void);


        virtual void getInterpolatedKeyFrame(Real timeIndex, KeyFrame* kf) const = 0;

        virtual void apply(Real timePos, Real weight = 1.0, bool accumulate = false, 
            Real scale = 1.0f) = 0;

        virtual void _keyFrameDataChanged(void) const {}

        virtual bool hasNonZeroKeyFrames(void) const { return true; }

        virtual void optimise(void) {}

    protected:
        typedef std::vector<KeyFrame*> KeyFrameList;
        KeyFrameList mKeyFrames;
        Real mMaxKeyFrameTime;
        Animation* mParent;
        unsigned short mHandle;

        virtual KeyFrame* createKeyFrameImpl(Real time) = 0;


    };

    class _OgreExport NumericAnimationTrack : public AnimationTrack
    {
    public:
        NumericAnimationTrack(Animation* parent, unsigned short handle);
        NumericAnimationTrack(Animation* parent, unsigned short handle, 
            AnimableValuePtr& target);

        virtual NumericKeyFrame* createNumericKeyFrame(Real timePos);

        void getInterpolatedKeyFrame(Real timeIndex, KeyFrame* kf) const;

        void apply(Real timePos, Real weight = 1.0, bool accumulate = false, 
            Real scale = 1.0f);

        void applyToAnimable(const AnimableValuePtr& anim, Real timePos, 
            Real weight = 1.0, Real scale = 1.0f);

        virtual const AnimableValuePtr& getAssociatedAnimable(void) const;

        virtual void setAssociatedAnimable(const AnimableValuePtr& val);

        NumericKeyFrame* getNumericKeyFrame(unsigned short index) const;


    protected:
        AnimableValuePtr mTargetAnim;

        KeyFrame* createKeyFrameImpl(Real time);


    };

    class _OgreExport NodeAnimationTrack : public AnimationTrack
    {
    public:
        NodeAnimationTrack(Animation* parent, unsigned short handle);
        NodeAnimationTrack(Animation* parent, unsigned short handle, 
            Node* targetNode);
        virtual TransformKeyFrame* createNodeKeyFrame(Real timePos);
        virtual Node* getAssociatedNode(void) const;

        virtual void setAssociatedNode(Node* node);

        virtual void applyToNode(Node* node, Real timePos, Real weight = 1.0, 
            bool accumulate = false, Real scale = 1.0f);

        virtual void setUseShortestRotationPath(bool useShortestPath);

        virtual bool getUseShortestRotationPath() const;

        void getInterpolatedKeyFrame(Real timeIndex, KeyFrame* kf) const;

        void apply(Real timePos, Real weight = 1.0, bool accumulate = false, 
            Real scale = 1.0f);

        void _keyFrameDataChanged(void) const;

        virtual TransformKeyFrame* getNodeKeyFrame(unsigned short index) const;


        virtual bool hasNonZeroKeyFrames(void) const;

        virtual void optimise(void);

    protected:
        KeyFrame* createKeyFrameImpl(Real time);
        // Flag indicating we need to rebuild the splines next time
        virtual void buildInterpolationSplines(void) const;

        Node* mTargetNode;
        // Prebuilt splines, must be mutable since lazy-update in const method
        mutable bool mSplineBuildNeeded;
        mutable SimpleSpline mPositionSpline;
        mutable SimpleSpline mScaleSpline;
        mutable RotationalSpline mRotationSpline;
        mutable bool mUseShortestRotationPath ;


    };

    enum VertexAnimationType
    {
        VAT_NONE = 0,
        VAT_MORPH = 1,
        VAT_POSE = 2
    };

    class _OgreExport VertexAnimationTrack : public AnimationTrack
    {
    public:
        enum TargetMode
        {
            TM_SOFTWARE, 
            TM_HARDWARE
        };
        VertexAnimationTrack(Animation* parent, unsigned short handle, VertexAnimationType animType);
        VertexAnimationTrack(Animation* parent, unsigned short handle, VertexAnimationType animType, 
            VertexData* targetData, TargetMode target = TM_SOFTWARE);

        VertexAnimationType getAnimationType(void) const { return mAnimationType; }

        virtual VertexMorphKeyFrame* createVertexMorphKeyFrame(Real timePos);

        virtual VertexPoseKeyFrame* createVertexPoseKeyFrame(Real timePos);

        void getInterpolatedKeyFrame(Real timeIndex, KeyFrame* kf) const {}

        void apply(Real timePos, Real weight = 1.0, bool accumulate = false, 
            Real scale = 1.0f);

        virtual void applyToVertexData(VertexData* data, 
            Real timePos, Real weight = 1.0, 
            const PoseList* poseList = 0);


        VertexMorphKeyFrame* getVertexMorphKeyFrame(unsigned short index) const;

        VertexPoseKeyFrame* getVertexPoseKeyFrame(unsigned short index) const;

        void setAssociatedVertexData(VertexData* data) { mTargetVertexData = data; }
        VertexData* getAssociatedVertexData(void) const { return mTargetVertexData; }

        void setTargetMode(TargetMode m) { mTargetMode = m; }
        TargetMode getTargetMode(void) const { return mTargetMode; }

        virtual bool hasNonZeroKeyFrames(void) const;

        virtual void optimise(void);


    protected:
        VertexAnimationType mAnimationType;
        VertexData* mTargetVertexData;
        TargetMode mTargetMode;

        KeyFrame* createKeyFrameImpl(Real time);

        void applyPoseToVertexData(const Pose* pose, VertexData* data, Real influence);


    };


}

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:36 2006