/**
 * @file llflashtimer.cpp
 * @brief LLFlashTimer class implementation
 *
 * $LicenseInfo:firstyear=2002&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2012, Linden Research, Inc.
 *
 * This library 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;
 * version 2.1 of the License only.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */


#include "llviewerprecompiledheaders.h"

#include "llflashtimer.h"
#include "llviewercontrol.h"
#include "lleventtimer.h"

LLFlashTimer::LLFlashTimer(callback_t cb, S32 count, F32 period)
		: LLEventTimer(period)
		, mCallback(cb)
		, mCurrentTickCount(0)
        , mIsFlashing(false)
{
	mEventTimer.stop();

	// By default use settings from settings.xml to be able change them via Debug settings. See EXT-5973.
	// Due to Timer is implemented as derived class from EventTimer it is impossible to change period
	// in runtime. So, both settings are made as required restart.
	mFlashCount = 2 * ((count>0)? count : gSavedSettings.getS32("FlashCount"));
	if (mPeriod<=0)
	{
		mPeriod = gSavedSettings.getF32("FlashPeriod");
	}
}

BOOL LLFlashTimer::tick()
{
	mIsHighlight = !(mCurrentTickCount % 2);
	if (mCallback)
	{
		mCallback(mIsHighlight);
	}

	if (++mCurrentTickCount >= mFlashCount)
	{
		mEventTimer.stop();
	}

	return FALSE;
}

void LLFlashTimer::startFlashing()
{
	mCurrentTickCount = 0;
	mIsFlashing = true;
	mEventTimer.start();
}

void LLFlashTimer::stopFlashing()
{
	mIsFlashing = false;
	mIsHighlight = false;
	mEventTimer.stop();
}