SO3Skeleton.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OpenSpace3D
For the latest info, see http://www.openspace3d.com
 
Copyright (c) 2012 I-maginer
 
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
 
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt
 
-----------------------------------------------------------------------------
*/
 
#ifndef __SO3SKELETON_H__
#define __SO3SKELETON_H__
 
#include "SCOLBasic/SO3Prerequisites.h"
#include "SO3SceneGraph/SO3NodeScol.h"
 
namespace SO3
{
 
class SSkeleton : public SNode
{
public:
  enum SkeletonAnimationMode 
  {
          SO3_ANIMBLEND_AVERAGE,   //<! Animations are applied by calculating a weighted average of all animations
    SO3_ANIMBLEND_CUMULATIVE //<! Animations are applied by calculating a weighted cumulative total
  };
protected:
  SEntity* linkedEntity;
  Ogre::Entity* ogreLinkedEntity;
  SBoneMap boneList;
  SBoneMap rootBonesList;
  SBoneIndexMap boneListByIndex;
private:
 
public:
  SSkeleton(SScene* parent, const std::string& skeletonName, SEntity* parentEntity);
 
  ~SSkeleton();
 
  void Initialise();
 
  void SetBindingPose();
 
  SkeletonAnimationMode GetBlendMode();
 
  void SetBlendMode(const SkeletonAnimationMode& newBlendMode);
 
  unsigned short GetNumBones();
 
  SBone* GetBone(const std::string& boneName);
 
  SBone* GetBone(const unsigned short& boneIndex);
 
  SBoneMap GetBones() const;
 
  Ogre::SkeletonInstance* GetOgreSkeletonPointer();
 
  SEntity* GetParentEntity();
 
  SBoneMap GetRootBones();
 
  void _OnBoneDeletion(SBone* boneInstance);
 
  virtual Ogre::Vector3 GetGlobalPosition();
 
  virtual Ogre::Quaternion GetGlobalOrientation();
 
  virtual Ogre::Vector3 GetGlobalScale();
 
  virtual void SetGlobalPosition(const Ogre::Vector3& pos, bool updateBody = true);
 
  virtual void SetGlobalOrientation(const Ogre::Quaternion& quat, bool updateBody = true);
protected:
  void AddBone(SBone* existingBone);
 
  void RemoveBone(SBone* existingBone);
 
  void RemoveBone(const std::string& boneName);
private:
  SSkeleton();
};
 
}
 
#endif