From 44d593957294f9a0376f0d1bd6d056eb1ce05aac Mon Sep 17 00:00:00 2001
From: Dave Corley <smokydave@icloud.com>
Date: Fri, 30 Aug 2024 22:30:58 -0700
Subject: [PATCH] FEAT(InstanceMode): Add a tooltip for InstanceMode in the
 same style as that of PathgridMode

---
 apps/opencs/view/render/instancemode.cpp | 19 ++++++++++++++++++-
 apps/opencs/view/render/instancemode.hpp |  2 ++
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/apps/opencs/view/render/instancemode.cpp b/apps/opencs/view/render/instancemode.cpp
index ae73e6780c..615ca42aa1 100644
--- a/apps/opencs/view/render/instancemode.cpp
+++ b/apps/opencs/view/render/instancemode.cpp
@@ -297,7 +297,7 @@ void CSVRender::InstanceMode::setDragAxis(const char axis)
 CSVRender::InstanceMode::InstanceMode(
     WorldspaceWidget* worldspaceWidget, osg::ref_ptr<osg::Group> parentNode, QWidget* parent)
     : EditMode(worldspaceWidget, Misc::ScalableIcon::load(":scenetoolbar/editing-instance"),
-        Mask_Reference | Mask_Terrain, "Instance editing", parent)
+        Mask_Reference | Mask_Terrain, getTooltip(), parent)
     , mSubMode(nullptr)
     , mSubModeId("move")
     , mSelectionMode(nullptr)
@@ -345,6 +345,23 @@ CSVRender::InstanceMode::InstanceMode(
             qOverload<>(&CSMPrefs::Shortcut::activated), this, [this, axis] { this->setDragAxis(axis); });
 }
 
+QString CSVRender::InstanceMode::getTooltip()
+{
+    return QString(
+        "Instance editing"
+        "<ul><li>Use {scene-select-primary} and {scene-select-secondary} to select and unselect instances</li>"
+        "<li>Use {scene-edit-primary} to manipulate instances</li>"
+        "<li>Use {scene-select-tertiary} to select a reference object and then {scene-edit-secondary} to snap "
+        "selection relative to the reference object</li>"
+        "<li>Use {scene-submode-move}, {scene-submode-rotate}, {scene-submode-scale} to change to move, rotate, and "
+        "scale modes respectively</li>"
+        "<li>Use {scene-axis-x}, {scene-axis-y}, and {scene-axis-z} to lock changes to X, Y, and Z axes "
+        "respectively</li>"
+        "<li>Use {scene-delete} to delete currently selected objects</li>"
+        "<li>Use {scene-duplicate} to duplicate instances</li>"
+        "<li>Use {scene-instance-drop} to drop instances</li></ul>");
+}
+
 void CSVRender::InstanceMode::activate(CSVWidget::SceneToolbar* toolbar)
 {
     if (!mSubMode)
diff --git a/apps/opencs/view/render/instancemode.hpp b/apps/opencs/view/render/instancemode.hpp
index 193423efd5..ae7be10322 100644
--- a/apps/opencs/view/render/instancemode.hpp
+++ b/apps/opencs/view/render/instancemode.hpp
@@ -74,6 +74,8 @@ namespace CSVRender
         InstanceMode(
             WorldspaceWidget* worldspaceWidget, osg::ref_ptr<osg::Group> parentNode, QWidget* parent = nullptr);
 
+        QString getTooltip();
+
         void activate(CSVWidget::SceneToolbar* toolbar) override;
 
         void deactivate(CSVWidget::SceneToolbar* toolbar) override;