Added hover tooltips for tile tool, object tool and editor panel

src/Client/Editor/Editor.cpp

@@ -68,6 +68,11 @@ Tool * Editor::getTool() const
 	return tool;
 }
 
+sf::Vector2i Editor::getMousePositionTile() const
+{
+	return lastMousePosition;
+}
+
 void Editor::resetCamera()
 {
 	float tileSize = TileAppearanceManager::TILE_SIZE;

src/Client/Editor/Editor.hpp

@@ -49,6 +49,8 @@ class Editor : public gui2::Widget
 	void setTool(Tool * tool);
 	Tool * getTool() const;
 
+	sf::Vector2i getMousePositionTile() const;
+
 	void resetCamera();
 
 	bool isVertexRenderable() const override;

src/Client/Editor/SelectionPanel.cpp

@@ -27,18 +27,20 @@ gui2::Ptr<SelectionPanel> SelectionPanel::make()
 }
 
 SelectionPanel::SelectionPanel() :
-		mapper([](ID id)
-		{
-			static ItemEntry invalidEntry;
-			return invalidEntry;
-		}),
-		texture(nullptr),
-		wasSelectionChanged(false),
-		selectionExists(false),
-		selection(0),
-		itemCount(0),
-		itemSize(24.f, 24.f),
-		scrollVelocity(0)
+	mapper([](ID id)
+	{
+		static ItemEntry invalidEntry;
+		return invalidEntry;
+	}),
+	texture(nullptr),
+	wasSelectionChanged(false),
+	selectionExists(false),
+	selection(0),
+	hoveredItemExists(false),
+	hoveredItem(0),
+	itemCount(0),
+	itemSize(24.f, 24.f),
+	scrollVelocity(0)
 {
 }
 
@@ -71,6 +73,16 @@ bool SelectionPanel::hasSelection() const
 	return selectionExists;
 }
 
+SelectionPanel::ID SelectionPanel::getHoveredItem() const
+{
+	return hoveredItem;
+}
+
+bool SelectionPanel::hasHoveredItem() const
+{
+	return hoveredItemExists;
+}
+
 void SelectionPanel::setMapper(Mapper mapper, std::size_t itemCount)
 {
 	this->mapper = mapper;
@@ -130,6 +142,16 @@ void SelectionPanel::update()
 	}
 }
 
+bool SelectionPanel::wasChanged()
+{
+	if (wasSelectionChanged)
+	{
+		wasSelectionChanged = false;
+		return true;
+	}
+	return false;
+}
+
 bool SelectionPanel::isVertexRenderable() const
 {
 	return false;
@@ -143,7 +165,7 @@ void SelectionPanel::onProcess(const gui2::WidgetEvents& events)
 		{
 			scrollVelocity -= events.mouseWheelDelta * 5;
 		}
-		
+
 		if (std::abs(scrollVelocity) > 0.0001f)
 		{
 			float newSliderValue = slider->getValue() + scrollVelocity;
@@ -161,14 +183,26 @@ void SelectionPanel::onProcess(const gui2::WidgetEvents& events)
 			scrollVelocity *= 0.75f;
 		}
 	}
+
+	if (isMouseOver())
+	{
+		std::pair<bool, ID> itemAtMousePos = getItemAtPosition(events.mousePosition);
+
+		hoveredItemExists = itemAtMousePos.first;
+		hoveredItem = itemAtMousePos.second;
+	}
+	else
+	{
+		hoveredItemExists = false;
+	}
 }
 
 void SelectionPanel::onDraw(sf::RenderTarget& target, sf::RenderStates states) const
 {
 	states.transform *= getTransform();
-	
+
 	sf::Transform origTransform = states.transform;
-	
+
 	states.transform.translate(0, -slider->getValue());
 	states.texture = this->texture;
 
@@ -222,17 +256,12 @@ void SelectionPanel::onMouseDown(sf::Vector2f pos, Input button)
 {
 	if (button == sf::Mouse::Left)
 	{
-		for (ID i = 0; i < getItemCount(); ++i)
+		auto itemAtPos = getItemAtPosition(pos);
+
+		if (itemAtPos.first && (!hasSelection() || getSelection() != itemAtPos.second))
 		{
-			if (getShiftedItemRect(i).contains(pos))
-			{
-				if (!hasSelection() || getSelection() != i)
-				{
-					setSelection(i);
-					wasSelectionChanged = true;
-				}
-				break;
-			}
+			setSelection(itemAtPos.second);
+			wasSelectionChanged = true;
 		}
 	}
 }
@@ -253,12 +282,25 @@ sf::FloatRect SelectionPanel::getShiftedItemRect(ID item) const
 	return moveRect(getItemRect(item), sf::Vector2f(0, -slider->getValue()));
 }
 
-bool SelectionPanel::wasChanged()
+sf::FloatRect SelectionPanel::getClickableItemRect(ID item) const
 {
-	if (wasSelectionChanged)
+	return expandRect(getShiftedItemRect(item), sf::Vector2f(MARGIN / 2, MARGIN / 2));
+}
+
+std::pair<bool, SelectionPanel::ID> SelectionPanel::getItemAtPosition(sf::Vector2f pos) const
+{
+	// Optimization.
+	if (hasHoveredItem() && getClickableItemRect(getHoveredItem()).contains(pos))
 	{
-		wasSelectionChanged = false;
-		return true;
+		return std::make_pair(true, getHoveredItem());
 	}
-	return false;
+
+	for (ID i = 0; i < getItemCount(); ++i)
+	{
+		if (getClickableItemRect(i).contains(pos))
+		{
+			return std::make_pair(true, i);
+		}
+	}
+	return std::make_pair(false, 0);
 }

src/Client/Editor/SelectionPanel.hpp

@@ -11,6 +11,7 @@
 #include <cstddef>
 #include <functional>
 #include <string>
+#include <utility>
 #include <vector>
 
 namespace sf
@@ -51,6 +52,9 @@ class SelectionPanel : public gui2::Widget
 	ID getSelection() const;
 	bool hasSelection() const;
 
+	ID getHoveredItem() const;
+	bool hasHoveredItem() const;
+
 	void setMapper(Mapper mapper, std::size_t itemCount);
 	const Mapper & getMapper() const;
 	std::size_t getItemCount() const;
@@ -62,43 +66,47 @@ class SelectionPanel : public gui2::Widget
 	const sf::Texture * getTexture() const;
 
 	void update();
-	
+
 	bool wasChanged();
 
 	SelectionPanel();
 
 	bool isVertexRenderable() const override;
-	
+
 protected:
-	
+
 	virtual void init() override;
 
 private:
 
 	void onProcess(const gui2::WidgetEvents & events) override;
 	void onDraw(sf::RenderTarget & target, sf::RenderStates states) const;
 	void onResize() override;
-	
+
 	void onMouseDown(sf::Vector2f pos, Input button) override;
 
 	std::size_t getRowCount() const;
 	std::size_t getColumnCount() const;
 
 	sf::FloatRect getItemRect(ID item) const;
 	sf::FloatRect getShiftedItemRect(ID item) const;
+	sf::FloatRect getClickableItemRect(ID item) const;
+	std::pair<bool, ID> getItemAtPosition(sf::Vector2f pos) const;
 
 	Mapper mapper;
 
 	const sf::Texture * texture;
 
 	bool wasSelectionChanged;
 	bool selectionExists;
-	std::size_t selection;
+	ID selection;
+	bool hoveredItemExists;
+	ID hoveredItem;
 	std::size_t itemCount;
 	sf::Vector2f itemSize;
 
 	std::vector<sf::Vertex> vertices;
-	
+
 	gui2::Ptr<gui2::Slider> slider;
 	float scrollVelocity;
 };

src/Client/Editor/Tool.cpp

@@ -46,6 +46,11 @@ void Tool::onDrawPreview(sf::RenderTarget& target, sf::RenderStates states, sf::
 {
 }
 
+std::string Tool::getTooltip() const
+{
+	return "";
+}
+
 gui2::Ptr<gui2::Widget> Tool::getSettingsPanel() const
 {
 	return nullptr;

src/Client/Editor/Tool.hpp

@@ -6,6 +6,7 @@
 #include <SFML/Graphics/RenderStates.hpp>
 #include <SFML/System/Vector2.hpp>
 #include <Shared/Utils/NamedFactory.hpp>
+#include <string>
 
 class Level;
 class ObjectAppearanceManager;
@@ -89,6 +90,11 @@ class Tool : public NamedFactory<Tool>
 	 */
 	virtual void onDrawPreview(sf::RenderTarget & target, sf::RenderStates states, sf::Vector2i cursorPosition);
 
+	/**
+	 * Called every frame to determine the current tooltip/status string to be displayed in the editor.
+	 */
+	virtual std::string getTooltip() const;
+
 	/**
 	 * Returns the settings panel associated with this tool. This has to be a consistent and unique instance; the return
 	 * value must not change between calls.
@@ -104,7 +110,7 @@ class Tool : public NamedFactory<Tool>
 	 * Returns the editor information given to this tool.
 	 */
 	const EditorData & getEditorData() const;
-	
+
 	/**
 	 * Initializes the Named Factory of tools, if it is not initialized yet.
 	 */

src/Client/Editor/Tools/ObjectTool.cpp

@@ -73,6 +73,11 @@ gui2::Ptr<gui2::Widget> ObjectTool::getSettingsPanel() const
 	return settingsPanel;
 }
 
+std::string ObjectTool::getTooltip() const
+{
+	return settingsPanel->getTooltip();
+}
+
 const Brush& ObjectTool::getPrimaryBrush() const
 {
 	primaryBrush.setObject(settingsPanel->getSelectedObject());

src/Client/Editor/Tools/ObjectTool.hpp

@@ -18,6 +18,11 @@ class ObjectTool : public BrushTool
 
 	virtual gui2::Ptr<gui2::Widget> getSettingsPanel() const override;
 
+	/**
+	 * Returns the tooltip for this object tool.
+	 */
+	virtual std::string getTooltip() const override;
+
 protected:
 
 	virtual const Brush & getPrimaryBrush() const override;

src/Client/Editor/Tools/Panels/ObjectToolPanel.cpp

@@ -51,6 +51,11 @@ Brush::ObjectMode ObjectToolPanel::getSecondaryMode() const
 	return static_cast<Brush::ObjectMode>(secondaryModeMenu->getSelection());
 }
 
+std::string ObjectToolPanel::getTooltip() const
+{
+	return hoveredObject.getType() != Object::Type::None ? objectAppearance->getObjectName(hoveredObject) : "";
+}
+
 void ObjectToolPanel::init()
 {
 	gui2::Container::init();
@@ -116,6 +121,15 @@ void ObjectToolPanel::onProcessContainer(gui2::WidgetEvents& events)
 			propertyPanel->update();
 		}
 	}
+
+	if (selectionPanel->hasHoveredItem())
+	{
+		hoveredObject = Object(objects[selectionPanel->getHoveredItem()]);
+	}
+	else
+	{
+		hoveredObject.setType(Object::Type::None);
+	}
 }
 
 void ObjectToolPanel::addDefaultPropertiesToObject()

src/Client/Editor/Tools/Panels/ObjectToolPanel.hpp

@@ -18,7 +18,7 @@ class ObjectToolPanel : public gui2::Container
 public:
 
 	static gui2::Ptr<ObjectToolPanel> make(std::vector<Object> objects,
-			const ObjectAppearanceManager & objectAppearance);
+		const ObjectAppearanceManager & objectAppearance);
 
 	ObjectToolPanel(std::vector<Object> objects, const ObjectAppearanceManager & objectAppearance);
 	virtual ~ObjectToolPanel();
@@ -38,8 +38,13 @@ class ObjectToolPanel : public gui2::Container
 	 */
 	Brush::ObjectMode getSecondaryMode() const;
 
+	/**
+	 * Returns the name of the currently hovered tile.
+	 */
+	std::string getTooltip() const;
+
 protected:
-	
+
 	virtual void init() override;
 
 private:
@@ -52,6 +57,7 @@ class ObjectToolPanel : public gui2::Container
 
 	std::vector<Object> objects;
 	Object selectedObject;
+	Object hoveredObject;
 
 	gui2::Ptr<gui2::Dropdown> primaryModeMenu;
 	gui2::Ptr<gui2::Dropdown> secondaryModeMenu;