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-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 __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:

        KeyFrame(const AnimationTrack* parent, Real time);

        virtual ~KeyFrame() {}

        virtual Real getTime(void) 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);

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

    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 std::vector<PoseRef> 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;
    protected:
        PoseRefList mPoseRefs;

    };

}


#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:43 2006