Torque2D/engine/source/gui/containers/guiAutoScrollCtrl.cc

//-----------------------------------------------------------------------------
// 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.
//-----------------------------------------------------------------------------

#include "gui/containers/guiAutoScrollCtrl.h"
#include "console/consoleTypes.h"

//////////////////////////////////////////////////////////////////////////
// GuiAutoScrollCtrl
//////////////////////////////////////////////////////////////////////////
IMPLEMENT_CONOBJECT(GuiAutoScrollCtrl);

GuiAutoScrollCtrl::GuiAutoScrollCtrl()
{
   mScrolling = false;
   mCurrentTime = 0.0f;
   mStartDelay = 3.0f;
   mResetDelay = 5.0f;
   mChildBorder = 10;
   mScrollSpeed = 1.0f;
   mTickCallback = false;
   mIsContainer = true;

   // Make sure we receive our ticks.
   setProcessTicks();
}

GuiAutoScrollCtrl::~GuiAutoScrollCtrl()
{
}

//////////////////////////////////////////////////////////////////////////
// Persistence 
//////////////////////////////////////////////////////////////////////////
void GuiAutoScrollCtrl::initPersistFields()
{
   Parent::initPersistFields();

   addField("startDelay", TypeF32, Offset(mStartDelay, GuiAutoScrollCtrl));
   addField("resetDelay", TypeF32, Offset(mResetDelay, GuiAutoScrollCtrl));
   addField("childBorder", TypeS32, Offset(mChildBorder, GuiAutoScrollCtrl));
   addField("scrollSpeed", TypeF32, Offset(mScrollSpeed, GuiAutoScrollCtrl));
   addField("tickCallback", TypeBool, Offset(mTickCallback, GuiAutoScrollCtrl));
}

void GuiAutoScrollCtrl::onChildAdded(GuiControl* control)
{
   resetChild(control);
}

void GuiAutoScrollCtrl::onChildRemoved(GuiControl* control)
{
   mScrolling = false;
}

void GuiAutoScrollCtrl::resetChild(GuiControl* control)
{
   Point2I extent = control->getExtent();

   control->setPosition(Point2I(mChildBorder, mChildBorder));
   control->setExtent(Point2I(getExtent().x - (mChildBorder * 2), extent.y));

   mControlPositionY = (F32)control->getPosition().y;

   if ((mControlPositionY + extent.y) > getExtent().y)
      mScrolling = true;
   else
      mScrolling = false;

   mCurrentTime = 0.0f;
}

void GuiAutoScrollCtrl::resize( const Point2I &newPosition, const Point2I &newExtent )
{
   Parent::resize( newPosition, newExtent );

   for (iterator i = begin(); i != end(); i++)
   {
      GuiControl* control = static_cast<GuiControl*>(*i);
      if (control)
         resetChild(control);
   }
}

void GuiAutoScrollCtrl::childResized(GuiControl *child)
{
   Parent::childResized( child );

   resetChild(child);
}

void GuiAutoScrollCtrl::processTick()
{
   if (mTickCallback && isMethod("onTick") )
      Con::executef(this, 1, "onTick");
}

void GuiAutoScrollCtrl::advanceTime(F32 timeDelta)
{
   if (!mScrolling)
      return;

   if ((mCurrentTime + timeDelta) < mStartDelay)
   {
      mCurrentTime += timeDelta;
      return;
   }

   GuiControl* control = static_cast<GuiControl*>(at(0));
   if (!control)
      return;

   Point2I oldPosition = control->getPosition();
   if ((oldPosition.y + control->getExtent().y) < (getExtent().y - mChildBorder))
   {
      mCurrentTime += timeDelta;
      if (mCurrentTime > (mStartDelay + mResetDelay))
      {
         resetChild(control);
         return;
      }
   }

   else
   {
      mControlPositionY -= mScrollSpeed * timeDelta;
      control->setPosition(Point2I(oldPosition.x, (S32)mControlPositionY));
   }
}