OGRE: OgreSkeletonInstance.h Source File - OGRE Documentation

# OgreSkeletonInstance.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004 (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028
    00029 #ifndef __SkeletonInstance_H__
    00030 #define __SkeletonInstance_H__
    00031
    00032 #include "OgrePrerequisites.h"
    00033 #include "OgreSkeleton.h"
    00034
    00035 namespace Ogre {
    00036
    00052     class _OgreExport SkeletonInstance : public Skeleton
    00053     {
    00054     public:
    00058         SkeletonInstance(const SkeletonPtr& masterCopy);
    00059         ~SkeletonInstance();
    00060
    00062         unsigned short getNumAnimations(void) const;
    00063
    00065         Animation* getAnimation(unsigned short index) const;
    00067         Animation* _getAnimationImpl(const String& name,
    00068             const LinkedSkeletonAnimationSource** linker = 0) const;
    00069
    00076         Animation* createAnimation(const String& name, Real length);
    00077
    00079         Animation* getAnimation(const String& name,
    00080             const LinkedSkeletonAnimationSource** linker = 0) const;
    00081
    00086         void removeAnimation(const String& name);
    00087
    00088
    00090         TagPoint* createTagPointOnBone(Bone* bone,
    00091             const Quaternion &offsetOrientation = Quaternion::IDENTITY,
    00092             const Vector3 &offsetPosition = Vector3::ZERO);
    00093
    00095         void freeTagPoint(TagPoint* tagPoint);
    00096
    00098         void addLinkedSkeletonAnimationSource(const String& skelName,
    00099             Real scale = 1.0f);
    00101         void removeAllLinkedSkeletonAnimationSources(void);
    00103         LinkedSkeletonAnimSourceIterator
    00104             getLinkedSkeletonAnimationSourceIterator(void) const;
    00105
    00107         void _initAnimationState(AnimationStateSet* animSet);
    00108
    00110         void _refreshAnimationState(AnimationStateSet* animSet);
    00111
    00113         const String& getName(void) const;
    00115         ResourceHandle getHandle(void) const;
    00117         const String& getGroup(void);
    00118
    00119     protected:
    00121         SkeletonPtr mSkeleton;
    00122
    00123         typedef list<TagPoint*>::type TagPointList;
    00124
    00133         TagPointList mActiveTagPoints;
    00134
    00142         TagPointList mFreeTagPoints;
    00143
    00145         unsigned short mNextTagPointAutoHandle;
    00146
    00147         void cloneBoneAndChildren(Bone* source, Bone* parent);
    00150         void loadImpl(void);
    00153         void unloadImpl(void);
    00154
    00155     };
    00159 }
    00160
    00161
    00162 #endif
    00163

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52