path: root/src/menu/drawable.hpp

/*
 * UltraStar Deluxe - Karaoke Game
 *
 * UltraStar Deluxe is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef DRAWABLE_HPP
#define DRAWABLE_HPP

namespace usdx
{
	/**
	 * Abstract base class for all classes that could be draw.
	 */
	class Drawable
	{
	private:
		/**
		 * Whether the drawable should be visible at the moment or not.
		 */
		bool visible;

	protected:
		/**
		 * Pure virtual method, that descendant classes have to
		 * implement. It should contain all actions that are required for
		 * displaying this drawable. This methoed gets allways called from the
		 * same thread, from that the video output is initialized at programm
		 * start.
		 *
		 * WARNING: This method should not be called manually. If you want to
		 * request, that a drawable is redrawn, use repaint() instead.
		 */
		virtual void draw(void) = 0;

	public:
 		Drawable(void);
		virtual ~Drawable(void) {};

		/**
		 * Method for redraw this object. If visible executes the draw method.
		 */
		virtual void repaint(void);

		/**
		 * Set if the drawable should be visible.
		 */
		virtual void set_visible(bool value);

		/**
		 * Returns whether the drawable should be visible.
		 */
		virtual const bool is_visible(void) const;
	};
};

#endif