
/**
 *
 * @file paletteeffects.h
 *
 * Part of the OpenJazz project
 *
 * @par History:
 * - 23rd August 2005: Created OpenJazz.h
 * - 4th February 2009: Created palette.h from parts of OpenJazz.h
 * - 1st August 2009: Renamed palette.h to paletteeffects.h
 *
 * @par Licence:
 * Copyright (c) 2005-2010 Alister Thomson
 *
 * OpenJazz is distributed under the terms of
 * the GNU General Public License, version 2.0
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */


#ifndef _PALETTE_H
#define _PALETTE_H


#include "OpenJazz.h"

#include <SDL.h>


// Constants

// Types of palette effect
#define PE_FADE   0 /* Fades to black, then remains black */
#define PE_ROTATE 1 /* Cyclical colour animation */

// Level background palette effects
#define PE_SKY    2 /* Transfers the appropriate section of the background
                       palette to the main palette */
#define PE_2D     8 /* Real parallaxing background */
#define PE_1D     9 /* Diagonal lines parallaxing background */
#define PE_WATER  11 /* The deeper below water, the darker it gets */


// Class

/// Palette effect base class
class PaletteEffect {

	protected:
		PaletteEffect* next; ///< Next effect to use

	public:
		PaletteEffect          (PaletteEffect* nextPE);
		virtual ~PaletteEffect ();

		virtual void apply (SDL_Color* shownPalette, bool direct, int mspf);

};

/// Dissolve from white palette effect
class WhiteInPaletteEffect : public PaletteEffect {

	private:
		int   duration;  ///< Number of milliseconds the effect lasts
		fixed whiteness;

	public:
		WhiteInPaletteEffect (int newDuration, PaletteEffect* nextPE);

		void apply (SDL_Color* shownPalette, bool direct, int mspf);

};

/// Fade in palette effect
class FadeInPaletteEffect : public PaletteEffect {

	private:
		int   duration;  ///< Number of milliseconds the effect lasts
		fixed blackness;

	public:
		FadeInPaletteEffect (int newDuration, PaletteEffect* nextPE);

		void apply (SDL_Color* shownPalette, bool direct, int mspf);

};

/// Dissolve to white palette effect
class WhiteOutPaletteEffect : public PaletteEffect {

	private:
		int   duration;  ///< Number of milliseconds the effect lasts
		fixed whiteness;

	public:
		WhiteOutPaletteEffect (int newDuration, PaletteEffect* nextPE);

		void apply  (SDL_Color* shownPalette, bool direct, int mspf);

};

/// Fade out palette effect
class FadeOutPaletteEffect : public PaletteEffect {

	private:
		int   duration;  ///< Number of milliseconds the effect lasts
		fixed blackness;

	public:
		FadeOutPaletteEffect (int newDuration, PaletteEffect* nextPE);

		void apply (SDL_Color* shownPalette, bool direct, int mspf);

};

/// Flash colour (dissolve to it and back again) palette effect
class FlashPaletteEffect : public PaletteEffect {

	private:
		int           duration;  ///< Number of milliseconds the effect lasts
		fixed         progress;
		unsigned char red, green, blue; ///< Flash colour

	public:
		FlashPaletteEffect (unsigned char newRed, unsigned char newGreen, unsigned char newBlue, int newDuration, PaletteEffect* nextPE);

		void apply (SDL_Color* shownPalette, bool direct, int mspf);

};

/// Entry rotation palette effect
class RotatePaletteEffect : public PaletteEffect {

	private:
		unsigned char first;    ///< The first palette index affected
		int           amount;   ///< The number of (consecutive) palette indices affected
		fixed         speed;    ///< Rotations per second
		fixed         position;

	public:
		RotatePaletteEffect (unsigned char newFirst, int newAmount, fixed newSpeed, PaletteEffect* nextPE);

		void apply (SDL_Color* shownPalette, bool direct, int mspf);

};

/// Sky palette palette effect
class SkyPaletteEffect : public PaletteEffect {

	private:
		SDL_Color*    skyPalette;
		unsigned char first;      ///< The first palette index affected
		int           amount;     ///< The number of (consecutive) palette indices affected
		fixed         speed;      ///< Relative Y speed - as in Jazz 2

	public:
		SkyPaletteEffect (unsigned char newFirst, int newAmount, fixed newSpeed, SDL_Color* newSkyPalette, PaletteEffect* nextPE);

		void apply (SDL_Color* shownPalette, bool direct, int mspf);

};

/// 2D parallaxing background palette effect
class P2DPaletteEffect : public PaletteEffect {

	private:
		unsigned char first;  ///< The first palette index affected
		int           amount; ///< The number of (consecutive) palette indices affected
		fixed         speed;  ///< Relative X & Y speed - as in Jazz 2

	public:
		P2DPaletteEffect (unsigned char newFirst, int newAmount, fixed newSpeed, PaletteEffect* nextPE);

		void apply (SDL_Color* shownPalette, bool direct, int mspf);

};

/// 1D parallaxing background palette effect
class P1DPaletteEffect : public PaletteEffect {

	private:
		unsigned char first;    ///< The first palette index affected
		int           amount;   ///< The number of (consecutive) palette indices affected
		fixed         speed;    ///< Relative X & Y speed - as in Jazz 2

	public:
		P1DPaletteEffect (unsigned char newFirst, int newAmount, fixed newSpeed, PaletteEffect* nextPE);

		void apply (SDL_Color* shownPalette, bool direct, int mspf);

};

/// Underwater darkening palette effect
class WaterPaletteEffect : public PaletteEffect {

	private:
		fixed depth; ///< Number of pixels between water surface and total darkness

	public:
		WaterPaletteEffect (fixed newDepth, PaletteEffect* nextPE);

		void apply (SDL_Color* shownPalette, bool direct, int mspf);

};


#endif


