Initial commit

engines/hpl1/engine/gui/Gui.h

@@ -0,0 +1,165 @@
+/* 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 HPL1 Engine.
+ */
+
+#ifndef HPL_GUI_H
+#define HPL_GUI_H
+
+#include "hpl1/engine/game/Updateable.h"
+
+#include "hpl1/engine/gui/GuiTypes.h"
+#include "hpl1/engine/system/SystemTypes.h"
+#include "common/stablemap.h"
+
+namespace hpl {
+
+class cResources;
+class cGraphics;
+class cSound;
+class cScene;
+
+class cGuiSet;
+class cGuiSkin;
+class cGuiGfxElement;
+
+class iGuiMaterial;
+
+//------------------------------------------------
+
+typedef Common::StableMap<tString, cGuiSet *> tGuiSetMap;
+typedef tGuiSetMap::iterator tGuiSetMapIt;
+
+//-------------------------------------
+
+typedef Common::StableMap<tString, cGuiSkin *> tGuiSkinMap;
+typedef tGuiSkinMap::iterator tGuiSkinMapIt;
+
+//-------------------------------------
+
+typedef Common::StableMap<tString, eGuiSkinGfx> tGuiSkinGfxMap;
+typedef tGuiSkinGfxMap::iterator tGuiSkinGfxMapIt;
+
+typedef Common::StableMap<tString, eGuiSkinFont> tGuiSkinFontMap;
+typedef tGuiSkinFontMap::iterator tGuiSkinFontMapIt;
+
+typedef Common::StableMap<tString, eGuiSkinAttribute> tGuiSkinAttributeMap;
+typedef tGuiSkinAttributeMap::iterator tGuiSkinAttributeMapIt;
+
+//------------------------------------------------
+
+class cGui : public iUpdateable {
+public:
+	cGui();
+	~cGui();
+
+	///////////////////////////////
+	// General
+
+	void Init(cResources *apResources, cGraphics *apGraphics,
+			  cSound *apSound, cScene *apScene);
+
+	void Update(float afTimeStep);
+
+	void OnPostSceneDraw();
+	void OnPostGUIDraw();
+
+	iGuiMaterial *GetMaterial(eGuiMaterial aType);
+
+	///////////////////////////////
+	// Skins
+	cGuiSkin *CreateSkin(const tString &asFile);
+
+	eGuiSkinGfx GetSkinGfxFromString(const tString &asType);
+	eGuiSkinFont GetSkinFontFromString(const tString &asType);
+	eGuiSkinAttribute GetSkinAttributeFromString(const tString &asType);
+
+	///////////////////////////////
+	// Sets
+	cGuiSet *CreateSet(const tString &asName, cGuiSkin *apSkin);
+	cGuiSet *GetSetFromName(const tString &asName);
+	void SetFocus(cGuiSet *apSet);
+	void SetFocusByName(const tString &asSetName);
+	cGuiSet *GetFocusedSet() { return mpSetInFocus; }
+	void DestroySet(cGuiSet *apSet);
+
+	///////////////////////////////
+	// Graphics creation
+	cGuiGfxElement *CreateGfxFilledRect(const cColor &aColor, eGuiMaterial aMaterial, bool abAddToList = true);
+	cGuiGfxElement *CreateGfxImage(const tString &asFile, eGuiMaterial aMaterial,
+								   const cColor &aColor = cColor(1, 1), bool abAddToList = true);
+	cGuiGfxElement *CreateGfxTexture(const tString &asFile, eGuiMaterial aMaterial,
+									 const cColor &aColor = cColor(1, 1), bool abMipMaps = false,
+									 bool abAddToList = true);
+	// Loads several images asFile+00, etc. Used for animations.
+	// Must have extension!
+	cGuiGfxElement *CreateGfxImageBuffer(const tString &asFile, eGuiMaterial aMaterial,
+										 bool abCreateAnimation = true,
+										 const cColor &aColor = cColor(1, 1), bool abAddToList = true);
+
+	void DestroyGfx(cGuiGfxElement *apGfx);
+
+	///////////////////////////////
+	// Input sending
+	bool SendMousePos(const cVector2f &avPos, const cVector2f &avRel);
+	bool SendMouseClickDown(eGuiMouseButton aButton);
+	bool SendMouseClickUp(eGuiMouseButton aButton);
+	bool SendMouseDoubleClick(eGuiMouseButton aButton);
+
+	bool SendKeyPress(Common::KeyState keyPress);
+
+	// bool SentArrowKey(eGuiArrowKey aDir);
+
+	///////////////////////////////
+	// Properties
+	cResources *GetResources() { return mpResources; }
+
+private:
+	void GenerateSkinTypeStrings();
+
+	cResources *mpResources;
+	cGraphics *mpGraphics;
+	cSound *mpSound;
+	cScene *mpScene;
+
+	cGuiSet *mpSetInFocus;
+
+	tGuiSetMap m_mapSets;
+	tGuiSkinMap m_mapSkins;
+
+	iGuiMaterial *mvMaterials[eGuiMaterial_LastEnum];
+
+	tGuiGfxElementList mlstGfxElements;
+
+	tGuiSkinGfxMap m_mapSkinGfxStrings;
+	tGuiSkinFontMap m_mapSkinFontStrings;
+	tGuiSkinAttributeMap m_mapSkinAttributeStrings;
+
+	unsigned long mlLastRenderTime;
+};
+
+} // namespace hpl
+
+#endif // HPL_GUI_H