OgreSkeletonSerializer.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28
29#ifndef __SkeletonSerializer_H__
30#define __SkeletonSerializer_H__
31
32#include "OgrePrerequisites.h"
33#include "OgreSkeleton.h"
34#include "OgreSerializer.h"
35
36namespace Ogre {
37
40 {
45
48 };
49
69 {
70
71 public:
74
75
84 void exportSkeleton(const Skeleton* pSkeleton, const String& filename,
85 SkeletonVersion ver = SKELETON_VERSION_LATEST, Endian endianMode = ENDIAN_NATIVE);
86
95 void exportSkeleton(const Skeleton* pSkeleton, DataStreamPtr stream,
96 SkeletonVersion ver = SKELETON_VERSION_LATEST, Endian endianMode = ENDIAN_NATIVE);
105
106 // TODO: provide Cal3D importer?
107
108 protected:
109
111
112 // Internal export methods
114 void writeBone(const Skeleton* pSkel, const Bone* pBone);
115 void writeBoneParent(const Skeleton* pSkel, unsigned short boneId, unsigned short parentId);
121
122 // Internal import methods
130
131 size_t calcBoneSize(const Skeleton* pSkel, const Bone* pBone);
140
141
142
143
144 };
148}
149
150
151#endif
#define _OgreExport
An animation sequence.
A bone in a skeleton.
Definition OgreBone.h:52
Specialised AnimationTrack for dealing with node transforms.
Generic class for serialising data to / from binary stream-based files.
Endian
The endianness of written files.
Reference-counted shared pointer, used for objects where implicit destruction is required.
Class for serialising skeleton data to/from an OGRE .skeleton file.
size_t calcBoneSizeWithoutScale(const Skeleton *pSkel, const Bone *pBone)
void writeSkeleton(const Skeleton *pSkel, SkeletonVersion ver)
size_t calcAnimationTrackSize(const Skeleton *pSkel, const NodeAnimationTrack *pTrack)
void readKeyFrame(DataStreamPtr &stream, NodeAnimationTrack *track, Skeleton *pSkel)
void writeKeyFrame(const Skeleton *pSkel, const TransformKeyFrame *key)
void readSkeletonAnimationLink(DataStreamPtr &stream, Skeleton *pSkel)
void writeBone(const Skeleton *pSkel, const Bone *pBone)
size_t calcBoneSize(const Skeleton *pSkel, const Bone *pBone)
void writeAnimationTrack(const Skeleton *pSkel, const NodeAnimationTrack *track)
void writeAnimation(const Skeleton *pSkel, const Animation *anim, SkeletonVersion ver)
void setWorkingVersion(SkeletonVersion ver)
void exportSkeleton(const Skeleton *pSkeleton, DataStreamPtr stream, SkeletonVersion ver=SKELETON_VERSION_LATEST, Endian endianMode=ENDIAN_NATIVE)
Exports a skeleton to the stream specified.
void readBone(DataStreamPtr &stream, Skeleton *pSkel)
void writeBoneParent(const Skeleton *pSkel, unsigned short boneId, unsigned short parentId)
size_t calcKeyFrameSize(const Skeleton *pSkel, const TransformKeyFrame *pKey)
void writeSkeletonAnimationLink(const Skeleton *pSkel, const LinkedSkeletonAnimationSource &link)
size_t calcBoneParentSize(const Skeleton *pSkel)
void importSkeleton(DataStreamPtr &stream, Skeleton *pDest)
Imports Skeleton and animation data from a .skeleton file DataStream.
size_t calcKeyFrameSizeWithoutScale(const Skeleton *pSkel, const TransformKeyFrame *pKey)
size_t calcSkeletonAnimationLinkSize(const Skeleton *pSkel, const LinkedSkeletonAnimationSource &link)
void readAnimationTrack(DataStreamPtr &stream, Animation *anim, Skeleton *pSkel)
void exportSkeleton(const Skeleton *pSkeleton, const String &filename, SkeletonVersion ver=SKELETON_VERSION_LATEST, Endian endianMode=ENDIAN_NATIVE)
Exports a skeleton to the file specified.
size_t calcAnimationSize(const Skeleton *pSkel, const Animation *pAnim)
void readBoneParent(DataStreamPtr &stream, Skeleton *pSkel)
void readAnimation(DataStreamPtr &stream, Skeleton *pSkel)
void readFileHeader(DataStreamPtr &stream)
A collection of Bone objects used to animate a skinned mesh.
Specialised KeyFrame which stores a full transform.
SkeletonVersion
Skeleton compatibility versions.
@ SKELETON_VERSION_1_8
OGRE version v1.8+.
@ SKELETON_VERSION_LATEST
Latest version available.
@ SKELETON_VERSION_1_0
OGRE version v1.0+.
_StringBase String
Link to another skeleton to share animations.

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.