Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up and refactor IngameWindow button handling #1608

Merged
merged 2 commits into from
Jul 20, 2023
Merged

Clean up and refactor IngameWindow button handling #1608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a17e45
Remove unused data members from IngameWindow
falbrechtskirchinger Jul 18, 2023
f6fb9c2
Refactor IngameWindow button handling
falbrechtskirchinger Jul 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 45 additions & 44 deletions libs/s25main/ingameWindows/IngameWindow.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#include "Settings.h"
#include "driver/MouseCoords.h"
#include "drivers/VideoDriverWrapper.h"
#include "helpers/EnumRange.h"
#include "helpers/MultiArray.h"
#include "helpers/containerUtils.h"
#include "ogl/FontStyle.h"
Expand All @@ -19,6 +20,10 @@
#include <algorithm>
#include <utility>

namespace {
constexpr Extent ButtonSize(16, 16);
}

const DrawPoint IngameWindow::posLastOrCenter(std::numeric_limits<DrawPoint::ElementType>::max(),
std::numeric_limits<DrawPoint::ElementType>::max());
const DrawPoint IngameWindow::posCenter(std::numeric_limits<DrawPoint::ElementType>::max() - 1,
Expand All @@ -30,10 +35,9 @@ const Extent IngameWindow::borderSize(1, 1);
IngameWindow::IngameWindow(unsigned id, const DrawPoint& pos, const Extent& size, std::string title,
glArchivItem_Bitmap* background, bool modal, CloseBehavior closeBehavior, Window* parent)
: Window(parent, id, pos, size), title_(std::move(title)), background(background), lastMousePos(0, 0),
last_down(false), last_down2(false), isModal_(modal), closeme(false), isMinimized_(false), isMoving(false),
closeBehavior_(closeBehavior)
isModal_(modal), closeme(false), isMinimized_(false), isMoving(false), closeBehavior_(closeBehavior)
{
std::fill(buttonState.begin(), buttonState.end(), ButtonState::Up);
std::fill(buttonStates_.begin(), buttonStates_.end(), ButtonState::Up);
contentOffset.x = LOADER.GetImageN("resource", 38)->getWidth(); // left border
contentOffset.y = LOADER.GetImageN("resource", 42)->getHeight(); // title bar
contentOffsetEnd.x = LOADER.GetImageN("resource", 39)->getWidth(); // right border
Expand Down Expand Up @@ -147,13 +151,11 @@ void IngameWindow::MouseLeftDown(const MouseCoords& mc)
lastMousePos = mc.GetPos();
} else
{
// Check the 2 buttons
const std::array<Rect, 2> rec = {GetCloseButtonBounds(), GetMinimizeButtonBounds()};

for(unsigned i = 0; i < 2; ++i)
// Check the buttons
for(const auto btn : helpers::enumRange<IwButton>())
{
if(IsPointInRect(mc.GetPos(), rec[i]))
buttonState[i] = ButtonState::Pressed;
if(IsPointInRect(mc.GetPos(), GetButtonBounds(btn)))
buttonStates_[btn] = ButtonState::Pressed;
}
}
}
Expand All @@ -162,26 +164,23 @@ void IngameWindow::MouseLeftUp(const MouseCoords& mc)
{
isMoving = false;

const std::array<Rect, 2> rec = {GetCloseButtonBounds(), GetMinimizeButtonBounds()};

for(unsigned i = 0; i < 2; ++i)
for(const auto btn : helpers::enumRange<IwButton>())
{
buttonState[i] = ButtonState::Up;
buttonStates_[btn] = ButtonState::Up;

if((i == 0 && closeBehavior_ == CloseBehavior::Custom) // no close button
|| (i == 1 && isModal_)) // modal windows cannot be minimized
{
if((btn == IwButton::Close && closeBehavior_ == CloseBehavior::Custom) // no close button
|| (btn == IwButton::Minimize && isModal_)) // modal windows cannot be minimized
continue;
}

if(IsPointInRect(mc.GetPos(), rec[i]))
if(IsPointInRect(mc.GetPos(), GetButtonBounds(btn)))
{
if(i == 0)
Close();
else
switch(btn)
{
SetMinimized(!IsMinimized());
LOADER.GetSoundN("sound", 113)->Play(255, false);
case IwButton::Close: Close(); break;
case IwButton::Minimize:
SetMinimized(!IsMinimized());
LOADER.GetSoundN("sound", 113)->Play(255, false);
break;
}
}
}
Expand All @@ -204,15 +203,13 @@ void IngameWindow::MouseMove(const MouseCoords& mc)
lastMousePos = mc.GetPos();
} else
{
// Check the 2 buttons
const std::array<Rect, 2> rec = {GetCloseButtonBounds(), GetMinimizeButtonBounds()};

for(unsigned i = 0; i < 2; ++i)
// Check the buttons
for(const auto btn : helpers::enumRange<IwButton>())
{
if(IsPointInRect(mc.GetPos(), rec[i]))
buttonState[i] = mc.ldown ? ButtonState::Pressed : ButtonState::Hover;
if(IsPointInRect(mc.GetPos(), GetButtonBounds(btn)))
buttonStates_[btn] = mc.ldown ? ButtonState::Pressed : ButtonState::Hover;
else
buttonState[i] = ButtonState::Up;
buttonStates_[btn] = ButtonState::Up;
}
}
}
Expand Down Expand Up @@ -251,12 +248,15 @@ void IngameWindow::Draw_()
glArchivItem_Bitmap* rightUpperImg = LOADER.GetImageN("resource", 37);
rightUpperImg->DrawFull(GetPos() + DrawPoint(GetSize().x - rightUpperImg->getWidth(), 0));

// The 2 buttons
constexpr std::array<helpers::EnumArray<uint16_t, ButtonState>, 2> ids = {{{47, 55, 50}, {48, 56, 52}}};
// The buttons
using ButtonStateResIds = helpers::EnumArray<unsigned, ButtonState>;
constexpr ButtonStateResIds closeResIds = {47, 55, 51};
constexpr ButtonStateResIds minimizeResIds = {48, 56, 52};
if(closeBehavior_ != CloseBehavior::Custom)
LOADER.GetImageN("resource", ids[0][buttonState[0]])->DrawFull(GetPos());
LOADER.GetImageN("resource", closeResIds[buttonStates_[IwButton::Close]])->DrawFull(GetPos());
falbrechtskirchinger marked this conversation as resolved.
Show resolved Hide resolved
if(!IsModal())
LOADER.GetImageN("resource", ids[1][buttonState[1]])->DrawFull(GetPos() + DrawPoint(GetSize().x - 16, 0));
LOADER.GetImageN("resource", minimizeResIds[buttonStates_[IwButton::Minimize]])
->DrawFull(GetButtonBounds(IwButton::Minimize));

// The title bar
unsigned titleIndex;
Expand Down Expand Up @@ -359,16 +359,6 @@ bool IngameWindow::IsMessageRelayAllowed() const
return !isMinimized_;
}

Rect IngameWindow::GetCloseButtonBounds() const
{
return Rect(GetPos(), 16, 16);
}

Rect IngameWindow::GetMinimizeButtonBounds() const
{
return Rect(GetPos().x + GetSize().x - 16, GetPos().y, 16, 16);
}

void IngameWindow::SaveOpenStatus(bool isOpen) const
{
auto windowSettings = SETTINGS.windows.persistentSettings.find(GetGUIID());
Expand All @@ -377,3 +367,14 @@ void IngameWindow::SaveOpenStatus(bool isOpen) const
windowSettings->second.isOpen = isOpen;
}
}

Rect IngameWindow::GetButtonBounds(IwButton btn) const
{
auto pos = GetPos();
switch(btn)
{
case IwButton::Close: break;
case IwButton::Minimize: pos.x += GetSize().x - ButtonSize.x; break;
}
return Rect(pos, ButtonSize);
}
23 changes: 15 additions & 8 deletions libs/s25main/ingameWindows/IngameWindow.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#pragma once

#include "Window.h"
#include "helpers/EnumArray.h"
#include "gameData/const_gui_ids.h"
#include <array>
#include <vector>
Expand All @@ -24,6 +25,16 @@ enum CloseBehavior
NoRightClick,
};

enum class IwButton
{
Close,
Minimize
};
constexpr auto maxEnumValue(IwButton)
{
return IwButton::Minimize;
}

class IngameWindow : public Window
{
public:
Expand Down Expand Up @@ -99,24 +110,20 @@ class IngameWindow : public Window
std::string title_;
glArchivItem_Bitmap* background;
DrawPoint lastMousePos;
bool last_down;
bool last_down2;
std::array<ButtonState, 2> buttonState;

/// Offset from left and top to actual content
Extent contentOffset;
/// Offset from content to right and bottom boundary
Extent contentOffsetEnd;

/// Get bounds of close button (left)
Rect GetCloseButtonBounds() const;
/// Get bounds of minimize button (right)
Rect GetMinimizeButtonBounds() const;

private:
/// Get bounds of given button
Rect GetButtonBounds(IwButton btn) const;

bool isModal_;
bool closeme;
bool isMinimized_;
bool isMoving;
CloseBehavior closeBehavior_;
helpers::EnumArray<ButtonState, IwButton> buttonStates_;
};