Disambiguate GuiOpenCommsButton states in UI (#2677)

* Manage, display comms state in GuiOpenCommsButton

- Change the button text to indicate why the button is disabled.
  This reduces ambiguity about why the "Open comms" button is
  disabled while on Strategic Map when comms are engaged outside of
  its view.
- Hide the "Open comms" button entirely if the ship lacks a
  CommsTransmitter.

* Use layout container for Relay functions on Ops

To accommodate hiding the comms button on Ops when a ship lacks a
CommsTransmitter component, use a layout container for waypoint and
comms buttons.

Author: oznogon

src/screenComponents/openCommsButton.cpp

@@ -1,27 +1,39 @@
 #include "openCommsButton.h"
-
+#include <i18n.h>
 #include "targetsContainer.h"
 #include "playerInfo.h"
 #include "components/comms.h"
 
 
-GuiOpenCommsButton::GuiOpenCommsButton(GuiContainer* owner, string id, string name, TargetsContainer* targets)
+GuiOpenCommsButton::GuiOpenCommsButton(GuiContainer* owner, string id, string name, TargetsContainer* targets, bool allow_comms)
 : GuiButton(owner, id, name, [this]() {
     if (my_spaceship && this->targets->get())
         my_player_info->commandOpenTextComm(this->targets->get());
-}), targets(targets)
+}), targets(targets), allow_comms(allow_comms)
 {
 }
 
 void GuiOpenCommsButton::onDraw(sp::RenderTarget& renderer)
 {
     disable();
+    // Indicate the comms state on the comms button, or hide the button if this
+    // ship lacks a comms transmitter.
     auto transmitter = my_spaceship.getComponent<CommsTransmitter>();
-    if (transmitter && transmitter->state == CommsTransmitter::State::Inactive)
+    setVisible(transmitter);
+    if (transmitter && isVisible())
     {
-        auto target = targets->get();
-        if (target.hasComponent<CommsReceiver>() || target.hasComponent<CommsTransmitter>())
-            enable();
+        if (transmitter->state == CommsTransmitter::State::Inactive)
+        {
+            auto target = targets->get();
+            if (target.hasComponent<CommsReceiver>() || target.hasComponent<CommsTransmitter>())
+            {
+                enable();
+                setText(allow_comms ? tr("Open comms") : tr("Link to comms"));
+            }
+            else setText(tr("No comms target"));
+        }
+        else setText(tr("Transmitting..."));
     }
+
     GuiButton::onDraw(renderer);
 }

src/screenComponents/openCommsButton.h

@@ -1,5 +1,4 @@
-#ifndef OPEN_COMMS_BUTTON_H
-#define OPEN_COMMS_BUTTON_H
+#pragma once
 
 #include "gui/gui2_button.h"
 
@@ -8,10 +7,10 @@ class TargetsContainer;
 class GuiOpenCommsButton : public GuiButton
 {
     TargetsContainer* targets;
+private:
+    bool allow_comms = true;
 public:
-    GuiOpenCommsButton(GuiContainer* owner, string id, string name, TargetsContainer* targets);
+    GuiOpenCommsButton(GuiContainer* owner, string id, string name, TargetsContainer* targets, bool allow_comms = true);
 
     virtual void onDraw(sp::RenderTarget& target) override;
 };
-
-#endif//OPEN_COMMS_BUTTON_H

src/screens/crew4/operationsScreen.cpp

@@ -72,21 +72,29 @@ OperationScreen::OperationScreen(GuiContainer* owner)
     );
     science->science_radar->setAutoRotating(PreferencesManager::get("operations_radar_lock","0")=="1");
 
-    (new GuiOpenCommsButton(science->radar_view, "OPEN_COMMS_BUTTON", tr("Open Comms"), &science->targets))->setPosition(-270, -20, sp::Alignment::BottomRight)->setSize(200, 50);
+    // Limited relay functions: comms and waypoints.
+    GuiElement* relay_functions = new GuiElement(science->radar_view, "RELAY_FUNCTIONS");
+    relay_functions
+        ->setPosition(-270.0f, -20.0f, sp::Alignment::BottomRight)
+        ->setSize(200.0f, 150.0f)
+        ->setAttribute("layout", "verticalbottom");
+
+    // Manage comms.
+    (new GuiOpenCommsButton(relay_functions, "OPEN_COMMS_BUTTON", tr("Open comms"), &science->targets))
+        ->setSize(200.0f, 50.0f);
 
     // Manage waypoints.
-    place_waypoint_button = new GuiButton(science->radar_view, "WAYPOINT_PLACE_BUTTON", tr("Place Waypoint"), [this]() {
-        mode = WaypointPlacement;
-    });
-    place_waypoint_button->setPosition(-270, -70, sp::Alignment::BottomRight)->setSize(200, 50);
+    place_waypoint_button = new GuiButton(relay_functions, "WAYPOINT_PLACE_BUTTON", tr("Place waypoint"), [this]() { mode = WaypointPlacement; });
+    place_waypoint_button->setSize(200.0f, 50.0f);
 
-    delete_waypoint_button = new GuiButton(science->radar_view, "WAYPOINT_DELETE_BUTTON", tr("Delete Waypoint"), [this]() {
-        if (my_spaceship && science->targets.getWaypointIndex() >= 0)
+    delete_waypoint_button = new GuiButton(relay_functions, "WAYPOINT_DELETE_BUTTON", tr("Delete waypoint"),
+        [this]()
         {
-            my_player_info->commandRemoveWaypoint(science->targets.getWaypointIndex());
+            if (my_spaceship && science->targets.getWaypointIndex() >= 0)
+                my_player_info->commandRemoveWaypoint(science->targets.getWaypointIndex());
         }
-    });
-    delete_waypoint_button->setPosition(-270, -120, sp::Alignment::BottomRight)->setSize(200, 50);
+    );
+    delete_waypoint_button->setSize(200.0f, 50.0f);
 
     auto stats = new GuiElement(this, "OPERATIONS_STATS");
     stats->setPosition(20, 60, sp::Alignment::TopLeft)->setSize(240, 80)->setAttribute("layout", "vertical");

src/screens/crew6/relayScreen.cpp

@@ -36,7 +36,7 @@ static bool canHack(sp::ecs::Entity entity)
 }
 
 RelayScreen::RelayScreen(GuiContainer* owner, bool allow_comms)
-: GuiOverlay(owner, "RELAY_SCREEN", colorConfig.background), mode(TargetSelection)
+: GuiOverlay(owner, "RELAY_SCREEN", colorConfig.background)
 {
     targets.setAllowWaypointSelection();
     radar = new GuiRadarView(this, "RELAY_RADAR", 50000.0f, &targets);
@@ -114,11 +114,7 @@ RelayScreen::RelayScreen(GuiContainer* owner, bool allow_comms)
     option_buttons->setPosition(20, 50, sp::Alignment::TopLeft)->setSize(250, GuiElement::GuiSizeMax)->setAttribute("layout", "vertical");
 
     // Open comms button.
-    if (allow_comms == true)
-        (new GuiOpenCommsButton(option_buttons, "OPEN_COMMS_BUTTON", tr("Open Comms"), &targets))->setSize(GuiElement::GuiSizeMax, 50);
-    else
-        (new GuiOpenCommsButton(option_buttons, "OPEN_COMMS_BUTTON", tr("Link to Comms"), &targets))->setSize(GuiElement::GuiSizeMax, 50);
-
+    (new GuiOpenCommsButton(option_buttons, "OPEN_COMMS_BUTTON", tr("Open comms"), &targets, allow_comms))->setSize(GuiElement::GuiSizeMax, 50);
 
     // Hack target
     hack_target_button = new GuiButton(option_buttons, "HACK_TARGET", tr("Start hacking"), [this](){

src/screens/crew6/relayScreen.h

@@ -1,5 +1,4 @@
-#ifndef RELAY_SCREEN_H
-#define RELAY_SCREEN_H
+#pragma once
 
 #include "screenComponents/targetsContainer.h"
 #include "gui/gui2_overlay.h"
@@ -21,9 +20,8 @@ class RelayScreen : public GuiOverlay
         WaypointPlacement,
         LaunchProbe,
         MoveWaypoint
-    };
+    } mode = TargetSelection;
 
-    EMode mode;
     TargetsContainer targets;
     int drag_waypoint_index;
     GuiRadarView* radar;
@@ -51,5 +49,3 @@ class RelayScreen : public GuiOverlay
 
     virtual void onDraw(sp::RenderTarget& target) override;
 };
-
-#endif//RELAY_SCREEN_H