SO3Anim.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 __SO3_ANIM_H__
#define __SO3_ANIM_H__
 
#include "SCOLBasic/SO3Prerequisites.h"
#include "SCOLBasic/SO3DataScol.h"
 
namespace SO3
{
 
class SAnim : public SData
{
public:
  enum AnimType
  {
    SO3_UNKNOWN_ANIM   = 0,
    SO3_SCENENODE_ANIM = 1,
    SO3_SKELETAL_ANIM  = 2,
    SO3_VERTEX_ANIM    = 3,
    SO3_FAP_ANIM       = 4, // Deprecated
    SO3_POSE_ANIM      = 5,
    SO3_SEQUENCE_ANIM  = 6
  };
  enum AnimInterpolationMode
  {
    SO3_IM_LINEAR,          
    SO3_IM_SPLINE           
  };
  enum AnimRotationInterpolationMode
  {
    SO3_RIM_LINEAR,         
    SO3_RIM_SPHERICAL       
  };
protected:
  Ogre::Animation* ogreAnimation;
  SAnimTrackList animationTrackList;
  SScene* mScene;
private:
  SAnimationFrameListener* ogreAnimationFrameListener;
  const AnimType type;
  float mSpeed;
  float mWeight;
  bool mLoop;
  bool isPaused;
  bool skipFrame;
  SNode* associatedNode;
  unsigned short animationIndex;
  unsigned short bUpdatedBySequence;
public:
  // No public constructors, class must be derivated
 
  virtual ~SAnim();
 
  Ogre::Animation* GetOgreAnimationPointer();
 
  SNode* GetParentNode();
 
  SScene* GetParentScene();
 
  AnimType GetType();
 
  bool IsSequenceUpdated();
  
  void SetSequenceUpdated(const bool& value);
 
  unsigned short GetIndex();
 
  SAnimTrack* CreateAnimationTrack(const std::string& newAnimationTrackName);
 
  void DeleteAnimationTrack(SAnimTrack* existingAnimationTrack);
 
  unsigned short GetNumAnimationsTracks();
 
  SAnimTrack* GetAnimationTrack(const unsigned short& index);
 
  SAnimTrackList GetAnimationsTracks() const;
 
  void SetLength(const float& length);
 
  float GetLength();
 
  virtual void SetTimePosition(const float& timePosition);
 
  float GetTimePosition();
 
  void Apply(const float& timePosition);
 
  virtual void SetWeight(const float& weight);
 
  virtual float GetWeight();
 
  void SetInitialWeight(const float& weight);
 
  float GetInitialWeight();
 
  void SetInitialLoop(const bool& loop);
 
  bool GetInitialLoop();
 
  void SetInterpolationMode(const AnimInterpolationMode& interpolationMode);
 
  AnimInterpolationMode GetInterpolationMode();
 
  void SetRotationInterpolationMode(const AnimRotationInterpolationMode& interpolationMode);
 
  AnimRotationInterpolationMode GetRotationInterpolationMode();
 
  virtual void SetEnable(const bool& enable);
 
  virtual bool GetEnable();
 
  void SetLoop(const bool& loop); 
 
  bool GetLoop();
 
  bool SkipFrame();
 
  void SetSkipFrame(const bool& state);
 
  void SetOptimise(const bool& optimize);
 
  //bool GetOptimise();
 
  void SetSpeed(const float& newSpeed);
 
  float GetSpeed();
 
  bool HasEnded();
 
  void AddTime(const float& time);
 
  void SetPaused(const bool& pauseState);
 
  bool GetPaused();
 
  void Update(const Ogre::FrameEvent& evt);
 
  virtual void _UpdateImpl(const Ogre::FrameEvent &evt);
protected:
  SAnim(SScene* scene, const std::string& animationName, SNode* animationAssociatedNode, const unsigned short& animationId, const AnimType& animationType);
 
  void AddAnimationTrack(SAnimTrack* existingAnimationTrack);
 
  void RemoveAnimationTrack(SAnimTrack* existingAnimationTrack);
 
  virtual SAnimTrack* CreateAnimationTrackImpl(const std::string& newAnimationTrackName);
 
  virtual Ogre::AnimationState* _GetOgreAnimationState() = 0;
private:
  SAnim();
};
 
class SAnimationFrameListener : public Ogre::FrameListener
{
public:
protected:
private:
  SAnim* animation;
 
public:
  SAnimationFrameListener(SAnim* animationListened);
  
  ~SAnimationFrameListener();
  
  bool frameStarted(const Ogre::FrameEvent& evt);
protected:
private:
};
 
}
 
#endif