/* ScreenEvaluation - Shows the user their score after gameplay has ended. */

#ifndef SCREEN_EVALUATION_H
#define SCREEN_EVALUATION_H

#include "ScreenWithMenuElements.h"
#include "Sprite.h"
#include "BitmapText.h"
#include "GradeDisplay.h"
#include "Banner.h"
#include "ScoreDisplayNormal.h"
#include "DifficultyIcon.h"
#include "DifficultyMeter.h"
#include "PercentageDisplay.h"
#include "GraphDisplay.h"
#include "ComboGraph.h"
#include "BGAnimation.h"
#include "ActorUtil.h"
#include "ConditionalBGA.h"
#include "HighScore.h"
#include "RageSound.h"

const int MAX_SONGS_TO_SHOW = 5;	// In summary, we show last 3 stages, plus extra stages if passed
enum JudgeLine { marvelous, perfect, great, good, boo, miss, ok, max_combo, error, NUM_JUDGE_LINES };
enum StatsLine { jumps, holds, rolls, mines, hands, lifts, hidden, NUM_STATS_LINES };

// sound sequences for the evaluation screen
struct EvalSoundSequence
{
	float fTime;
	RageSound sSound;
};

class ScreenEvaluation : public ScreenWithMenuElements
{
public:
	enum Type	{ stage, summary, course };
	ScreenEvaluation( CString sClassName );
	virtual void Update( float fDeltaTime );
	virtual void DrawPrimitives();
	virtual void Input( const DeviceInput& DeviceI, const InputEventType type, const GameInput &GameI, const MenuInput &MenuI, const StyleInput &StyleI );
	virtual void HandleScreenMessage( const ScreenMessage SM );

//	virtual void TweenOnScreen();
	virtual void TweenOffScreen();
	virtual void MenuLeft( PlayerNumber pn );
	virtual void MenuRight( PlayerNumber pn );
	virtual void MenuBack( PlayerNumber pn );
	virtual void MenuStart( PlayerNumber pn );

protected:
	void Init();
	void CommitScores( 
		const StageStats &stageStats, 
		int iPersonalHighScoreIndexOut[NUM_PLAYERS], 
		int iMachineHighScoreIndexOut[NUM_PLAYERS], 
		RankingCategory rcOut[NUM_PLAYERS],
		PerDifficultyAward pdaToShowOut[NUM_PLAYERS],
		PeakComboAward pcaToShowOut[NUM_PLAYERS] );
	void EndScreen();

	Type				m_Type;

	float m_fScreenCreateTime;

	BGAnimation m_bgOverlay;
	ConditionalBGA m_bgCondBga;

	// player name area
	BitmapText			m_textPlayerName[NUM_PLAYERS];

	// banner area
	Banner				m_LargeBanner;
	AutoActor			m_sprLargeBannerFrame;
	AutoActor			m_sprStage;
	DifficultyIcon		m_DifficultyIcon[NUM_PLAYERS];
	DifficultyMeter		m_DifficultyMeter[NUM_PLAYERS];
	BitmapText			m_textPlayerOptions[NUM_PLAYERS];
	AutoActor			m_sprDisqualified[NUM_PLAYERS];
	Banner				m_SmallBanner[MAX_SONGS_TO_SHOW];
	AutoActor			m_sprSmallBannerFrame[MAX_SONGS_TO_SHOW];

	// grade area
	AutoActor			m_sprGradeFrame[NUM_PLAYERS];
	GradeDisplay		m_Grades[NUM_PLAYERS];
	AutoActor			m_sprGrade[NUM_PLAYERS];

	// graph area
	AutoActor			m_sprGraphFrame[NUM_PLAYERS];
	GraphDisplay		m_Graph[NUM_PLAYERS];

	// combo area
	ComboGraph			m_Combo[NUM_PLAYERS];

	// points area
	bool				m_bNewSongsUnlocked;
	PercentageDisplay	m_Percent[NUM_PLAYERS];
	AutoActor			m_sprPercentFrame[NUM_PLAYERS];

	// bonus area
	AutoActor			m_sprBonusFrame[NUM_PLAYERS];
	Sprite				m_sprPossibleBar[NUM_PLAYERS][NUM_RADAR_CATEGORIES];
	Sprite				m_sprActualBar[NUM_PLAYERS][NUM_RADAR_CATEGORIES];
	float				m_fDisplayRadarActual[NUM_PLAYERS][NUM_RADAR_CATEGORIES];

	// survived area
	AutoActor			m_sprSurvivedFrame[NUM_PLAYERS];
	BitmapText			m_textSurvivedNumber[NUM_PLAYERS];

	// win area
	AutoActor			m_sprWinFrame[NUM_PLAYERS];
	Sprite				m_sprWin[NUM_PLAYERS];

	// judgment area
	Sprite				m_sprJudgeLabels[NUM_JUDGE_LINES];
	BitmapText			m_textJudgeNumbers[NUM_JUDGE_LINES][NUM_PLAYERS];

	// stats area
	AutoActor			m_sprStatsLabel[NUM_STATS_LINES];
	BitmapText			m_textStatsText[NUM_STATS_LINES][NUM_PLAYERS];

	// score area
	int					m_iScoreDigits;
	AutoActor			m_sprScoreLabel;
	BitmapText			m_textScore[NUM_PLAYERS];

	// total score area
	AutoActor			m_sprTotalScoreLabel;
	BitmapText			m_textTotalScore[NUM_PLAYERS];

	// time area
	AutoActor			m_sprTimeLabel;
	BitmapText			m_textTime[NUM_PLAYERS];

	// extra area
	AutoActor			m_sprMachineRecord[NUM_PLAYERS];
	AutoActor			m_sprPersonalRecord[NUM_PLAYERS];
	bool				m_bTryExtraStage;
	AutoActor			m_sprTryExtraStage;
	AutoActor			m_PerDifficultyAward[NUM_PLAYERS];
	AutoActor			m_PeakComboAward[NUM_PLAYERS];
	bool m_bFailed;

	RageSound	m_soundStart;	// sound played if the player passes or fails

	// sound effects for other gametypes
	RageSound	m_sndPassFail;	// sound played if the player passes or fails
	bool m_bPassFailTriggered; // has the pass / fail sound been played yet?
	RageTimer m_timerSoundSequences; // timer used for triggering sounds.
	vector<EvalSoundSequence> m_SoundSequences; // a sequence of sounds to be played (although they're stored in no particular order!)	

	HighScore m_HighScore[NUM_PLAYERS];
	bool m_bSavedScreenshot[NUM_PLAYERS];
};

#endif

/*
 * (c) 2001-2004 Chris Danford
 * All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, and/or sell copies of the Software, and to permit persons to
 * whom the Software is furnished to do so, provided that the above
 * copyright notice(s) and this permission notice appear in all copies of
 * the Software and that both the above copyright notice(s) and this
 * permission notice appear in supporting documentation.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
 * THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
 * INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
 * OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
 * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
