OgreAnimationState.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 __AnimationSet_H__
#define __AnimationSet_H__

#include "OgrePrerequisites.h"

#include "OgreString.h"
#include "OgreController.h"
#include "OgreIteratorWrappers.h"

namespace Ogre {

    class _OgreExport AnimationState 
    {
    public:
        AnimationState(const String& animName, AnimationStateSet *parent, 
            Real timePos, Real length, Real weight = 1.0, bool enabled = false);
        AnimationState(AnimationStateSet* parent, const AnimationState &rhs);
        virtual ~AnimationState();
        
        const String& getAnimationName() const;
        Real getTimePosition(void) const;
        void setTimePosition(Real timePos);
        Real getLength() const;
        void setLength(Real len);
        Real getWeight(void) const;
        void setWeight(Real weight);
        void addTime(Real offset);

        bool getEnabled(void) const;
        void setEnabled(bool enabled);

        bool operator==(const AnimationState& rhs) const;
        // Inequality operator
        bool operator!=(const AnimationState& rhs) const;

        void setLoop(bool loop) { mLoop = loop; }
        bool getLoop(void) const { return mLoop; }
     
        void copyStateFrom(const AnimationState& animState);

        AnimationStateSet* getParent(void) const { return mParent; }

    protected:
        String mAnimationName;
        AnimationStateSet* mParent;
        Real mTimePos;
        Real mLength;
        Real mInvLength;
        Real mWeight;
        bool mEnabled;
        bool mLoop;

    };

    // A map of animation states
    typedef std::map<String, AnimationState*> AnimationStateMap;
    typedef MapIterator<AnimationStateMap> AnimationStateIterator;
    typedef ConstMapIterator<AnimationStateMap> ConstAnimationStateIterator;
    // A list of enabled animation states
    typedef std::list<AnimationState*> EnabledAnimationStateList;
    typedef ConstVectorIterator<EnabledAnimationStateList> ConstEnabledAnimationStateIterator;

    class _OgreExport AnimationStateSet
    {
    public:
        AnimationStateSet();
        AnimationStateSet(const AnimationStateSet& rhs);

        ~AnimationStateSet();

        AnimationState* createAnimationState(const String& animName,  
            Real timePos, Real length, Real weight = 1.0, bool enabled = false);
        AnimationState* getAnimationState(const String& name) const;
        bool hasAnimationState(const String& name) const;
        void removeAnimationState(const String& name);
        void removeAllAnimationStates(void);

        AnimationStateIterator getAnimationStateIterator(void);
        ConstAnimationStateIterator getAnimationStateIterator(void) const;
        void copyMatchingState(AnimationStateSet* target) const;
        void _notifyDirty(void);
        unsigned long getDirtyFrameNumber(void) const { return mDirtyFrameNumber; }

        void _notifyAnimationStateEnabled(AnimationState* target, bool enabled);
        bool hasEnabledAnimationState(void) const { return !mEnabledAnimationStates.empty(); }
        ConstEnabledAnimationStateIterator getEnabledAnimationStateIterator(void) const;

    protected:
        unsigned long mDirtyFrameNumber;
        AnimationStateMap mAnimationStates;
        EnabledAnimationStateList mEnabledAnimationStates;

    };

    class _OgreExport AnimationStateControllerValue : public ControllerValue<Real>
    {
    protected:
        AnimationState* mTargetAnimationState;
    public:
        AnimationStateControllerValue(AnimationState* targetAnimationState)
            : mTargetAnimationState(targetAnimationState) {}
        ~AnimationStateControllerValue() {}
        Real getValue(void) const;

        void setValue(Real value);

    };


}

#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