Torque2D/engine/source/gui/guiProgressCtrl.h

//-----------------------------------------------------------------------------
// Copyright (c) 2013 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 _GUIPROGRESSCTRL_H_
#define _GUIPROGRESSCTRL_H_

#ifndef _GUICONTROL_H_
#include "gui/guiControl.h"
#endif

class GuiProgressCtrl : public GuiControl, public Fluid
{
private:
   typedef GuiControl Parent;

   F32 mCurrent;
   F32 mStart;
   F32 mEnd;

public:
   //creation methods
   DECLARE_CONOBJECT(GuiProgressCtrl);
   GuiProgressCtrl();
   static void initPersistFields();

   //these methods are here for backwards compatability
   virtual const char *getScriptValue();
   virtual void setScriptValue(const char *value);

   void setCurrentProgress(F32 target);
   void setCurrentProgress(F32 target, S32 time);
   void resetProgress();
   inline F32 getCurrentProgress() { return mEnd; }
   inline F32 getDisplayedProgress() { return mCurrent; }

   void onRender(Point2I offset, const RectI &updateRect);

protected:
	virtual void processTick();
	bool animateProgressBar();
};

#endif