scummvm-cursorfix/engines/hpl1/penumbra-overture/Notebook.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM 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 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/*
 * Copyright (C) 2006-2010 - Frictional Games
 *
 * This file is part of Penumbra Overture.
 */

#ifndef GAME_NOTE_BOOK_H
#define GAME_NOTE_BOOK_H

#include "hpl1/engine/engine.h"

#include "hpl1/penumbra-overture/GameTypes.h"

using namespace hpl;

class cInit;
class cNotebook_GlobalSave;

//---------------------------

#define eNotebookState_Front 0
#define eNotebookState_TaskList 1
#define eNotebookState_NoteList 2
#define eNotebookState_Note 3

//---------------------------

enum eNotebookType {
	eNotebookType_Front,
	eNotebookType_Open,
};

//---------------------------

class cNotebook_Note {
public:
	cNotebook_Note() : mbRead(false), mfAlpha(0) {}

	tWString msName;
	tWString msText;
	bool mbRead;
	float mfAlpha;
	cRect2f mRect;

	tString msTextCat;
	tString msTextEntry;
};

typedef Common::List<cNotebook_Note *> tNotebook_NoteList;
typedef tNotebook_NoteList::iterator tNotebook_NoteListIt;

typedef cSTLIterator<cNotebook_Note *, tNotebook_NoteList, tNotebook_NoteListIt> tNotebook_NoteList_Iterator;

//--------------------------------------------------------

class cNotebook;

class iNotebookState : public iAIState {
public:
	iNotebookState(cInit *apInit, cNotebook *apNotebook) : iAIState() {
		mpInit = apInit;
		mpNotebook = apNotebook;
	}

	virtual void OnMouseDown(eMButton aButton) {}

	virtual void OnDraw() {}

	virtual void OnExit() {}

protected:
	cInit *mpInit;
	cNotebook *mpNotebook;
};

//---------------------------------------------------

class cNoteBook_Option {
public:
	cNoteBook_Option() : mfAlpha(0) {}

	tWString msText;
	cVector3f mvPos;
	cRect2f mRect;
	float mfAlpha;
};

class cNotebookState_Front : public iNotebookState {
public:
	cNotebookState_Front(cInit *apInit, cNotebook *apNotebook);

	void OnEnterState(int alLastState);
	void OnLeaveState(int alNextState);

	void OnUpdate(float afTime);

	void OnDraw();

	void OnMouseDown(eMButton aButton);

	void OnExit();

	cGraphicsDrawer *mpDrawer;
	cGfxObject *mpTextBack;

	FontData *mpFrontFont;
	Common::Array<cNoteBook_Option> mvOptions;
	int mlSelected;
	cVector2f mvFontSize;
};

//-----------------------------------------------------

class cNotebook_TaskPage {
public:
	int mlStartTask;
	int mlEndTask;
};

//-----------------------------------------------------

class cNotebookState_TaskList : public iNotebookState {
public:
	cNotebookState_TaskList(cInit *apInit, cNotebook *apNotebook);

	void OnEnterState(int alLastState);
	void OnLeaveState(int alNextState);

	void OnUpdate(float afTime);

	void OnDraw();

	void OnMouseDown(eMButton aButton);

	void OnExit();

	FontData *mpTextFont;

	float mfFontSize;

	int mlCurrentPage;
	Common::Array<cNotebook_TaskPage> mvTaskPages;

	int mlSelected;
	Common::Array<cNoteBook_Option> mvOptions;
	cGraphicsDrawer *mpDrawer;
	cGfxObject *mpOptionsImage[2];
};

//--------------------------------------------------------

class cNotebookState_NoteList : public iNotebookState {
public:
	cNotebookState_NoteList(cInit *apInit, cNotebook *apNotebook);

	void OnEnterState(int alLastState);
	void OnLeaveState(int alNextState);

	void OnUpdate(float afTime);
	void OnDraw();
	void OnMouseDown(eMButton aButton);
	void OnExit();

	cGraphicsDrawer *mpDrawer;
	cGfxObject *mpTextBack;
	cGfxObject *mpTab;

	int mlMaxNotesPerPage;
	int mlFirstNote;

	int mlSelected;

	FontData *mpTextFont;
	tWString msUnread;
	cVector2f mvSize;
	cNotebook_Note *mpSelectedNote;

	Common::Array<cNoteBook_Option> mvOptions;
	cGfxObject *mpOptionsImage[2];
};

//--------------------------------------------------------

class cNotePage {
public:
	int mlStart;
	int mlEnd;
};

class cNotebookState_Note : public iNotebookState {
public:
	cNotebookState_Note(cInit *apInit, cNotebook *apNotebook);

	void OnEnterState(int alLastState);
	void OnLeaveState(int alNextState);

	void OnUpdate(float afTime);
	void OnDraw();
	void OnMouseDown(eMButton aButton);
	void OnExit();

	FontData *mpTextFont;
	FontData *mpNavigateFont;
	tWStringVec mvRows;

	Common::Array<cNotePage> mvPages;

	int mlCurrentPage;
	int mlMaxRows;
	cVector2f mvSize;

	int mlSelected;
	Common::Array<cNoteBook_Option> mvOptions;
	cGraphicsDrawer *mpDrawer;
	cGfxObject *mpOptionsImage[2];
};

//--------------------------------------------------------

class cNotebook_BookType {
public:
	cGfxObject *mpGfxImage;
	float mfAlpha;
	eNotebookType mType;
};

//--------------------------------------------------------

class cNotebook_BookTask {
public:
	tString msName;
	tWString msText;
};

typedef Common::List<cNotebook_BookTask *> tNotebook_BookTaskList;
typedef tNotebook_BookTaskList::iterator tNotebook_BookTaskListIt;

typedef cSTLIterator<cNotebook_BookTask *, tNotebook_BookTaskList, tNotebook_BookTaskListIt> tNotebook_BookTaskList_Iterator;

//--------------------------------------------------------

class cNotebook : public iUpdateable {
public:
	cNotebook(cInit *apInit);
	~cNotebook();

	void OnStart();
	void Update(float afTimeStep);
	void OnDraw();
	void Reset();

	void SetMousePos(const cVector2f &avPos);
	void AddMousePos(const cVector2f &avRel);
	cVector2f GetMousePos() { return mvMousePos; }

	void OnMouseDown(eMButton aButton);
	void OnMouseUp(eMButton aButton);

	void OnExit();

	void SetActive(bool abX);
	bool IsActive() { return mbActive; }

	float GetAlpha() { return mfAlpha; }

	void SetBookType(eNotebookType aType);
	eNotebookType GetBookType() { return mBookType; }

	tNotebook_NoteList_Iterator GetNoteIterator();
	cNotebook_Note *AddNote(const tWString &asName, const tString &asTextCat, const tString &asTextEntry);
	void RemoveNote(const tString &asName);
	int GetNoteNum() { return (int)mlstNotes.size(); }

	tNotebook_BookTaskList_Iterator GetTaskIterator();
	void AddTask(const tString &asName, const tWString &asText);
	void RemoveTask(const tString &asName);
	int GetTaskNum() { return (int)mlstTasks.size(); }

	cNotebook_Note *GetSelectedNote() { return mpSelectedNote; }
	void SetSelectedNote(cNotebook_Note *apNote) { mpSelectedNote = apNote; }

	cStateMachine *GetStateMachine() { return &mStateMachine; }

	/////////////////////////////////////////
	// Saving
	void SaveToGlobal(cNotebook_GlobalSave *apSave);
	void LoadFromGlobal(cNotebook_GlobalSave *apSave);

private:
	cInit *mpInit;
	cGraphicsDrawer *mpDrawer;

	cGfxObject *mpGfxBackground;

	cStateMachine mStateMachine;

	bool mbActive;
	float mfAlpha;

	Common::Array<cNotebook_BookType> mvBookTypes;

	eNotebookType mBookType;

	eCrossHairState mLastCrossHairState;

	bool mbInventoryWasActive;

	tNotebook_BookTaskList mlstTasks;
	tNotebook_NoteList mlstNotes;

	cNotebook_Note *mpSelectedNote;

	cVector2f mvMousePos;
};

#endif // GAME_NOTE_BOOK_H