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-2011 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/

#ifndef __AnimationSet_H__
#define __AnimationSet_H__

#include "OgrePrerequisites.h"

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

namespace Ogre {

    class _OgreExport AnimationState : public AnimationAlloc
    {
    public:

      typedef vector<float>::type BoneBlendMask;

        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 hasEnded(void) const;

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

      void createBlendMask(size_t blendMaskSizeHint, float initialWeight = 1.0f);
      void destroyBlendMask();
      void _setBlendMaskData(const float* blendMaskData);
      void _setBlendMask(const BoneBlendMask* blendMask);
      const BoneBlendMask* getBlendMask() const {return mBlendMask;}
      bool hasBlendMask() const {return mBlendMask != 0;}
      void setBlendMaskEntry(size_t boneHandle, float weight);
      inline float getBlendMaskEntry(size_t boneHandle) const
      {
        assert(mBlendMask && mBlendMask->size() > boneHandle);
        return (*mBlendMask)[boneHandle];
      }
    protected:
      BoneBlendMask* mBlendMask;

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

    };

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

    class _OgreExport AnimationStateSet : public AnimationAlloc
    {
    public:
        OGRE_AUTO_MUTEX
        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