OgreSkeletonInstance.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 __SkeletonInstance_H__
#define __SkeletonInstance_H__

#include "OgrePrerequisites.h"
#include "OgreSkeleton.h"

namespace Ogre {

    class _OgreExport SkeletonInstance : public Skeleton
    {
    public:
        SkeletonInstance(const SkeletonPtr& masterCopy);
        ~SkeletonInstance();

        unsigned short getNumAnimations(void) const;

        Animation* getAnimation(unsigned short index) const;
        Animation* _getAnimationImpl(const String& name, 
            const LinkedSkeletonAnimationSource** linker = 0) const;

        Animation* createAnimation(const String& name, Real length);

        Animation* getAnimation(const String& name, 
            const LinkedSkeletonAnimationSource** linker = 0) const;

        void removeAnimation(const String& name);


        TagPoint* createTagPointOnBone(Bone* bone, 
            const Quaternion &offsetOrientation = Quaternion::IDENTITY, 
            const Vector3 &offsetPosition = Vector3::ZERO);

        void freeTagPoint(TagPoint* tagPoint);

        void addLinkedSkeletonAnimationSource(const String& skelName, 
            Real scale = 1.0f);
        void removeAllLinkedSkeletonAnimationSources(void);
        LinkedSkeletonAnimSourceIterator 
            getLinkedSkeletonAnimationSourceIterator(void) const;

        void _initAnimationState(AnimationStateSet* animSet);

        void _refreshAnimationState(AnimationStateSet* animSet);

        const String& getName(void) const;
        ResourceHandle getHandle(void) const;
        const String& getGroup(void);

    protected:
        SkeletonPtr mSkeleton;

        typedef list<TagPoint*>::type TagPointList;

        TagPointList mActiveTagPoints;

        TagPointList mFreeTagPoints;

        unsigned short mNextTagPointAutoHandle;

        void cloneBoneAndChildren(Bone* source, Bone* parent);
        void loadImpl(void);
        void unloadImpl(void);

    };
}


#endif