OgreSkeleton.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-2013 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 __Skeleton_H__
#define __Skeleton_H__

#include "OgrePrerequisites.h"
#include "OgreResource.h"
#include "OgreQuaternion.h"
#include "OgreVector3.h"
#include "OgreIteratorWrappers.h"
#include "OgreStringVector.h"
#include "OgreAnimation.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {
    enum SkeletonAnimationBlendMode {
        ANIMBLEND_AVERAGE = 0,
        ANIMBLEND_CUMULATIVE = 1
    };

#define OGRE_MAX_NUM_BONES 256

    
    struct LinkedSkeletonAnimationSource;

    class _OgreExport Skeleton : public Resource, public AnimationContainer
    {
        friend class SkeletonInstance;
    protected:
        Skeleton();

    public:
        Skeleton(ResourceManager* creator, const String& name, ResourceHandle handle,
            const String& group, bool isManual = false, ManualResourceLoader* loader = 0);
        virtual ~Skeleton();


        virtual Bone* createBone(void);

        virtual Bone* createBone(unsigned short handle);

        virtual Bone* createBone(const String& name);

        virtual Bone* createBone(const String& name, unsigned short handle);

        virtual unsigned short getNumBones(void) const;

        virtual Bone* getRootBone(void) const;

        typedef vector<Bone*>::type BoneList;
        typedef VectorIterator<BoneList> BoneIterator;
        virtual BoneIterator getRootBoneIterator(void);
        virtual BoneIterator getBoneIterator(void);

        virtual Bone* getBone(unsigned short handle) const;

        virtual Bone* getBone(const String& name) const;

        virtual bool hasBone(const String& name) const;

        virtual void setBindingPose(void);

        virtual void reset(bool resetManualBones = false);

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

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

        virtual Animation* getAnimation(const String& name) const;

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


        virtual bool hasAnimation(const String& name) const;

        virtual void removeAnimation(const String& name);

        virtual void setAnimationState(const AnimationStateSet& animSet);


        virtual void _initAnimationState(AnimationStateSet* animSet);

        virtual void _refreshAnimationState(AnimationStateSet* animSet);

        virtual void _getBoneMatrices(Matrix4* pMatrices);

        virtual unsigned short getNumAnimations(void) const;

        virtual Animation* getAnimation(unsigned short index) const;


        virtual SkeletonAnimationBlendMode getBlendMode() const;
        virtual void setBlendMode(SkeletonAnimationBlendMode state);

        virtual void _updateTransforms(void);

        virtual void optimiseAllAnimations(bool preservingIdentityNodeTracks = false);

        virtual void addLinkedSkeletonAnimationSource(const String& skelName, 
            Real scale = 1.0f);
        virtual void removeAllLinkedSkeletonAnimationSources(void);
        
        typedef vector<LinkedSkeletonAnimationSource>::type 
            LinkedSkeletonAnimSourceList;
        typedef ConstVectorIterator<LinkedSkeletonAnimSourceList> 
            LinkedSkeletonAnimSourceIterator;
        virtual LinkedSkeletonAnimSourceIterator 
            getLinkedSkeletonAnimationSourceIterator(void) const;

        virtual void _notifyManualBonesDirty(void);
        virtual void _notifyManualBoneStateChange(Bone* bone);

        virtual bool getManualBonesDirty(void) const { return mManualBonesDirty; }
        virtual bool hasManualBones(void) const { return !mManualBones.empty(); }

        typedef vector<ushort>::type BoneHandleMap;

        virtual void _mergeSkeletonAnimations(const Skeleton* source,
            const BoneHandleMap& boneHandleMap,
            const StringVector& animations = StringVector());

        virtual void _buildMapBoneByHandle(const Skeleton* source,
            BoneHandleMap& boneHandleMap) const;

        virtual void _buildMapBoneByName(const Skeleton* source,
            BoneHandleMap& boneHandleMap) const;

    protected:
        SkeletonAnimationBlendMode mBlendState;
        BoneList mBoneList;
        typedef map<String, Bone*>::type BoneListByName;
        BoneListByName mBoneListByName;


        mutable BoneList mRootBones;
        unsigned short mNextAutoHandle;
        typedef set<Bone*>::type BoneSet;
        BoneSet mManualBones;
        bool mManualBonesDirty;


        typedef map<String, Animation*>::type AnimationList;
        AnimationList mAnimationsList;

        mutable LinkedSkeletonAnimSourceList mLinkedSkeletonAnimSourceList;

        void deriveRootBone(void) const;

        void _dumpContents(const String& filename);

        void loadImpl(void);

        void unloadImpl(void);
        size_t calculateSize(void) const { return 0; } // TODO 

    };

    class _OgreExport SkeletonPtr : public SharedPtr<Skeleton> 
    {
    public:
        SkeletonPtr() : SharedPtr<Skeleton>() {}
        explicit SkeletonPtr(Skeleton* rep) : SharedPtr<Skeleton>(rep) {}
        SkeletonPtr(const SkeletonPtr& r) : SharedPtr<Skeleton>(r) {} 
        SkeletonPtr(const ResourcePtr& r) : SharedPtr<Skeleton>()
        {
            // lock & copy other mutex pointer
            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
            {
                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
                pRep = static_cast<Skeleton*>(r.getPointer());
                pUseCount = r.useCountPointer();
                if (pUseCount)
                {
                    ++(*pUseCount);
                }
            }
        }

        SkeletonPtr& operator=(const ResourcePtr& r)
        {
            if (pRep == static_cast<Skeleton*>(r.getPointer()))
                return *this;
            release();
            // lock & copy other mutex pointer
            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
            {
                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
                pRep = static_cast<Skeleton*>(r.getPointer());
                pUseCount = r.useCountPointer();
                if (pUseCount)
                {
                    ++(*pUseCount);
                }
            }
            else
            {
                // RHS must be a null pointer
                assert(r.isNull() && "RHS must be null if it has no mutex!");
                setNull();
            }
            return *this;
        }
    };

    struct LinkedSkeletonAnimationSource
    {
        String skeletonName;
        SkeletonPtr pSkeleton;
        Real scale;
        LinkedSkeletonAnimationSource(const String& skelName, Real scl)
            : skeletonName(skelName), scale(scl) {}
            LinkedSkeletonAnimationSource(const String& skelName, Real scl, 
                SkeletonPtr skelPtr)
                : skeletonName(skelName), pSkeleton(skelPtr), scale(scl) {}
    };
}

#include "OgreHeaderSuffix.h"

#endif