/elec/propeller-clock : contents of src/modes/mode.h at revision 88

: (revision 88)

To get this branch, use:

bzr branch
http://bzr.ed.am/elec/propeller-clock

/*
 * mode.h
 *
 * Copyright (C) 2012 Tim Marston <tim@ed.am> and Dan Marston.
 *
 * This file is part of propeller-clock (hereafter referred to as "this
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 * information.
 *
 * This program 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, either version 3 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _MODE_H_
#define _MODE_H_


class Mode
{
public:

	/**
	 * Called once per segment to draw a column of LEDs.
	 * @param segment the segment number to draw
	 */
	virtual void draw( int segment );

	/**
	 * Called at the start of a "frame", before any segments are drawn.
	 */
	virtual void draw_reset();

	/**
	 * Called when the mode is becoming active.
	 */
	virtual void activate();

	/**
	 * Called when the mode is becoming inactive.
	 */
	virtual void deactivate();

	/**
	 * Called when the button has been pressed.
	 */
	virtual void press();
};


#endif //_MODE_H_

87 by edam switched back to using classes for modes	1	/*
	2	* mode.h
	3	*
	4	* Copyright (C) 2012 Tim Marston <tim@ed.am> and Dan Marston.
	5	*
	6	* This file is part of propeller-clock (hereafter referred to as "this
	7	* program"). See http://ed.am/dev/software/arduino/propeller-clock for more
	8	* information.
	9	*
	10	* This program is free software: you can redistribute it and/or modify
	11	* it under the terms of the GNU Lesser General Public License as published
	12	* by the Free Software Foundation, either version 3 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU Lesser General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU Lesser General Public License
	21	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	22	*/
	23	#ifndef _MODE_H_
	24	#define _MODE_H_
	25
	26
	27	class Mode
	28	{
	29	public:
	30
	31	/**
	32	* Called once per segment to draw a column of LEDs.
	33	* @param segment the segment number to draw
	34	*/
	35	virtual void draw( int segment );
	36
	37	/**
	38	* Called at the start of a "frame", before any segments are drawn.
	39	*/
	40	virtual void draw_reset();
	41
	42	/**
	43	* Called when the mode is becoming active.
	44	*/
	45	virtual void activate();
	46
	47	/**
	48	* Called when the mode is becoming inactive.
	49	*/
	50	virtual void deactivate();
	51
	52	/**
	53	* Called when the button has been pressed.
	54	*/
	55	virtual void press();
	56	};
	57
	58
	59	#endif //_MODE_H_