Spinning Topp Logo BlackTopp Studios
inc
skeleton.cpp
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _graphicsskeleton_cpp
41 #define _graphicsskeleton_cpp
42 
43 #include "Graphics/skeleton.h"
44 #include "Graphics/bone.h"
45 
46 #include <Ogre.h>
47 
48 namespace Mezzanine
49 {
50  namespace Graphics
51  {
52  ///////////////////////////////////////////////////////////////////////////////
53  /// @brief This class is used to store the internal structures needed by the Skeleton class.
54  /// @details
55  ///////////////////////////////////////
57  {
58  public:
59  Ogre::SkeletonPtr GraphicsSkeleton;
60  };//InternalSkeletonData
61 
62  ///////////////////////////////////////////////////////////////////////////////
63  // Skeleton Methods
64 
66  {
67  this->ISD = new InternalSkeletonData();
68  this->ISD->GraphicsSkeleton = InternalSkeleton;
69 
70  Ogre::Skeleton::BoneIterator BoneIt = this->ISD->GraphicsSkeleton->getBoneIterator();
71  while( BoneIt.hasMoreElements() )
72  {
73  Ogre::Bone* InternalBone = BoneIt.getNext();
74  Bones.push_back( this->_CreateBoneWrapper( InternalBone ) );
75  }
76  }
77 
79  {
80  delete ISD;
81  }
82 
83  ///////////////////////////////////////////////////////////////////////////////
84  // Utility Methods
85 
86  ///////////////////////////////////////////////////////////////////////////////
87  // Bone Methods
88 
90  {
91  return Bones.size();
92  }
93 
94  Skeleton::BoneIterator Skeleton::BoneBegin()
95  {
96  return Bones.begin();
97  }
98 
99  Skeleton::BoneIterator Skeleton::BoneEnd()
100  {
101  return Bones.end();
102  }
103 
104  Skeleton::ConstBoneIterator Skeleton::BoneBegin() const
105  {
106  return Bones.begin();
107  }
108 
109  Skeleton::ConstBoneIterator Skeleton::BoneEnd() const
110  {
111  return Bones.end();
112  }
113 
114  ///////////////////////////////////////////////////////////////////////////////
115  // Animation Methods
116 
117  /// @todo Implement these
118 
119  ///////////////////////////////////////////////////////////////////////////////
120  // Asset Methods
121 
123  {
124  return this->_GetInternalSkeleton()->getName();
125  }
126 
128  {
129  return this->_GetInternalSkeleton()->getGroup();
130  }
131 
132  ///////////////////////////////////////////////////////////////////////////////
133  // Internal Methods
134 
135  Bone* Skeleton::_CreateBoneWrapper(Ogre::Bone* InternalBone)
136  {
137  Bone* NewBone = new Bone(this,InternalBone);
138  Bones.push_back(NewBone);
139  return NewBone;
140  }
141 
143  {
144  return this->ISD->GraphicsSkeleton;
145  }
146  }//Graphics
147 }//Mezzanine
148 
149 #endif
This class is used to store the internal structures needed by the Skeleton class. ...
Definition: skeleton.cpp:56
ConstString & GetGroup() const
Gets the resource group this Skeleton belongs to.
Definition: skeleton.cpp:127
~Skeleton()
Class destructor.
Definition: skeleton.cpp:78
uint16_t UInt16
An 16-bit unsigned integer.
Definition: datatypes.h:122
Bone * _CreateBoneWrapper(Ogre::Bone *InternalBone)
Creates a bone wrapper for a pre-made internal bone.
Definition: skeleton.cpp:135
ConstString & GetName() const
Gets the Name of this Skeleton.
Definition: skeleton.cpp:122
const String ConstString
A Datatype used to a series of imutable characters.
Definition: datatypes.h:165
Ogre::SkeletonPtr _GetInternalSkeleton() const
Gets the internal Skeleton pointer.
Definition: skeleton.cpp:142
This class encapsulates the bones contained in a skeleton used for animation.
Definition: bone.h:59
UInt16 GetNumBones() const
Gets the number of bones contained in this skeleton.
Definition: skeleton.cpp:89
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
BoneIterator BoneBegin()
Gets an iterator to the first Bone.
Definition: skeleton.cpp:94
BoneIterator BoneEnd()
Gets an iterator to one passed the last Bone.
Definition: skeleton.cpp:99
Skeleton(Ogre::SkeletonPtr InternalSkeleton)
Internal constructor.
Definition: skeleton.cpp:65