SO3Bone.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 __SO3BONE_H__
#define __SO3BONE_H__
 
#include "SCOLBasic/SO3Prerequisites.h"
#include "SO3SceneGraph/SO3NodeScol.h"
 
namespace SO3
{
 
class SBone : public SNode
{
friend class SNode;
public:
protected:
  SSkeleton* parentSkeleton;
  Ogre::Entity* ogreLinkedEntity;
  unsigned short boneIndex;
private:
 
public:
  SBone(SScene* parent, const std::string& boneName, SSkeleton* skeleton, const unsigned short& id);
  
  ~SBone();
 
  void UnsetSkeleton();
 
  Ogre::Bone* GetOgreBonePointer();
        
  SSkeleton* GetSkeleton();
  
  virtual void Rotate(const Ogre::Vector3& axis, const float& radianAngle, const SNode::NodeTransformSpace& relativeTo=SNode::SO3_LOCAL_TS);
 
  virtual void SetOrientation(const Ogre::Quaternion& quat);
 
  virtual void AddOrientation(const Ogre::Quaternion& quat);
 
  virtual void ResetToInitialOrientation();
 
  virtual void SetPosition(const Ogre::Vector3& pos);
 
  virtual void Translate(const Ogre::Vector3& d, const SNode::NodeTransformSpace& relativeTo=SNode::SO3_PARENT_TS);
 
  virtual void SetScale(const Ogre::Vector3& scale);
 
  virtual Ogre::Vector3 GetPosition();
 
  virtual Ogre::Quaternion GetOrientation();
 
  virtual Ogre::Vector3 GetScale();
 
  virtual Ogre::Vector3 GetInitialPosition();
 
  virtual Ogre::Quaternion GetInitialOrientation();
 
  virtual Ogre::Vector3 GetInitialScale();
 
  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);
 
  virtual void SetGlobalScale(const Ogre::Vector3& pos, bool updateBody = true);
 
  virtual Ogre::Matrix4 GetTransformationMatrix();
 
  virtual void Pitch(const float& radianAngle, const SNode::NodeTransformSpace& relativeTo=SNode::SO3_LOCAL_TS);
 
  virtual void Yaw(const float& radianAngle, const SNode::NodeTransformSpace& relativeTo=SNode::SO3_LOCAL_TS);
 
  virtual void Roll(const float& radianAngle, const SNode::NodeTransformSpace& relativeTo=SNode::SO3_LOCAL_TS);
 
  virtual int GetNumChildren();
 
  virtual void StoreInitialPRS();
 
  virtual void ResetToInitialPRS();
 
  unsigned short GetIndex();
 
  Ogre::Quaternion ConvertWorldToLocalOrientation(const Ogre::Quaternion& quat);
 
  virtual void SetInheritOrientation(const bool& state);
 
  virtual bool GetInheritOrientation();
 
  virtual void ResetOrientation();
 
  void AttachToBone(Ogre::MovableObject* ogreObject);
 
  void DetachFromBone(Ogre::MovableObject* ogreObject);
 
protected:
  void AttachToBone(SNode* newChild);
 
  void DetachFromBone(SNode* existingChild);
private:
  SBone();
};
 
}
 
#endif