slider.cpp 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
  1. /*************************************************************************/
  2. /* slider.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "slider.h"
  31. #include "core/os/keyboard.h"
  32. Size2 Slider::get_minimum_size() const {
  33. Ref<StyleBox> style = get_stylebox("slider");
  34. Size2i ss = style->get_minimum_size() + style->get_center_size();
  35. Ref<Texture> grabber = get_icon("grabber");
  36. Size2i rs = grabber->get_size();
  37. if (orientation == HORIZONTAL)
  38. return Size2i(ss.width, MAX(ss.height, rs.height));
  39. else
  40. return Size2i(MAX(ss.width, rs.width), ss.height);
  41. }
  42. void Slider::_gui_input(Ref<InputEvent> p_event) {
  43. if (!editable) {
  44. return;
  45. }
  46. Ref<InputEventMouseButton> mb = p_event;
  47. if (mb.is_valid()) {
  48. if (mb->get_button_index() == BUTTON_LEFT) {
  49. if (mb->is_pressed()) {
  50. Ref<Texture> grabber = get_icon(mouse_inside || has_focus() ? "grabber_highlight" : "grabber");
  51. grab.pos = orientation == VERTICAL ? mb->get_position().y : mb->get_position().x;
  52. double grab_width = (double)grabber->get_size().width;
  53. double grab_height = (double)grabber->get_size().height;
  54. double max = orientation == VERTICAL ? get_size().height - grab_height : get_size().width - grab_width;
  55. if (orientation == VERTICAL)
  56. set_as_ratio(1 - (((double)grab.pos - (grab_height / 2.0)) / max));
  57. else
  58. set_as_ratio(((double)grab.pos - (grab_width / 2.0)) / max);
  59. grab.active = true;
  60. grab.uvalue = get_as_ratio();
  61. } else {
  62. grab.active = false;
  63. }
  64. } else if (scrollable) {
  65. if (mb->is_pressed() && mb->get_button_index() == BUTTON_WHEEL_UP) {
  66. set_value(get_value() + get_step());
  67. } else if (mb->is_pressed() && mb->get_button_index() == BUTTON_WHEEL_DOWN) {
  68. set_value(get_value() - get_step());
  69. }
  70. }
  71. }
  72. Ref<InputEventMouseMotion> mm = p_event;
  73. if (mm.is_valid()) {
  74. if (grab.active) {
  75. Size2i size = get_size();
  76. Ref<Texture> grabber = get_icon("grabber");
  77. float motion = (orientation == VERTICAL ? mm->get_position().y : mm->get_position().x) - grab.pos;
  78. if (orientation == VERTICAL)
  79. motion = -motion;
  80. float areasize = orientation == VERTICAL ? size.height - grabber->get_size().height : size.width - grabber->get_size().width;
  81. if (areasize <= 0)
  82. return;
  83. float umotion = motion / float(areasize);
  84. set_as_ratio(grab.uvalue + umotion);
  85. }
  86. }
  87. if (!mm.is_valid() && !mb.is_valid()) {
  88. if (p_event->is_action_pressed("ui_left", true)) {
  89. if (orientation != HORIZONTAL)
  90. return;
  91. set_value(get_value() - (custom_step >= 0 ? custom_step : get_step()));
  92. accept_event();
  93. } else if (p_event->is_action_pressed("ui_right", true)) {
  94. if (orientation != HORIZONTAL)
  95. return;
  96. set_value(get_value() + (custom_step >= 0 ? custom_step : get_step()));
  97. accept_event();
  98. } else if (p_event->is_action_pressed("ui_up", true)) {
  99. if (orientation != VERTICAL)
  100. return;
  101. set_value(get_value() + (custom_step >= 0 ? custom_step : get_step()));
  102. accept_event();
  103. } else if (p_event->is_action_pressed("ui_down", true)) {
  104. if (orientation != VERTICAL)
  105. return;
  106. set_value(get_value() - (custom_step >= 0 ? custom_step : get_step()));
  107. accept_event();
  108. } else if (p_event->is_action("ui_home") && p_event->is_pressed()) {
  109. set_value(get_min());
  110. accept_event();
  111. } else if (p_event->is_action("ui_end") && p_event->is_pressed()) {
  112. set_value(get_max());
  113. accept_event();
  114. }
  115. }
  116. }
  117. void Slider::_notification(int p_what) {
  118. switch (p_what) {
  119. case NOTIFICATION_THEME_CHANGED: {
  120. minimum_size_changed();
  121. update();
  122. } break;
  123. case NOTIFICATION_MOUSE_ENTER: {
  124. mouse_inside = true;
  125. update();
  126. } break;
  127. case NOTIFICATION_MOUSE_EXIT: {
  128. mouse_inside = false;
  129. update();
  130. } break;
  131. case NOTIFICATION_VISIBILITY_CHANGED: // fallthrough
  132. case NOTIFICATION_EXIT_TREE: {
  133. mouse_inside = false;
  134. grab.active = false;
  135. } break;
  136. case NOTIFICATION_DRAW: {
  137. RID ci = get_canvas_item();
  138. Size2i size = get_size();
  139. Ref<StyleBox> style = get_stylebox("slider");
  140. bool highlighted = mouse_inside || has_focus();
  141. Ref<StyleBox> grabber_area = get_stylebox(highlighted ? "grabber_area_highlight" : "grabber_area");
  142. Ref<Texture> grabber = get_icon(editable ? (highlighted ? "grabber_highlight" : "grabber") : "grabber_disabled");
  143. Ref<Texture> tick = get_icon("tick");
  144. double ratio = Math::is_nan(get_as_ratio()) ? 0 : get_as_ratio();
  145. if (orientation == VERTICAL) {
  146. int widget_width = style->get_minimum_size().width + style->get_center_size().width;
  147. float areasize = size.height - grabber->get_size().height;
  148. style->draw(ci, Rect2i(Point2i(size.width / 2 - widget_width / 2, 0), Size2i(widget_width, size.height)));
  149. grabber_area->draw(ci, Rect2i(Point2i((size.width - widget_width) / 2, size.height - areasize * ratio - grabber->get_size().height / 2), Size2i(widget_width, areasize * ratio + grabber->get_size().width / 2)));
  150. if (ticks > 1) {
  151. int grabber_offset = (grabber->get_size().height / 2 - tick->get_height() / 2);
  152. for (int i = 0; i < ticks; i++) {
  153. if (!ticks_on_borders && (i == 0 || i + 1 == ticks)) continue;
  154. int ofs = (i * areasize / (ticks - 1)) + grabber_offset;
  155. tick->draw(ci, Point2i((size.width - widget_width) / 2, ofs));
  156. }
  157. }
  158. grabber->draw(ci, Point2i(size.width / 2 - grabber->get_size().width / 2, size.height - ratio * areasize - grabber->get_size().height));
  159. } else {
  160. int widget_height = style->get_minimum_size().height + style->get_center_size().height;
  161. float areasize = size.width - grabber->get_size().width;
  162. style->draw(ci, Rect2i(Point2i(0, (size.height - widget_height) / 2), Size2i(size.width, widget_height)));
  163. grabber_area->draw(ci, Rect2i(Point2i(0, (size.height - widget_height) / 2), Size2i(areasize * ratio + grabber->get_size().width / 2, widget_height)));
  164. if (ticks > 1) {
  165. int grabber_offset = (grabber->get_size().width / 2 - tick->get_width() / 2);
  166. for (int i = 0; i < ticks; i++) {
  167. if ((!ticks_on_borders) && ((i == 0) || ((i + 1) == ticks))) continue;
  168. int ofs = (i * areasize / (ticks - 1)) + grabber_offset;
  169. tick->draw(ci, Point2i(ofs, (size.height - widget_height) / 2));
  170. }
  171. }
  172. grabber->draw(ci, Point2i(ratio * areasize, size.height / 2 - grabber->get_size().height / 2));
  173. }
  174. } break;
  175. }
  176. }
  177. void Slider::set_custom_step(float p_custom_step) {
  178. custom_step = p_custom_step;
  179. }
  180. float Slider::get_custom_step() const {
  181. return custom_step;
  182. }
  183. void Slider::set_ticks(int p_count) {
  184. ticks = p_count;
  185. update();
  186. }
  187. int Slider::get_ticks() const {
  188. return ticks;
  189. }
  190. bool Slider::get_ticks_on_borders() const {
  191. return ticks_on_borders;
  192. }
  193. void Slider::set_ticks_on_borders(bool _tob) {
  194. ticks_on_borders = _tob;
  195. update();
  196. }
  197. void Slider::set_editable(bool p_editable) {
  198. editable = p_editable;
  199. update();
  200. }
  201. bool Slider::is_editable() const {
  202. return editable;
  203. }
  204. void Slider::set_scrollable(bool p_scrollable) {
  205. scrollable = p_scrollable;
  206. }
  207. bool Slider::is_scrollable() const {
  208. return scrollable;
  209. }
  210. void Slider::_bind_methods() {
  211. ClassDB::bind_method(D_METHOD("_gui_input"), &Slider::_gui_input);
  212. ClassDB::bind_method(D_METHOD("set_ticks", "count"), &Slider::set_ticks);
  213. ClassDB::bind_method(D_METHOD("get_ticks"), &Slider::get_ticks);
  214. ClassDB::bind_method(D_METHOD("get_ticks_on_borders"), &Slider::get_ticks_on_borders);
  215. ClassDB::bind_method(D_METHOD("set_ticks_on_borders", "ticks_on_border"), &Slider::set_ticks_on_borders);
  216. ClassDB::bind_method(D_METHOD("set_editable", "editable"), &Slider::set_editable);
  217. ClassDB::bind_method(D_METHOD("is_editable"), &Slider::is_editable);
  218. ClassDB::bind_method(D_METHOD("set_scrollable", "scrollable"), &Slider::set_scrollable);
  219. ClassDB::bind_method(D_METHOD("is_scrollable"), &Slider::is_scrollable);
  220. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "editable"), "set_editable", "is_editable");
  221. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "scrollable"), "set_scrollable", "is_scrollable");
  222. ADD_PROPERTY(PropertyInfo(Variant::INT, "tick_count", PROPERTY_HINT_RANGE, "0,4096,1"), "set_ticks", "get_ticks");
  223. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "ticks_on_borders"), "set_ticks_on_borders", "get_ticks_on_borders");
  224. }
  225. Slider::Slider(Orientation p_orientation) {
  226. orientation = p_orientation;
  227. mouse_inside = false;
  228. grab.active = false;
  229. ticks = 0;
  230. ticks_on_borders = false;
  231. custom_step = -1;
  232. editable = true;
  233. scrollable = true;
  234. set_focus_mode(FOCUS_ALL);
  235. }