OgreSkeletonSerializer.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-2012 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 __SkeletonSerializer_H__
    00030 #define __SkeletonSerializer_H__
    00031
    00032 #include "OgrePrerequisites.h"
    00033 #include "OgreSkeleton.h"
    00034 #include "OgreSerializer.h"
    00035
    00036 namespace Ogre {
    00037
    00039     enum SkeletonVersion
    00040     {
    00042         SKELETON_VERSION_1_0,
    00044         SKELETON_VERSION_1_8,
    00045
    00047         SKELETON_VERSION_LATEST = 100
    00048     };
    00049
    00068     class _OgreExport SkeletonSerializer : public Serializer
    00069     {
    00070
    00071     public:
    00072         SkeletonSerializer();
    00073         virtual ~SkeletonSerializer();
    00074
    00075
    00084         void exportSkeleton(const Skeleton* pSkeleton, const String& filename,
    00085             SkeletonVersion ver = SKELETON_VERSION_LATEST, Endian endianMode = ENDIAN_NATIVE);
    00086
    00095         void exportSkeleton(const Skeleton* pSkeleton, DataStreamPtr stream,
    00096             SkeletonVersion ver = SKELETON_VERSION_LATEST, Endian endianMode = ENDIAN_NATIVE);
    00104         void importSkeleton(DataStreamPtr& stream, Skeleton* pDest);
    00105
    00106         // TODO: provide Cal3D importer?
    00107
    00108     protected:
    00109
    00110         void setWorkingVersion(SkeletonVersion ver);
    00111
    00112         // Internal export methods
    00113         void writeSkeleton(const Skeleton* pSkel, SkeletonVersion ver);
    00114         void writeBone(const Skeleton* pSkel, const Bone* pBone);
    00115         void writeBoneParent(const Skeleton* pSkel, unsigned short boneId, unsigned short parentId);
    00116         void writeAnimation(const Skeleton* pSkel, const Animation* anim, SkeletonVersion ver);
    00117         void writeAnimationTrack(const Skeleton* pSkel, const NodeAnimationTrack* track);
    00118         void writeKeyFrame(const Skeleton* pSkel, const TransformKeyFrame* key);
    00119         void writeSkeletonAnimationLink(const Skeleton* pSkel,
    00120             const LinkedSkeletonAnimationSource& link);
    00121
    00122         // Internal import methods
    00123         void readFileHeader(DataStreamPtr& stream);
    00124         void readBone(DataStreamPtr& stream, Skeleton* pSkel);
    00125         void readBoneParent(DataStreamPtr& stream, Skeleton* pSkel);
    00126         void readAnimation(DataStreamPtr& stream, Skeleton* pSkel);
    00127         void readAnimationTrack(DataStreamPtr& stream, Animation* anim, Skeleton* pSkel);
    00128         void readKeyFrame(DataStreamPtr& stream, NodeAnimationTrack* track, Skeleton* pSkel);
    00129         void readSkeletonAnimationLink(DataStreamPtr& stream, Skeleton* pSkel);
    00130
    00131         size_t calcBoneSize(const Skeleton* pSkel, const Bone* pBone);
    00132         size_t calcBoneSizeWithoutScale(const Skeleton* pSkel, const Bone* pBone);
    00133         size_t calcBoneParentSize(const Skeleton* pSkel);
    00134         size_t calcAnimationSize(const Skeleton* pSkel, const Animation* pAnim);
    00135         size_t calcAnimationTrackSize(const Skeleton* pSkel, const NodeAnimationTrack* pTrack);
    00136         size_t calcKeyFrameSize(const Skeleton* pSkel, const TransformKeyFrame* pKey);
    00137         size_t calcKeyFrameSizeWithoutScale(const Skeleton* pSkel, const TransformKeyFrame* pKey);
    00138         size_t calcSkeletonAnimationLinkSize(const Skeleton* pSkel,
    00139             const LinkedSkeletonAnimationSource& link);
    00140
    00141
    00142
    00143
    00144     };
    00148 }
    00149
    00150
    00151 #endif

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:24