Initial commit

engines/ultima/shared/gfx/visual_item.h

@@ -0,0 +1,128 @@
+/* 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 ULTIMA_SHARED_GFX_VISUAL_ITEM_H
+#define ULTIMA_SHARED_GFX_VISUAL_ITEM_H
+
+#include "graphics/managed_surface.h"
+#include "ultima/shared/core/named_item.h"
+#include "ultima/shared/gfx/screen.h"
+#include "ultima/shared/gfx/visual_surface.h"
+
+namespace Ultima {
+namespace Shared {
+namespace Gfx {
+
+class Popup;
+
+/**
+ * Acts as the base class for all classes that have a visual representation on the screen
+ */
+class VisualItem : public NamedItem {
+	friend class VisualSurface;
+	DECLARE_MESSAGE_MAP;
+	bool ShowMsg(CShowMsg *msg);
+	bool HideMsg(CHideMsg *msg);
+private:
+	/**
+	 * Common initialization method used by the constructors
+	 */
+	void init(TreeItem *parent = nullptr);
+protected:
+	Rect _bounds;
+	bool _isDirty;
+public:
+	CLASSDEF;
+	VisualItem(TreeItem *parent = nullptr) { init(parent); }
+	VisualItem(const Rect &r, TreeItem *parent = nullptr) : _bounds(r) { init(parent); }
+	VisualItem(const Common::String &name, TreeItem *parent = nullptr) : NamedItem(name) { init(parent); }
+	VisualItem(const Common::String &name, const Rect &r, TreeItem *parent = nullptr) : NamedItem(name),
+		_bounds(r) { init(parent); }
+
+	~VisualItem() override {
+	}
+
+	/**
+	 * Draws the visual item on the screen
+	 */
+	virtual void draw() {
+		_isDirty = false;
+	}
+
+	/**
+	 * Gets a managed surface representing the portion of the screen defined by _bounds.
+	 * This allows drawing to be done without worrying about offsets or clipping
+	 */
+	VisualSurface getSurface();
+
+	/**
+	 * Gets the bounds for the item
+	 */
+	const Rect &getBounds() { return _bounds; }
+
+	/**
+	 * Sets the bounds for the item
+	 * @remarks Does not erase the item if it's already been drawn
+	 */
+	void setBounds(const Rect &r);
+
+	/**
+	 * Set the position for the item
+	 * @remarks Does not erase the item if it's already been drawn
+	 */
+	void setPosition(const Point &pt);
+
+	/**
+	 * Flags the item as being changed, requiring a redraw
+	 */
+	virtual void setDirty(bool dirty = true);
+
+	/**
+	 * Clears the dirty flag
+	 */
+	void clearDirty() { setDirty(false); }
+
+	/**
+	 * Returns true if the item is dirty, requiring a redraw
+	 */
+	virtual bool isDirty() const { return _isDirty; }
+
+	/**
+	 * Helper function to switch to a different visual item
+	 */
+	void setView(const Common::String &viewName);
+
+	/**
+	 * Helper function to switch to an on-screen popup
+	 */
+	void setPopup(Gfx::Popup *popup);
+
+	/**
+	 * Helper function to switch the item to be the current view
+	 */
+	void setView();
+};
+
+} // End of namespace Gfx
+} // End of namespace Shared
+} // End of namespace Ultima
+
+#endif