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"

namespace Ogre 
{
    class _OgreExport AnimationTrack
    {
    public:
        AnimationTrack(Animation* parent);
        AnimationTrack(Animation* parent, Node* targetNode);

        virtual ~AnimationTrack();

        unsigned short getNumKeyFrames(void) const;

        KeyFrame* getKeyFrame(unsigned short index) const;

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

        KeyFrame* createKeyFrame(Real timePos);

        void removeKeyFrame(unsigned short index);

        void removeAllKeyFrames(void);


        KeyFrame getInterpolatedKeyFrame(Real timeIndex) const;

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

        Node* getAssociatedNode(void) const;

        void setAssociatedNode(Node* node);

        void applyToNode(Node* node, Real timePos, Real weight = 1.0, 
            bool accumulate = false, Real scale = 1.0f);
        
        void setUseShortestRotationPath(bool useShortestPath);
        
        bool getUseShortestRotationPath() const;

        void _keyFrameDataChanged(void) const;

        bool hasNonZeroKeyFrames(void) const;

        void optimise(void);
    protected:
        typedef std::vector<KeyFrame*> KeyFrameList;
        KeyFrameList mKeyFrames;
        Real mMaxKeyFrameTime;
        Animation* mParent;
        Node* mTargetNode;

        // Flag indicating we need to rebuild the splines next time
        void buildInterpolationSplines(void) const;

        // 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 ;
      

    };
}

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 12:59:41 2006