OgreAnimation.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 __Animation_H__
#define __Animation_H__

#include "OgrePrerequisites.h"
#include "OgreString.h"
#include "OgreIteratorWrappers.h"
#include "OgreAnimable.h"
#include "OgreAnimationTrack.h"


namespace Ogre {

    class _OgreExport Animation
    {

    public:
        enum InterpolationMode
        {
            IM_LINEAR,
            IM_SPLINE
        };

        enum RotationInterpolationMode
        {
            RIM_LINEAR,
            RIM_SPHERICAL
        };
        Animation(const String& name, Real length);
        virtual ~Animation();

        const String& getName(void) const;

        Real getLength(void) const;

        NodeAnimationTrack* createNodeTrack(unsigned short handle);

        NumericAnimationTrack* createNumericTrack(unsigned short handle);

        VertexAnimationTrack* createVertexTrack(unsigned short handle, VertexAnimationType animType);

        NodeAnimationTrack* createNodeTrack(unsigned short handle, Node* node);

        NumericAnimationTrack* createNumericTrack(unsigned short handle, 
            const AnimableValuePtr& anim);

        VertexAnimationTrack* createVertexTrack(unsigned short handle, 
            VertexData* data, VertexAnimationType animType);

        unsigned short getNumNodeTracks(void) const;

        NodeAnimationTrack* getNodeTrack(unsigned short handle) const;

        bool hasNodeTrack(unsigned short handle) const;

        unsigned short getNumNumericTracks(void) const;

        NumericAnimationTrack* getNumericTrack(unsigned short handle) const;

        bool hasNumericTrack(unsigned short handle) const;

        unsigned short getNumVertexTracks(void) const;

        VertexAnimationTrack* getVertexTrack(unsigned short handle) const;

        bool hasVertexTrack(unsigned short handle) const;
        
        void destroyNodeTrack(unsigned short handle);

        void destroyNumericTrack(unsigned short handle);

        void destroyVertexTrack(unsigned short handle);

        void destroyAllTracks(void);

        void destroyAllNodeTracks(void);
        void destroyAllNumericTracks(void);
        void destroyAllVertexTracks(void);

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

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

        void apply(Entity* entity, Real timePos, Real weight, bool software, 
            bool hardware);

        void setInterpolationMode(InterpolationMode im);

        InterpolationMode getInterpolationMode(void) const;
        void setRotationInterpolationMode(RotationInterpolationMode im);

        RotationInterpolationMode getRotationInterpolationMode(void) const;

        // Methods for setting the defaults
        static void setDefaultInterpolationMode(InterpolationMode im);

        static InterpolationMode getDefaultInterpolationMode(void);

        static void setDefaultRotationInterpolationMode(RotationInterpolationMode im);

        static RotationInterpolationMode getDefaultRotationInterpolationMode(void);

        typedef std::map<unsigned short, NodeAnimationTrack*> NodeTrackList;
        typedef ConstMapIterator<NodeTrackList> NodeTrackIterator;

        typedef std::map<unsigned short, NumericAnimationTrack*> NumericTrackList;
        typedef ConstMapIterator<NumericTrackList> NumericTrackIterator;

        typedef std::map<unsigned short, VertexAnimationTrack*> VertexTrackList;
        typedef ConstMapIterator<VertexTrackList> VertexTrackIterator;

        const NodeTrackList& _getNodeTrackList(void) const;

        NodeTrackIterator getNodeTrackIterator(void) const
        { return NodeTrackIterator(mNodeTrackList.begin(), mNodeTrackList.end()); }
        
        const NumericTrackList& _getNumericTrackList(void) const;

        NumericTrackIterator getNumericTrackIterator(void) const
        { return NumericTrackIterator(mNumericTrackList.begin(), mNumericTrackList.end()); }

        const VertexTrackList& _getVertexTrackList(void) const;

        VertexTrackIterator getVertexTrackIterator(void) const
        { return VertexTrackIterator(mVertexTrackList.begin(), mVertexTrackList.end()); }

        void optimise(void);
        


    protected:
        NodeTrackList mNodeTrackList;
        NumericTrackList mNumericTrackList;
        VertexTrackList mVertexTrackList;
        String mName;

        Real mLength;

        InterpolationMode mInterpolationMode;
        RotationInterpolationMode mRotationInterpolationMode;

        static InterpolationMode msDefaultInterpolationMode;
        static RotationInterpolationMode msDefaultRotationInterpolationMode;

        void optimiseNodeTracks(void);
        void optimiseVertexTracks(void);

        
    };


}


#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