Initial commit

engines/stark/services/staticprovider.h

@@ -0,0 +1,140 @@
+/* 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/>.
+ *
+ */
+
+#ifndef STARK_SERVICES_STATIC_PROVIDER_H
+#define STARK_SERVICES_STATIC_PROVIDER_H
+
+#include "common/array.h"
+#include "common/path.h"
+#include "common/scummsys.h"
+
+namespace Stark {
+
+namespace Resources {
+class Anim;
+class Image;
+class Level;
+class Location;
+class Sound;
+}
+
+class ArchiveLoader;
+class Global;
+class VisualImageXMG;
+
+/**
+ * Static Resource provider.
+ *
+ * Maintains the static resource trees.
+ * Maintained trees are the level and the location ones.
+ */
+class StaticProvider {
+public:
+	explicit StaticProvider(ArchiveLoader *archiveLoader);
+
+	enum UIElement {
+		kInventoryScrollUpArrow = 1,
+		kInventoryScrollDownArrow = 2,
+		kImages = 4,
+		kActionMenuBg = 5,
+		kTextScrollUpArrow = 6,
+		kTextScrollDownArrow = 7,
+		kQuit = 8,
+		kCheckMark = 13,
+		kVolume = 14,
+		kDiaryNormal = 15,
+		kInventory = 16,
+		kExitArrow = 17,
+		kExitArrowLeft = 18,
+		kExitArrowRight = 19,
+		kTextBackgroundActive = 20,
+		kTextBackgroundPassive = 21,
+		kDiaryTabbed = 22
+	};
+
+	enum UIImage {
+		kInventoryBg = 0,
+		kDialogOptionBullet = 4
+	};
+
+	enum UISound {
+		kActionMouthHover = 0,
+		kActionHover = 1,
+		kInventoryNewItem = 2
+	};
+
+	/** Load the static level archive */
+	void init();
+
+	/** State update loop */
+	void onGameLoop();
+
+	/** Release the static resources */
+	void shutdown();
+
+	/** Obtain the static level */
+	Resources::Level *getLevel() const { return _level; }
+
+	/** Get an image for a static cursor */
+	VisualImageXMG *getCursorImage(uint32 cursor) const;
+
+	/** Get an image for a static UI element */
+	VisualImageXMG *getUIElement(UIElement element) const;
+	VisualImageXMG *getUIElement(UIElement element, uint32 index) const;
+
+	/** Get an image for a static UI element */
+	VisualImageXMG *getUIImage(UIImage image) const;
+
+	/** Get a static UI sound resource */
+	Resources::Sound *getUISound(UISound sound) const;
+
+	/** Move execution of a static UI element anim script to the specified item */
+	void goToAnimScriptStatement(UIElement stockUIElement, int animScriptItemIndex);
+
+	/** Load a static location and set it as current */
+	Resources::Location *loadLocation(const char *locationName);
+
+	/** Is a static location currently loaded? */
+	bool isStaticLocation() const;
+
+	/** Obtain the currently loaded static location, if any */
+	Resources::Location *getLocation() const;
+
+	/** Look up a sound resource in the current static location by its index */
+	Resources::Sound *getLocationSound(uint16 index) const;
+
+	/** Unload the current static location */
+	void unloadLocation(Resources::Location *location);
+
+private:
+	ArchiveLoader *_archiveLoader;
+
+	Resources::Level *_level;
+	Resources::Location *_location;
+	Common::Array<Resources::Anim *> _stockAnims;
+	Common::Array<Resources::Image *> _stockImages;
+
+	Common::Path buildLocationArchiveName(const char *locationName) const;
+};
+
+} // End of namespace Stark
+
+#endif // STARK_SERVICES_STATIC_PROVIDER_H