Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OgreAnimation.h

Go to the documentation of this file.
00001 /*
00002 -----------------------------------------------------------------------------
00003 This source file is part of OGRE
00004     (Object-oriented Graphics Rendering Engine)
00005 For the latest info, see http://ogre.sourceforge.net/
00006 
00007 Copyright © 2000-2002 The OGRE Team
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 -----------------------------------------------------------------------------
00024 */
00025 
00026 #ifndef __Animation_H__
00027 #define __Animation_H__
00028 
00029 #include "OgrePrerequisites.h"
00030 #include "OgreString.h"
00031 
00032 namespace Ogre {
00033 
00044     class _OgreExport Animation
00045     {
00046 
00047     public:
00049         enum InterpolationMode
00050         {
00052             IM_LINEAR,
00054             IM_SPLINE
00055         };
00056 
00061         Animation(const String& name, Real length);
00062         virtual ~Animation();
00063 
00065         String getName(void) const;
00066 
00068         Real getLength(void) const;
00069 
00074         AnimationTrack* createTrack(unsigned short handle);
00075 
00084         AnimationTrack* createTrack(unsigned short handle, Node* node);
00085 
00087         unsigned short getNumTracks(void) const;
00088 
00090         AnimationTrack* getTrack(unsigned short handle) const;
00091 
00092 
00094         void destroyTrack(unsigned short handle);
00095 
00097         void destroyAllTracks(void);
00098 
00107         void apply(Real timePos, Real weight = 1.0, bool accumulate = false);
00108 
00109 
00122         void setInterpolationMode(InterpolationMode im);
00123 
00128         InterpolationMode getInterpolationMode(void) const;
00129 
00130         // Methods for setting the defaults
00137         static void setDefaultInterpolationMode(InterpolationMode im);
00138 
00140         static InterpolationMode getDefaultInterpolationMode(void);
00141 
00142 
00143         typedef std::map<unsigned short, AnimationTrack*> TrackList;
00144 
00146         const TrackList& _getTrackList(void) const;
00147 
00148 
00149 
00150     protected:
00152         TrackList mTrackList;
00153         String mName;
00154 
00155         Real mLength;
00156 
00157         InterpolationMode mInterpolationMode;
00158 
00159         static InterpolationMode msDefaultInterpolationMode;
00160 
00161         
00162     };
00163 
00164 
00165 
00166 }
00167 
00168 
00169 #endif
00170 

Copyright © 2002 by The OGRE Team