phoenix-firestorm/indra/llui/llloadingindicator.h

88 lines
2.1 KiB
C++

/**
* @file llloadingindicator.h
* @brief Perpetual loading indicator
*
* $LicenseInfo:firstyear=2010&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, 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$
*/
#ifndef LL_LLLOADINGINDICATOR_H
#define LL_LLLOADINGINDICATOR_H
#include "lluictrl.h"
///////////////////////////////////////////////////////////////////////////////
// class LLLoadingIndicator
///////////////////////////////////////////////////////////////////////////////
/**
* Perpetual loading indicator (a la MacOSX or YouTube)
*
* Number of rotations per second can be overriden
* with the "roations_per_sec" parameter.
*
* Can start/stop spinning.
*
* @see start()
* @see stop()
*/
class LLLoadingIndicator
: public LLUICtrl
{
LOG_CLASS(LLLoadingIndicator);
public:
struct Params : public LLInitParam::Block<Params, LLUICtrl::Params>
{
Optional<F32> rotations_per_sec;
Params()
: rotations_per_sec("rotations_per_sec", 1.0f)
{}
};
virtual ~LLLoadingIndicator() {}
// llview overrides
virtual void draw();
/**
* Stop spinning.
*/
void stop();
/**
* Start spinning.
*/
void start();
private:
LLLoadingIndicator(const Params&);
friend class LLUICtrlFactory;
class Data;
F32 mRotationsPerSec;
S8 mCurImageIdx;
LLPointer<LLUIImage> mCurImagep;
LLFrameTimer mImageSwitchTimer;
};
#endif // LL_LLLOADINGINDICATOR_H