OpenTTD Source  20241108-master-g80f628063a
slider.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD 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, version 2.
4  * OpenTTD 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.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "stdafx.h"
11 #include "gfx_func.h"
12 #include "palette_func.h"
13 #include "slider_func.h"
14 #include "strings_func.h"
15 #include "window_gui.h"
16 #include "zoom_func.h"
17 
18 #include "safeguards.h"
19 
20 static const int SLIDER_WIDTH = 3;
21 
31 void DrawSliderWidget(Rect r, int min_value, int max_value, int nmarks, int value, SliderMarkFunc *mark_func)
32 {
33  /* Allow space for labels. We assume they are in the small font. */
34  if (mark_func != nullptr) r.bottom -= GetCharacterHeight(FS_SMALL) + WidgetDimensions::scaled.hsep_normal;
35 
36  max_value -= min_value;
37 
38  /* Draw a wedge indicating low to high value. */
39  const int ha = (r.bottom - r.top) / 5;
40  const int sw = ScaleGUITrad(SLIDER_WIDTH);
41  const int t = WidgetDimensions::scaled.bevel.top; /* Thickness of lines */
42  int wx1 = r.left + sw / 2;
43  int wx2 = r.right - sw / 2;
44  if (_current_text_dir == TD_RTL) std::swap(wx1, wx2);
45  const uint shadow = GetColourGradient(COLOUR_GREY, SHADE_DARK);
46  const uint fill = GetColourGradient(COLOUR_GREY, SHADE_LIGHTER);
47  const uint light = GetColourGradient(COLOUR_GREY, SHADE_LIGHTEST);
48  const std::vector<Point> wedge{ Point{wx1, r.bottom - ha}, Point{wx2, r.top + ha}, Point{wx2, r.bottom - ha} };
49  GfxFillPolygon(wedge, fill);
50  GfxDrawLine(wedge[0].x, wedge[0].y, wedge[2].x, wedge[2].y, light, t);
51  GfxDrawLine(wedge[1].x, wedge[1].y, wedge[2].x, wedge[2].y, _current_text_dir == TD_RTL ? shadow : light, t);
52  GfxDrawLine(wedge[0].x, wedge[0].y, wedge[1].x, wedge[1].y, shadow, t);
53 
54  int x;
55  if (mark_func != nullptr) {
56  for (int mark = 0; mark < nmarks; ++mark) {
57  const int mark_value = (max_value * mark) / (nmarks - 1);
58 
59  const StringID str = mark_func(nmarks, mark, mark_value + min_value);
60  if (str == INVALID_STRING_ID) continue;
61 
62  x = mark_value;
63  if (_current_text_dir == TD_RTL) x = max_value - mark_value;
64  x = r.left + (x * (r.right - r.left - sw) / max_value) + sw / 2;
65  GfxDrawLine(x, r.bottom - ha + 1, x, r.bottom + (str == STR_NULL ? 0 : WidgetDimensions::scaled.hsep_normal), shadow, t);
66  if (str == STR_NULL) continue;
67 
69  x = Clamp(x - d.width / 2, r.left, r.right - d.width);
70  DrawString(x, x + d.width, r.bottom + 1 + WidgetDimensions::scaled.hsep_normal, str, TC_BLACK, SA_CENTER, false, FS_SMALL);
71  }
72  }
73 
74  /* Draw a slider handle indicating current value. */
75  value -= min_value;
76  if (_current_text_dir == TD_RTL) value = max_value - value;
77  x = r.left + (value * (r.right - r.left - sw) / max_value);
78  DrawFrameRect(x, r.top, x + sw, r.bottom, COLOUR_GREY, FR_NONE);
79 }
80 
91 bool ClickSliderWidget(Rect r, Point pt, int min_value, int max_value, int nmarks, int &value)
92 {
93  max_value -= min_value;
94 
95  const int sw = ScaleGUITrad(SLIDER_WIDTH);
96  int new_value = Clamp((pt.x - r.left - sw / 2) * max_value / (r.right - r.left - sw), 0, max_value);
97  if (_current_text_dir == TD_RTL) new_value = max_value - new_value;
98  new_value += min_value;
99 
100  if (nmarks > 0) {
101  const int step = max_value / (nmarks - 1);
102  new_value = ((new_value + step / 2) / step) * step;
103  }
104 
105  if (new_value != value) {
106  value = new_value;
107  return true;
108  }
109 
110  return false;
111 }
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
int hsep_normal
Normal horizontal spacing.
Definition: window_gui.h:63
RectPadding bevel
Bevel thickness, affected by "scaled bevels" game option.
Definition: window_gui.h:40
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:77
void GfxFillPolygon(const std::vector< Point > &shape, int colour, FillRectMode mode)
Fill a polygon with colour.
Definition: gfx.cpp:210
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:851
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:657
Functions related to the gfx engine.
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_type.h:353
@ FS_SMALL
Index of the small font in the font tables.
Definition: gfx_type.h:210
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:79
uint8_t GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition: palette.cpp:314
Functions related to palettes.
A number of safeguards to prevent using unsafe methods.
void DrawSliderWidget(Rect r, int min_value, int max_value, int nmarks, int value, SliderMarkFunc *mark_func)
Draw a slider widget with knob at given value.
Definition: slider.cpp:31
bool ClickSliderWidget(Rect r, Point pt, int min_value, int max_value, int nmarks, int &value)
Handle click on a slider widget to change the value.
Definition: slider.cpp:91
Definition of base types and functions in a cross-platform compatible way.
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:56
Functions related to OTTD's strings.
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
Dimensions (a width and height) of a rectangle in 2D.
Coordinates of a point in 2D.
Specification of a rectangle with absolute coordinates of all edges.
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:281
Functions, definitions and such used only by the GUI.
Functions related to zooming.
int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:117