OgreKeyFrame.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-2012 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 __KeyFrame_H__
#define __KeyFrame_H__

#include "OgrePrerequisites.h"
#include "OgreVector3.h"
#include "OgreQuaternion.h"
#include "OgreAny.h"
#include "OgreHardwareVertexBuffer.h"
#include "OgreIteratorWrappers.h"

namespace Ogre 
{

    class _OgreExport KeyFrame : public AnimationAlloc
    {
    public:

        KeyFrame(const AnimationTrack* parent, Real time);

        virtual ~KeyFrame() {}

        Real getTime(void) const { return mTime; }

        virtual KeyFrame* _clone(AnimationTrack* newParent) const;


    protected:
        Real mTime;
        const AnimationTrack* mParentTrack;
    };


    class _OgreExport NumericKeyFrame : public KeyFrame
    {
    public:
        NumericKeyFrame(const AnimationTrack* parent, Real time);
        ~NumericKeyFrame() {}

        virtual const AnyNumeric& getValue(void) const;
        virtual void setValue(const AnyNumeric& val);

        KeyFrame* _clone(AnimationTrack* newParent) const;
    protected:
        AnyNumeric mValue;
    };


    class _OgreExport TransformKeyFrame : public KeyFrame
    {
    public:
        TransformKeyFrame(const AnimationTrack* parent, Real time);
        ~TransformKeyFrame() {}
        virtual void setTranslate(const Vector3& trans);

        const Vector3& getTranslate(void) const;

        virtual void setScale(const Vector3& scale);

        virtual const Vector3& getScale(void) const;

        virtual void setRotation(const Quaternion& rot);

        virtual const Quaternion& getRotation(void) const;

        KeyFrame* _clone(AnimationTrack* newParent) const;
    protected:
        Vector3 mTranslate;
        Vector3 mScale;
        Quaternion mRotate;


    };



    class _OgreExport VertexMorphKeyFrame : public KeyFrame
    {
    public:
        VertexMorphKeyFrame(const AnimationTrack* parent, Real time);
        ~VertexMorphKeyFrame() {}
        void setVertexBuffer(const HardwareVertexBufferSharedPtr& buf);

        const HardwareVertexBufferSharedPtr& getVertexBuffer(void) const;

        KeyFrame* _clone(AnimationTrack* newParent) const;      

    protected:
        HardwareVertexBufferSharedPtr mBuffer;

    };

    class _OgreExport VertexPoseKeyFrame : public KeyFrame
    {
    public:
        VertexPoseKeyFrame(const AnimationTrack* parent, Real time);
        ~VertexPoseKeyFrame() {}

        struct PoseRef
        {
            ushort poseIndex;
            Real influence;

            PoseRef(ushort p, Real i) : poseIndex(p), influence(i) {}
        };
        typedef vector<PoseRef>::type PoseRefList;

        void addPoseReference(ushort poseIndex, Real influence);
        void updatePoseReference(ushort poseIndex, Real influence);
        void removePoseReference(ushort poseIndex);
        void removeAllPoseReferences(void);


        const PoseRefList& getPoseReferences(void) const;

        typedef VectorIterator<PoseRefList> PoseRefIterator;
        typedef ConstVectorIterator<PoseRefList> ConstPoseRefIterator;

        PoseRefIterator getPoseReferenceIterator(void);

        ConstPoseRefIterator getPoseReferenceIterator(void) const;

        KeyFrame* _clone(AnimationTrack* newParent) const;
        
        void _applyBaseKeyFrame(const VertexPoseKeyFrame* base);
        
    protected:
        PoseRefList mPoseRefs;

    };
}


#endif