Tween.h

//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------

#ifndef TWEEN_ENGINE_H
#define TWEEN_ENGINE_H

#include "platform/platform.h"
#include "console/consoleTypes.h"
#include "console/engineAPI.h"
#include "console/simObject.h"
#include "core\iTickable.h"
#include "math/mConstants.h"
#include "math/mMathFn.h"
#include "math/mEase.h"

class Tween : public SimObject, public ITickable
{
   typedef SimObject Parent;

   enum TweenState{
      Idle,
      Playing,
      Paused,
      PlayingReversed
   };

public:
   Tween();
   void SetValueByTime(F32 time);
   void SetTargetField(F32 value);
   void SetGlobalField(F32 value);
   void SetInitialValue();

   void Play();
   void Reverse();
   void Rewind();
   void Pause();

   //-------------------------------------------
   // SimObject
   //-------------------------------------------
   virtual bool onAdd();
   virtual void onRemove();
   static void initPersistFields();

   //-------------------------------------------
   // ITickable
   //-------------------------------------------
   virtual void interpolateTick( F32 delta );
   virtual void processTick();
   virtual void advanceTime( F32 timeDelta );

   // Fields ------------------------------------
   F32 mDuration;
   F32 mCurrentTime;
   SimObject* mTarget;
   const char* mValueName;
   F32 mValueTarget;
   F32 mInitialValue;
   Ease::enumDirection mEaseDirection;
   Ease::enumType mEaseType;
   TweenState mState;

   DECLARE_CALLBACK(void, onFinished, ());
   DECLARE_CONOBJECT(Tween);
};

#endif // TWEEN_ENGINE_H